Sync docs
[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_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320
321 /* Standard headers for standard system calls etc. */
322 #include <stdio.h>
323 #include <stdlib.h>
324 #include <unistd.h>
325 #include <string.h>
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
330 #include <dlfcn.h>
331 #include <math.h>
332 #include <fnmatch.h>
333 #include <limits.h>
334 #include <ctype.h>
335 #include <time.h>
336 #include <dirent.h>
337 #include <pwd.h>
338 #include <errno.h>
339
340 #ifdef ELM_UNIX
341 # include <locale.h>
342 # ifdef ELM_LIBINTL_H
343 #  include <libintl.h>
344 # endif
345 # include <signal.h>
346 # include <grp.h>
347 # include <glob.h>
348 #endif
349
350 #ifdef ELM_ALLOCA_H
351 # include <alloca.h>
352 #endif
353
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
355 # include <malloc.h>
356 # ifndef alloca
357 #  define alloca _alloca
358 # endif
359 #endif
360
361
362 /* EFL headers */
363 #include <Eina.h>
364 #include <Eet.h>
365 #include <Evas.h>
366 #include <Evas_GL.h>
367 #include <Ecore.h>
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
372 #include <Edje.h>
373
374 #ifdef ELM_EDBUS
375 # include <E_DBus.h>
376 #endif
377
378 #ifdef ELM_EFREET
379 # include <Efreet.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
382 #endif
383
384 #ifdef ELM_ETHUMB
385 # include <Ethumb_Client.h>
386 #endif
387
388 #ifdef ELM_EMAP
389 # include <EMap.h>
390 #endif
391
392 #ifdef EAPI
393 # undef EAPI
394 #endif
395
396 #ifdef _WIN32
397 # ifdef ELEMENTARY_BUILD
398 #  ifdef DLL_EXPORT
399 #   define EAPI __declspec(dllexport)
400 #  else
401 #   define EAPI
402 #  endif /* ! DLL_EXPORT */
403 # else
404 #  define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
406 #else
407 # ifdef __GNUC__
408 #  if __GNUC__ >= 4
409 #   define EAPI __attribute__ ((visibility("default")))
410 #  else
411 #   define EAPI
412 #  endif
413 # else
414 #  define EAPI
415 # endif
416 #endif /* ! _WIN32 */
417
418 #ifdef _WIN32
419 # define EAPI_MAIN
420 #else
421 # define EAPI_MAIN EAPI
422 #endif
423
424 /* allow usage from c++ */
425 #ifdef __cplusplus
426 extern "C" {
427 #endif
428
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
431
432    typedef struct _Elm_Version
433      {
434         int major;
435         int minor;
436         int micro;
437         int revision;
438      } Elm_Version;
439
440    EAPI extern Elm_Version *elm_version;
441
442 /* handy macros */
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
445
446    /**
447     * @defgroup General General
448     *
449     * @brief General Elementary API. Functions that don't relate to
450     * Elementary objects specifically.
451     *
452     * Here are documented functions which init/shutdown the library,
453     * that apply to generic Elementary objects, that deal with
454     * configuration, et cetera.
455     *
456     * @ref general_functions_example_page "This" example contemplates
457     * some of these functions.
458     */
459
460    /**
461     * @addtogroup General
462     * @{
463     */
464
465   /**
466    * Defines couple of standard Evas_Object layers to be used
467    * with evas_object_layer_set().
468    *
469    * @note whenever extending with new values, try to keep some padding
470    *       to siblings so there is room for further extensions.
471    */
472   typedef enum _Elm_Object_Layer
473     {
474        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
480     } Elm_Object_Layer;
481
482 /**************************************************************************/
483    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
484
485    /**
486     * Emitted when any Elementary's policy value is changed.
487     */
488    EAPI extern int ELM_EVENT_POLICY_CHANGED;
489
490    /**
491     * @typedef Elm_Event_Policy_Changed
492     *
493     * Data on the event when an Elementary policy has changed
494     */
495     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
496
497    /**
498     * @struct _Elm_Event_Policy_Changed
499     *
500     * Data on the event when an Elementary policy has changed
501     */
502     struct _Elm_Event_Policy_Changed
503      {
504         unsigned int policy; /**< the policy identifier */
505         int          new_value; /**< value the policy had before the change */
506         int          old_value; /**< new value the policy got */
507     };
508
509    /**
510     * Policy identifiers.
511     */
512     typedef enum _Elm_Policy
513     {
514         ELM_POLICY_QUIT, /**< under which circumstances the application
515                           * should quit automatically. @see
516                           * Elm_Policy_Quit.
517                           */
518         ELM_POLICY_LAST
519     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
520  */
521
522    typedef enum _Elm_Policy_Quit
523      {
524         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
525                                    * automatically */
526         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
527                                             * application's last
528                                             * window is closed */
529      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
530
531    typedef enum _Elm_Focus_Direction
532      {
533         ELM_FOCUS_PREVIOUS,
534         ELM_FOCUS_NEXT
535      } Elm_Focus_Direction;
536
537    typedef enum _Elm_Text_Format
538      {
539         ELM_TEXT_FORMAT_PLAIN_UTF8,
540         ELM_TEXT_FORMAT_MARKUP_UTF8
541      } Elm_Text_Format;
542
543    /**
544     * Line wrapping types.
545     */
546    typedef enum _Elm_Wrap_Type
547      {
548         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
552         ELM_WRAP_LAST
553      } Elm_Wrap_Type;
554
555    typedef enum
556      {
557         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
558         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
559         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
560         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
561         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
562         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
563         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
564         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
565         ELM_INPUT_PANEL_LAYOUT_INVALID
566      } Elm_Input_Panel_Layout;
567
568    typedef enum
569      {
570         ELM_AUTOCAPITAL_TYPE_NONE,
571         ELM_AUTOCAPITAL_TYPE_WORD,
572         ELM_AUTOCAPITAL_TYPE_SENTENCE,
573         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
574      } Elm_Autocapital_Type;
575
576    /**
577     * @typedef Elm_Object_Item
578     * An Elementary Object item handle.
579     * @ingroup General
580     */
581    typedef struct _Elm_Object_Item Elm_Object_Item;
582
583
584    /**
585     * Called back when a widget's 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     */
589    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
590
591    /**
592     * Called back when a widget's item tooltip is activated and needs content.
593     * @param data user-data given to elm_object_tooltip_content_cb_set()
594     * @param obj owner widget.
595     * @param item context dependent item. As an example, if tooltip was
596     *        set on Elm_List_Item, then it is of this type.
597     */
598    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
599
600    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
601
602 #ifndef ELM_LIB_QUICKLAUNCH
603 #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 */
604 #else
605 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
606 #endif
607
608 /**************************************************************************/
609    /* General calls */
610
611    /**
612     * Initialize Elementary
613     *
614     * @param[in] argc System's argument count value
615     * @param[in] argv System's pointer to array of argument strings
616     * @return The init counter value.
617     *
618     * This function initializes Elementary and increments a counter of
619     * the number of calls to it. It returns the new counter's value.
620     *
621     * @warning This call is exported only for use by the @c ELM_MAIN()
622     * macro. There is no need to use this if you use this macro (which
623     * is highly advisable). An elm_main() should contain the entry
624     * point code for your application, having the same prototype as
625     * elm_init(), and @b not being static (putting the @c EAPI symbol
626     * in front of its type declaration is advisable). The @c
627     * ELM_MAIN() call should be placed just after it.
628     *
629     * Example:
630     * @dontinclude bg_example_01.c
631     * @skip static void
632     * @until ELM_MAIN
633     *
634     * See the full @ref bg_example_01_c "example".
635     *
636     * @see elm_shutdown().
637     * @ingroup General
638     */
639    EAPI int          elm_init(int argc, char **argv);
640
641    /**
642     * Shut down Elementary
643     *
644     * @return The init counter value.
645     *
646     * This should be called at the end of your application, just
647     * before it ceases to do any more processing. This will clean up
648     * any permanent resources your application may have allocated via
649     * Elementary that would otherwise persist.
650     *
651     * @see elm_init() for an example
652     *
653     * @ingroup General
654     */
655    EAPI int          elm_shutdown(void);
656
657    /**
658     * Run Elementary's main loop
659     *
660     * This call should be issued just after all initialization is
661     * completed. This function will not return until elm_exit() is
662     * called. It will keep looping, running the main
663     * (event/processing) loop for Elementary.
664     *
665     * @see elm_init() for an example
666     *
667     * @ingroup General
668     */
669    EAPI void         elm_run(void);
670
671    /**
672     * Exit Elementary's main loop
673     *
674     * If this call is issued, it will flag the main loop to cease
675     * processing and return back to its parent function (usually your
676     * elm_main() function).
677     *
678     * @see elm_init() for an example. There, just after a request to
679     * close the window comes, the main loop will be left.
680     *
681     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
682     * applications, you'll be able to get this function called automatically for you.
683     *
684     * @ingroup General
685     */
686    EAPI void         elm_exit(void);
687
688    /**
689     * Provide information in order to make Elementary determine the @b
690     * run time location of the software in question, so other data files
691     * such as images, sound files, executable utilities, libraries,
692     * modules and locale files can be found.
693     *
694     * @param mainfunc This is your application's main function name,
695     *        whose binary's location is to be found. Providing @c NULL
696     *        will make Elementary not to use it
697     * @param dom This will be used as the application's "domain", in the
698     *        form of a prefix to any environment variables that may
699     *        override prefix detection and the directory name, inside the
700     *        standard share or data directories, where the software's
701     *        data files will be looked for.
702     * @param checkfile This is an (optional) magic file's path to check
703     *        for existence (and it must be located in the data directory,
704     *        under the share directory provided above). Its presence will
705     *        help determine the prefix found was correct. Pass @c NULL if
706     *        the check is not to be done.
707     *
708     * This function allows one to re-locate the application somewhere
709     * else after compilation, if the developer wishes for easier
710     * distribution of pre-compiled binaries.
711     *
712     * The prefix system is designed to locate where the given software is
713     * installed (under a common path prefix) at run time and then report
714     * specific locations of this prefix and common directories inside
715     * this prefix like the binary, library, data and locale directories,
716     * through the @c elm_app_*_get() family of functions.
717     *
718     * Call elm_app_info_set() early on before you change working
719     * directory or anything about @c argv[0], so it gets accurate
720     * information.
721     *
722     * It will then try and trace back which file @p mainfunc comes from,
723     * if provided, to determine the application's prefix directory.
724     *
725     * The @p dom parameter provides a string prefix to prepend before
726     * environment variables, allowing a fallback to @b specific
727     * environment variables to locate the software. You would most
728     * probably provide a lowercase string there, because it will also
729     * serve as directory domain, explained next. For environment
730     * variables purposes, this string is made uppercase. For example if
731     * @c "myapp" is provided as the prefix, then the program would expect
732     * @c "MYAPP_PREFIX" as a master environment variable to specify the
733     * exact install prefix for the software, or more specific environment
734     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
735     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
736     * the user or scripts before launching. If not provided (@c NULL),
737     * environment variables will not be used to override compiled-in
738     * defaults or auto detections.
739     *
740     * The @p dom string also provides a subdirectory inside the system
741     * shared data directory for data files. For example, if the system
742     * directory is @c /usr/local/share, then this directory name is
743     * appended, creating @c /usr/local/share/myapp, if it @p was @c
744     * "myapp". It is expected that the application installs data files in
745     * this directory.
746     *
747     * The @p checkfile is a file name or path of something inside the
748     * share or data directory to be used to test that the prefix
749     * detection worked. For example, your app will install a wallpaper
750     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
751     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
752     * checkfile string.
753     *
754     * @see elm_app_compile_bin_dir_set()
755     * @see elm_app_compile_lib_dir_set()
756     * @see elm_app_compile_data_dir_set()
757     * @see elm_app_compile_locale_set()
758     * @see elm_app_prefix_dir_get()
759     * @see elm_app_bin_dir_get()
760     * @see elm_app_lib_dir_get()
761     * @see elm_app_data_dir_get()
762     * @see elm_app_locale_dir_get()
763     */
764    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
765
766    /**
767     * Provide information on the @b fallback application's binaries
768     * directory, in scenarios where they get overriden by
769     * elm_app_info_set().
770     *
771     * @param dir The path to the default binaries directory (compile time
772     * one)
773     *
774     * @note Elementary will as well use this path to determine actual
775     * names of binaries' directory paths, maybe changing it to be @c
776     * something/local/bin instead of @c something/bin, only, for
777     * example.
778     *
779     * @warning You should call this function @b before
780     * elm_app_info_set().
781     */
782    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
783
784    /**
785     * Provide information on the @b fallback application's libraries
786     * directory, on scenarios where they get overriden by
787     * elm_app_info_set().
788     *
789     * @param dir The path to the default libraries directory (compile
790     * time one)
791     *
792     * @note Elementary will as well use this path to determine actual
793     * names of libraries' directory paths, maybe changing it to be @c
794     * something/lib32 or @c something/lib64 instead of @c something/lib,
795     * only, for example.
796     *
797     * @warning You should call this function @b before
798     * elm_app_info_set().
799     */
800    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
801
802    /**
803     * Provide information on the @b fallback application's data
804     * directory, on scenarios where they get overriden by
805     * elm_app_info_set().
806     *
807     * @param dir The path to the default data directory (compile time
808     * one)
809     *
810     * @note Elementary will as well use this path to determine actual
811     * names of data directory paths, maybe changing it to be @c
812     * something/local/share instead of @c something/share, only, for
813     * example.
814     *
815     * @warning You should call this function @b before
816     * elm_app_info_set().
817     */
818    EAPI void         elm_app_compile_data_dir_set(const char *dir);
819
820    /**
821     * Provide information on the @b fallback application's locale
822     * directory, on scenarios where they get overriden by
823     * elm_app_info_set().
824     *
825     * @param dir The path to the default locale directory (compile time
826     * one)
827     *
828     * @warning You should call this function @b before
829     * elm_app_info_set().
830     */
831    EAPI void         elm_app_compile_locale_set(const char *dir);
832
833    /**
834     * Retrieve the application's run time prefix directory, as set by
835     * elm_app_info_set() and the way (environment) the application was
836     * run from.
837     *
838     * @return The directory prefix the application is actually using.
839     */
840    EAPI const char  *elm_app_prefix_dir_get(void);
841
842    /**
843     * Retrieve the application's run time binaries prefix directory, as
844     * set by elm_app_info_set() and the way (environment) the application
845     * was run from.
846     *
847     * @return The binaries directory prefix the application is actually
848     * using.
849     */
850    EAPI const char  *elm_app_bin_dir_get(void);
851
852    /**
853     * Retrieve the application's run time libraries prefix directory, as
854     * set by elm_app_info_set() and the way (environment) the application
855     * was run from.
856     *
857     * @return The libraries directory prefix the application is actually
858     * using.
859     */
860    EAPI const char  *elm_app_lib_dir_get(void);
861
862    /**
863     * Retrieve the application's run time data prefix directory, as
864     * set by elm_app_info_set() and the way (environment) the application
865     * was run from.
866     *
867     * @return The data directory prefix the application is actually
868     * using.
869     */
870    EAPI const char  *elm_app_data_dir_get(void);
871
872    /**
873     * Retrieve the application's run time locale prefix directory, as
874     * set by elm_app_info_set() and the way (environment) the application
875     * was run from.
876     *
877     * @return The locale directory prefix the application is actually
878     * using.
879     */
880    EAPI const char  *elm_app_locale_dir_get(void);
881
882    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
883    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
884    EAPI int          elm_quicklaunch_init(int argc, char **argv);
885    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
886    EAPI int          elm_quicklaunch_sub_shutdown(void);
887    EAPI int          elm_quicklaunch_shutdown(void);
888    EAPI void         elm_quicklaunch_seed(void);
889    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
890    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
891    EAPI void         elm_quicklaunch_cleanup(void);
892    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
893    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
894
895    EAPI Eina_Bool    elm_need_efreet(void);
896    EAPI Eina_Bool    elm_need_e_dbus(void);
897
898    /**
899     * This must be called before any other function that deals with
900     * elm_thumb objects or ethumb_client instances.
901     *
902     * @ingroup Thumb
903     */
904    EAPI Eina_Bool    elm_need_ethumb(void);
905
906    /**
907     * This must be called before any other function that deals with
908     * elm_web objects or ewk_view instances.
909     *
910     * @ingroup Web
911     */
912    EAPI Eina_Bool    elm_need_web(void);
913
914    /**
915     * Set a new policy's value (for a given policy group/identifier).
916     *
917     * @param policy policy identifier, as in @ref Elm_Policy.
918     * @param value policy value, which depends on the identifier
919     *
920     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
921     *
922     * Elementary policies define applications' behavior,
923     * somehow. These behaviors are divided in policy groups (see
924     * #Elm_Policy enumeration). This call will emit the Ecore event
925     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
926     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
927     * then.
928     *
929     * @note Currently, we have only one policy identifier/group
930     * (#ELM_POLICY_QUIT), which has two possible values.
931     *
932     * @ingroup General
933     */
934    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
935
936    /**
937     * Gets the policy value for given policy identifier.
938     *
939     * @param policy policy identifier, as in #Elm_Policy.
940     * @return The currently set policy value, for that
941     * identifier. Will be @c 0 if @p policy passed is invalid.
942     *
943     * @ingroup General
944     */
945    EAPI int          elm_policy_get(unsigned int policy);
946
947    /**
948     * Change the language of the current application
949     *
950     * The @p lang passed must be the full name of the locale to use, for
951     * example "en_US.utf8" or "es_ES@euro".
952     *
953     * Changing language with this function will make Elementary run through
954     * all its widgets, translating strings set with
955     * elm_object_domain_translatable_text_part_set(). This way, an entire
956     * UI can have its language changed without having to restart the program.
957     *
958     * For more complex cases, like having formatted strings that need
959     * translation, widgets will also emit a "language,changed" signal that
960     * the user can listen to to manually translate the text.
961     *
962     * @param lang Language to set, must be the full name of the locale
963     *
964     * @ingroup General
965     */
966    EAPI void         elm_language_set(const char *lang);
967
968    /**
969     * Set a label of an object
970     *
971     * @param obj The Elementary object
972     * @param part The text part name to set (NULL for the default label)
973     * @param label The new text of the label
974     *
975     * @note Elementary objects may have many labels (e.g. Action Slider)
976     *
977     * @ingroup General
978     */
979    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
980
981 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
982
983    /**
984     * Get a label of an object
985     *
986     * @param obj The Elementary object
987     * @param part The text part name to get (NULL for the default label)
988     * @return text of the label or NULL for any error
989     *
990     * @note Elementary objects may have many labels (e.g. Action Slider)
991     *
992     * @ingroup General
993     */
994    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
995
996 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
997
998    /**
999     * Set the text for an objects' part, marking it as translatable.
1000     *
1001     * The string to set as @p text must be the original one. Do not pass the
1002     * return of @c gettext() here. Elementary will translate the string
1003     * internally and set it on the object using elm_object_text_part_set(),
1004     * also storing the original string so that it can be automatically
1005     * translated when the language is changed with elm_language_set().
1006     *
1007     * The @p domain will be stored along to find the translation in the
1008     * correct catalog. It can be NULL, in which case it will use whatever
1009     * domain was set by the application with @c textdomain(). This is useful
1010     * in case you are building a library on top of Elementary that will have
1011     * its own translatable strings, that should not be mixed with those of
1012     * programs using the library.
1013     *
1014     * @param obj The object containing the text part
1015     * @param part The name of the part to set
1016     * @param domain The translation domain to use
1017     * @param text The original, non-translated text to set
1018     *
1019     * @ingroup General
1020     */
1021    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1022
1023 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1024
1025 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1026
1027    /**
1028     * Gets the original string set as translatable for an object
1029     *
1030     * When setting translated strings, the function elm_object_text_part_get()
1031     * will return the translation returned by @c gettext(). To get the
1032     * original string use this function.
1033     *
1034     * @param obj The object
1035     * @param part The name of the part that was set
1036     *
1037     * @return The original, untranslated string
1038     *
1039     * @ingroup General
1040     */
1041    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1042
1043 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1044
1045    /**
1046     * Set a content of an object
1047     *
1048     * @param obj The Elementary object
1049     * @param part The content part name to set (NULL for the default content)
1050     * @param content The new content of the object
1051     *
1052     * @note Elementary objects may have many contents
1053     *
1054     * @ingroup General
1055     */
1056    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1057
1058 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1059
1060    /**
1061     * Get a content of an object
1062     *
1063     * @param obj The Elementary object
1064     * @param item The content part name to get (NULL for the default content)
1065     * @return content of the object or NULL for any error
1066     *
1067     * @note Elementary objects may have many contents
1068     *
1069     * @ingroup General
1070     */
1071    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1072
1073 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1074
1075    /**
1076     * Unset a content of an object
1077     *
1078     * @param obj The Elementary object
1079     * @param item The content part name to unset (NULL for the default content)
1080     *
1081     * @note Elementary objects may have many contents
1082     *
1083     * @ingroup General
1084     */
1085    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1086
1087 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1088
1089    /**
1090     * Get the widget object's handle which contains a given item
1091     *
1092     * @param item The Elementary object item
1093     * @return The widget object
1094     *
1095     * @note This returns the widget object itself that an item belongs to.
1096     *
1097     * @ingroup General
1098     */
1099    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1100
1101    /**
1102     * Set a content of an object item
1103     *
1104     * @param it The Elementary object item
1105     * @param part The content part name to set (NULL for the default content)
1106     * @param content The new content of the object item
1107     *
1108     * @note Elementary object items may have many contents
1109     *
1110     * @ingroup General
1111     */
1112    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1113
1114 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1115
1116    /**
1117     * Get a content of an object item
1118     *
1119     * @param it The Elementary object item
1120     * @param part The content part name to unset (NULL for the default content)
1121     * @return content of the object item or NULL for any error
1122     *
1123     * @note Elementary object items may have many contents
1124     *
1125     * @ingroup General
1126     */
1127    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1128
1129 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1130
1131    /**
1132     * Unset a content of an object item
1133     *
1134     * @param it The Elementary object item
1135     * @param part The content part name to unset (NULL for the default content)
1136     *
1137     * @note Elementary object items may have many contents
1138     *
1139     * @ingroup General
1140     */
1141    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1142
1143 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1144
1145    /**
1146     * Set a label of an object item
1147     *
1148     * @param it The Elementary object item
1149     * @param part The text part name to set (NULL for the default label)
1150     * @param label The new text of the label
1151     *
1152     * @note Elementary object items may have many labels
1153     *
1154     * @ingroup General
1155     */
1156    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1157
1158 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1159
1160    /**
1161     * Get a label of an object item
1162     *
1163     * @param it The Elementary object item
1164     * @param part The text part name to get (NULL for the default label)
1165     * @return text of the label or NULL for any error
1166     *
1167     * @note Elementary object items may have many labels
1168     *
1169     * @ingroup General
1170     */
1171    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1172
1173 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1174
1175    /**
1176     * Set the text to read out when in accessibility mode
1177     *
1178     * @param obj The object which is to be described
1179     * @param txt The text that describes the widget to people with poor or no vision
1180     *
1181     * @ingroup General
1182     */
1183    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1184
1185    /**
1186     * Set the text to read out when in accessibility mode
1187     *
1188     * @param it The object item which is to be described
1189     * @param txt The text that describes the widget to people with poor or no vision
1190     *
1191     * @ingroup General
1192     */
1193    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1194
1195    /**
1196     * Get the data associated with an object item
1197     * @param it The object item
1198     * @return The data associated with @p it
1199     *
1200     * @ingroup General
1201     */
1202    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1203
1204    /**
1205     * Set the data associated with an object item
1206     * @param it The object item
1207     * @param data The data to be associated with @p it
1208     *
1209     * @ingroup General
1210     */
1211    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1212
1213    /**
1214     * Send a signal to the edje object of the widget item.
1215     *
1216     * This function sends a signal to the edje object of the obj item. An
1217     * edje program can respond to a signal by specifying matching
1218     * 'signal' and 'source' fields.
1219     *
1220     * @param it The Elementary object item
1221     * @param emission The signal's name.
1222     * @param source The signal's source.
1223     * @ingroup General
1224     */
1225    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1226
1227    /**
1228     * @}
1229     */
1230
1231    /**
1232     * @defgroup Caches Caches
1233     *
1234     * These are functions which let one fine-tune some cache values for
1235     * Elementary applications, thus allowing for performance adjustments.
1236     *
1237     * @{
1238     */
1239
1240    /**
1241     * @brief Flush all caches.
1242     *
1243     * Frees all data that was in cache and is not currently being used to reduce
1244     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1245     * to calling all of the following functions:
1246     * @li edje_file_cache_flush()
1247     * @li edje_collection_cache_flush()
1248     * @li eet_clearcache()
1249     * @li evas_image_cache_flush()
1250     * @li evas_font_cache_flush()
1251     * @li evas_render_dump()
1252     * @note Evas caches are flushed for every canvas associated with a window.
1253     *
1254     * @ingroup Caches
1255     */
1256    EAPI void         elm_all_flush(void);
1257
1258    /**
1259     * Get the configured cache flush interval time
1260     *
1261     * This gets the globally configured cache flush interval time, in
1262     * ticks
1263     *
1264     * @return The cache flush interval time
1265     * @ingroup Caches
1266     *
1267     * @see elm_all_flush()
1268     */
1269    EAPI int          elm_cache_flush_interval_get(void);
1270
1271    /**
1272     * Set the configured cache flush interval time
1273     *
1274     * This sets the globally configured cache flush interval time, in ticks
1275     *
1276     * @param size The cache flush interval time
1277     * @ingroup Caches
1278     *
1279     * @see elm_all_flush()
1280     */
1281    EAPI void         elm_cache_flush_interval_set(int size);
1282
1283    /**
1284     * Set the configured cache flush interval time for all applications on the
1285     * display
1286     *
1287     * This sets the globally configured cache flush interval time -- in ticks
1288     * -- for all applications on the display.
1289     *
1290     * @param size The cache flush interval time
1291     * @ingroup Caches
1292     */
1293    EAPI void         elm_cache_flush_interval_all_set(int size);
1294
1295    /**
1296     * Get the configured cache flush enabled state
1297     *
1298     * This gets the globally configured cache flush state - if it is enabled
1299     * or not. When cache flushing is enabled, elementary will regularly
1300     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1301     * memory and allow usage to re-seed caches and data in memory where it
1302     * can do so. An idle application will thus minimise its memory usage as
1303     * data will be freed from memory and not be re-loaded as it is idle and
1304     * not rendering or doing anything graphically right now.
1305     *
1306     * @return The cache flush state
1307     * @ingroup Caches
1308     *
1309     * @see elm_all_flush()
1310     */
1311    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1312
1313    /**
1314     * Set the configured cache flush enabled state
1315     *
1316     * This sets the globally configured cache flush enabled state.
1317     *
1318     * @param size The cache flush enabled state
1319     * @ingroup Caches
1320     *
1321     * @see elm_all_flush()
1322     */
1323    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1324
1325    /**
1326     * Set the configured cache flush enabled state for all applications on the
1327     * display
1328     *
1329     * This sets the globally configured cache flush enabled state for all
1330     * applications on the display.
1331     *
1332     * @param size The cache flush enabled state
1333     * @ingroup Caches
1334     */
1335    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1336
1337    /**
1338     * Get the configured font cache size
1339     *
1340     * This gets the globally configured font cache size, in bytes.
1341     *
1342     * @return The font cache size
1343     * @ingroup Caches
1344     */
1345    EAPI int          elm_font_cache_get(void);
1346
1347    /**
1348     * Set the configured font cache size
1349     *
1350     * This sets the globally configured font cache size, in bytes
1351     *
1352     * @param size The font cache size
1353     * @ingroup Caches
1354     */
1355    EAPI void         elm_font_cache_set(int size);
1356
1357    /**
1358     * Set the configured font cache size for all applications on the
1359     * display
1360     *
1361     * This sets the globally configured font cache size -- in bytes
1362     * -- for all applications on the display.
1363     *
1364     * @param size The font cache size
1365     * @ingroup Caches
1366     */
1367    EAPI void         elm_font_cache_all_set(int size);
1368
1369    /**
1370     * Get the configured image cache size
1371     *
1372     * This gets the globally configured image cache size, in bytes
1373     *
1374     * @return The image cache size
1375     * @ingroup Caches
1376     */
1377    EAPI int          elm_image_cache_get(void);
1378
1379    /**
1380     * Set the configured image cache size
1381     *
1382     * This sets the globally configured image cache size, in bytes
1383     *
1384     * @param size The image cache size
1385     * @ingroup Caches
1386     */
1387    EAPI void         elm_image_cache_set(int size);
1388
1389    /**
1390     * Set the configured image cache size for all applications on the
1391     * display
1392     *
1393     * This sets the globally configured image cache size -- in bytes
1394     * -- for all applications on the display.
1395     *
1396     * @param size The image cache size
1397     * @ingroup Caches
1398     */
1399    EAPI void         elm_image_cache_all_set(int size);
1400
1401    /**
1402     * Get the configured edje file cache size.
1403     *
1404     * This gets the globally configured edje file cache size, in number
1405     * of files.
1406     *
1407     * @return The edje file cache size
1408     * @ingroup Caches
1409     */
1410    EAPI int          elm_edje_file_cache_get(void);
1411
1412    /**
1413     * Set the configured edje file cache size
1414     *
1415     * This sets the globally configured edje file cache size, in number
1416     * of files.
1417     *
1418     * @param size The edje file cache size
1419     * @ingroup Caches
1420     */
1421    EAPI void         elm_edje_file_cache_set(int size);
1422
1423    /**
1424     * Set the configured edje file cache size for all applications on the
1425     * display
1426     *
1427     * This sets the globally configured edje file cache size -- in number
1428     * of files -- for all applications on the display.
1429     *
1430     * @param size The edje file cache size
1431     * @ingroup Caches
1432     */
1433    EAPI void         elm_edje_file_cache_all_set(int size);
1434
1435    /**
1436     * Get the configured edje collections (groups) cache size.
1437     *
1438     * This gets the globally configured edje collections cache size, in
1439     * number of collections.
1440     *
1441     * @return The edje collections cache size
1442     * @ingroup Caches
1443     */
1444    EAPI int          elm_edje_collection_cache_get(void);
1445
1446    /**
1447     * Set the configured edje collections (groups) cache size
1448     *
1449     * This sets the globally configured edje collections cache size, in
1450     * number of collections.
1451     *
1452     * @param size The edje collections cache size
1453     * @ingroup Caches
1454     */
1455    EAPI void         elm_edje_collection_cache_set(int size);
1456
1457    /**
1458     * Set the configured edje collections (groups) cache size for all
1459     * applications on the display
1460     *
1461     * This sets the globally configured edje collections cache size -- in
1462     * number of collections -- for all applications on the display.
1463     *
1464     * @param size The edje collections cache size
1465     * @ingroup Caches
1466     */
1467    EAPI void         elm_edje_collection_cache_all_set(int size);
1468
1469    /**
1470     * @}
1471     */
1472
1473    /**
1474     * @defgroup Scaling Widget Scaling
1475     *
1476     * Different widgets can be scaled independently. These functions
1477     * allow you to manipulate this scaling on a per-widget basis. The
1478     * object and all its children get their scaling factors multiplied
1479     * by the scale factor set. This is multiplicative, in that if a
1480     * child also has a scale size set it is in turn multiplied by its
1481     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1482     * double size, @c 0.5 is half, etc.
1483     *
1484     * @ref general_functions_example_page "This" example contemplates
1485     * some of these functions.
1486     */
1487
1488    /**
1489     * Get the global scaling factor
1490     *
1491     * This gets the globally configured scaling factor that is applied to all
1492     * objects.
1493     *
1494     * @return The scaling factor
1495     * @ingroup Scaling
1496     */
1497    EAPI double       elm_scale_get(void);
1498
1499    /**
1500     * Set the global scaling factor
1501     *
1502     * This sets the globally configured scaling factor that is applied to all
1503     * objects.
1504     *
1505     * @param scale The scaling factor to set
1506     * @ingroup Scaling
1507     */
1508    EAPI void         elm_scale_set(double scale);
1509
1510    /**
1511     * Set the global scaling factor for all applications on the display
1512     *
1513     * This sets the globally configured scaling factor that is applied to all
1514     * objects for all applications.
1515     * @param scale The scaling factor to set
1516     * @ingroup Scaling
1517     */
1518    EAPI void         elm_scale_all_set(double scale);
1519
1520    /**
1521     * Set the scaling factor for a given Elementary object
1522     *
1523     * @param obj The Elementary to operate on
1524     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1525     * no scaling)
1526     *
1527     * @ingroup Scaling
1528     */
1529    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1530
1531    /**
1532     * Get the scaling factor for a given Elementary object
1533     *
1534     * @param obj The object
1535     * @return The scaling factor set by elm_object_scale_set()
1536     *
1537     * @ingroup Scaling
1538     */
1539    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1540
1541    /**
1542     * @defgroup Password_last_show Password last input show
1543     *
1544     * Last show feature of password mode enables user to view
1545     * the last input entered for few seconds before masking it.
1546     * These functions allow to set this feature in password mode
1547     * of entry widget and also allow to manipulate the duration
1548     * for which the input has to be visible.
1549     *
1550     * @{
1551     */
1552
1553    /**
1554     * Get show last setting of password mode.
1555     *
1556     * This gets the show last input setting of password mode which might be
1557     * enabled or disabled.
1558     *
1559     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1560     *            if it's disabled.
1561     * @ingroup Password_last_show
1562     */
1563    EAPI Eina_Bool elm_password_show_last_get(void);
1564
1565    /**
1566     * Set show last setting in password mode.
1567     *
1568     * This enables or disables show last setting of password mode.
1569     *
1570     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1571     * @see elm_password_show_last_timeout_set()
1572     * @ingroup Password_last_show
1573     */
1574    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1575
1576    /**
1577     * Get's the timeout value in last show password mode.
1578     *
1579     * This gets the time out value for which the last input entered in password
1580     * mode will be visible.
1581     *
1582     * @return The timeout value of last show password mode.
1583     * @ingroup Password_last_show
1584     */
1585    EAPI double elm_password_show_last_timeout_get(void);
1586
1587    /**
1588     * Set's the timeout value in last show password mode.
1589     *
1590     * This sets the time out value for which the last input entered in password
1591     * mode will be visible.
1592     *
1593     * @param password_show_last_timeout The timeout value.
1594     * @see elm_password_show_last_set()
1595     * @ingroup Password_last_show
1596     */
1597    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1598
1599    /**
1600     * @}
1601     */
1602
1603    /**
1604     * @defgroup UI-Mirroring Selective Widget mirroring
1605     *
1606     * These functions allow you to set ui-mirroring on specific
1607     * widgets or the whole interface. Widgets can be in one of two
1608     * modes, automatic and manual.  Automatic means they'll be changed
1609     * according to the system mirroring mode and manual means only
1610     * explicit changes will matter. You are not supposed to change
1611     * mirroring state of a widget set to automatic, will mostly work,
1612     * but the behavior is not really defined.
1613     *
1614     * @{
1615     */
1616
1617    EAPI Eina_Bool    elm_mirrored_get(void);
1618    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1619
1620    /**
1621     * Get the system mirrored mode. This determines the default mirrored mode
1622     * of widgets.
1623     *
1624     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1625     */
1626    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1627
1628    /**
1629     * Set the system mirrored mode. This determines the default mirrored mode
1630     * of widgets.
1631     *
1632     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1633     */
1634    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1635
1636    /**
1637     * Returns the widget's mirrored mode setting.
1638     *
1639     * @param obj The widget.
1640     * @return mirrored mode setting of the object.
1641     *
1642     **/
1643    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1644
1645    /**
1646     * Sets the widget's mirrored mode setting.
1647     * When widget in automatic mode, it follows the system mirrored mode set by
1648     * elm_mirrored_set().
1649     * @param obj The widget.
1650     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1651     */
1652    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1653
1654    /**
1655     * @}
1656     */
1657
1658    /**
1659     * Set the style to use by a widget
1660     *
1661     * Sets the style name that will define the appearance of a widget. Styles
1662     * vary from widget to widget and may also be defined by other themes
1663     * by means of extensions and overlays.
1664     *
1665     * @param obj The Elementary widget to style
1666     * @param style The style name to use
1667     *
1668     * @see elm_theme_extension_add()
1669     * @see elm_theme_extension_del()
1670     * @see elm_theme_overlay_add()
1671     * @see elm_theme_overlay_del()
1672     *
1673     * @ingroup Styles
1674     */
1675    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1676    /**
1677     * Get the style used by the widget
1678     *
1679     * This gets the style being used for that widget. Note that the string
1680     * pointer is only valid as longas the object is valid and the style doesn't
1681     * change.
1682     *
1683     * @param obj The Elementary widget to query for its style
1684     * @return The style name used
1685     *
1686     * @see elm_object_style_set()
1687     *
1688     * @ingroup Styles
1689     */
1690    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1691
1692    /**
1693     * @defgroup Styles Styles
1694     *
1695     * Widgets can have different styles of look. These generic API's
1696     * set styles of widgets, if they support them (and if the theme(s)
1697     * do).
1698     *
1699     * @ref general_functions_example_page "This" example contemplates
1700     * some of these functions.
1701     */
1702
1703    /**
1704     * Set the disabled state of an Elementary object.
1705     *
1706     * @param obj The Elementary object to operate on
1707     * @param disabled The state to put in in: @c EINA_TRUE for
1708     *        disabled, @c EINA_FALSE for enabled
1709     *
1710     * Elementary objects can be @b disabled, in which state they won't
1711     * receive input and, in general, will be themed differently from
1712     * their normal state, usually greyed out. Useful for contexts
1713     * where you don't want your users to interact with some of the
1714     * parts of you interface.
1715     *
1716     * This sets the state for the widget, either disabling it or
1717     * enabling it back.
1718     *
1719     * @ingroup Styles
1720     */
1721    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1722
1723    /**
1724     * Get the disabled state of an Elementary object.
1725     *
1726     * @param obj The Elementary object to operate on
1727     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1728     *            if it's enabled (or on errors)
1729     *
1730     * This gets the state of the widget, which might be enabled or disabled.
1731     *
1732     * @ingroup Styles
1733     */
1734    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1735
1736    /**
1737     * @defgroup WidgetNavigation Widget Tree Navigation.
1738     *
1739     * How to check if an Evas Object is an Elementary widget? How to
1740     * get the first elementary widget that is parent of the given
1741     * object?  These are all covered in widget tree navigation.
1742     *
1743     * @ref general_functions_example_page "This" example contemplates
1744     * some of these functions.
1745     */
1746
1747    /**
1748     * Check if the given Evas Object is an Elementary widget.
1749     *
1750     * @param obj the object to query.
1751     * @return @c EINA_TRUE if it is an elementary widget variant,
1752     *         @c EINA_FALSE otherwise
1753     * @ingroup WidgetNavigation
1754     */
1755    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1756
1757    /**
1758     * Get the first parent of the given object that is an Elementary
1759     * widget.
1760     *
1761     * @param obj the Elementary object to query parent from.
1762     * @return the parent object that is an Elementary widget, or @c
1763     *         NULL, if it was not found.
1764     *
1765     * Use this to query for an object's parent widget.
1766     *
1767     * @note Most of Elementary users wouldn't be mixing non-Elementary
1768     * smart objects in the objects tree of an application, as this is
1769     * an advanced usage of Elementary with Evas. So, except for the
1770     * application's window, which is the root of that tree, all other
1771     * objects would have valid Elementary widget parents.
1772     *
1773     * @ingroup WidgetNavigation
1774     */
1775    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1776
1777    /**
1778     * Get the top level parent of an Elementary widget.
1779     *
1780     * @param obj The object to query.
1781     * @return The top level Elementary widget, or @c NULL if parent cannot be
1782     * found.
1783     * @ingroup WidgetNavigation
1784     */
1785    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1786
1787    /**
1788     * Get the string that represents this Elementary widget.
1789     *
1790     * @note Elementary is weird and exposes itself as a single
1791     *       Evas_Object_Smart_Class of type "elm_widget", so
1792     *       evas_object_type_get() always return that, making debug and
1793     *       language bindings hard. This function tries to mitigate this
1794     *       problem, but the solution is to change Elementary to use
1795     *       proper inheritance.
1796     *
1797     * @param obj the object to query.
1798     * @return Elementary widget name, or @c NULL if not a valid widget.
1799     * @ingroup WidgetNavigation
1800     */
1801    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1802
1803    /**
1804     * @defgroup Config Elementary Config
1805     *
1806     * Elementary configuration is formed by a set options bounded to a
1807     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1808     * "finger size", etc. These are functions with which one syncronizes
1809     * changes made to those values to the configuration storing files, de
1810     * facto. You most probably don't want to use the functions in this
1811     * group unlees you're writing an elementary configuration manager.
1812     *
1813     * @{
1814     */
1815
1816    /**
1817     * Save back Elementary's configuration, so that it will persist on
1818     * future sessions.
1819     *
1820     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1821     * @ingroup Config
1822     *
1823     * This function will take effect -- thus, do I/O -- immediately. Use
1824     * it when you want to apply all configuration changes at once. The
1825     * current configuration set will get saved onto the current profile
1826     * configuration file.
1827     *
1828     */
1829    EAPI Eina_Bool    elm_config_save(void);
1830
1831    /**
1832     * Reload Elementary's configuration, bounded to current selected
1833     * profile.
1834     *
1835     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1836     * @ingroup Config
1837     *
1838     * Useful when you want to force reloading of configuration values for
1839     * a profile. If one removes user custom configuration directories,
1840     * for example, it will force a reload with system values insted.
1841     *
1842     */
1843    EAPI void         elm_config_reload(void);
1844
1845    /**
1846     * @}
1847     */
1848
1849    /**
1850     * @defgroup Profile Elementary Profile
1851     *
1852     * Profiles are pre-set options that affect the whole look-and-feel of
1853     * Elementary-based applications. There are, for example, profiles
1854     * aimed at desktop computer applications and others aimed at mobile,
1855     * touchscreen-based ones. You most probably don't want to use the
1856     * functions in this group unlees you're writing an elementary
1857     * configuration manager.
1858     *
1859     * @{
1860     */
1861
1862    /**
1863     * Get Elementary's profile in use.
1864     *
1865     * This gets the global profile that is applied to all Elementary
1866     * applications.
1867     *
1868     * @return The profile's name
1869     * @ingroup Profile
1870     */
1871    EAPI const char  *elm_profile_current_get(void);
1872
1873    /**
1874     * Get an Elementary's profile directory path in the filesystem. One
1875     * may want to fetch a system profile's dir or an user one (fetched
1876     * inside $HOME).
1877     *
1878     * @param profile The profile's name
1879     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1880     *                or a system one (@c EINA_FALSE)
1881     * @return The profile's directory path.
1882     * @ingroup Profile
1883     *
1884     * @note You must free it with elm_profile_dir_free().
1885     */
1886    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1887
1888    /**
1889     * Free an Elementary's profile directory path, as returned by
1890     * elm_profile_dir_get().
1891     *
1892     * @param p_dir The profile's path
1893     * @ingroup Profile
1894     *
1895     */
1896    EAPI void         elm_profile_dir_free(const char *p_dir);
1897
1898    /**
1899     * Get Elementary's list of available profiles.
1900     *
1901     * @return The profiles list. List node data are the profile name
1902     *         strings.
1903     * @ingroup Profile
1904     *
1905     * @note One must free this list, after usage, with the function
1906     *       elm_profile_list_free().
1907     */
1908    EAPI Eina_List   *elm_profile_list_get(void);
1909
1910    /**
1911     * Free Elementary's list of available profiles.
1912     *
1913     * @param l The profiles list, as returned by elm_profile_list_get().
1914     * @ingroup Profile
1915     *
1916     */
1917    EAPI void         elm_profile_list_free(Eina_List *l);
1918
1919    /**
1920     * Set Elementary's profile.
1921     *
1922     * This sets the global profile that is applied to Elementary
1923     * applications. Just the process the call comes from will be
1924     * affected.
1925     *
1926     * @param profile The profile's name
1927     * @ingroup Profile
1928     *
1929     */
1930    EAPI void         elm_profile_set(const char *profile);
1931
1932    /**
1933     * Set Elementary's profile.
1934     *
1935     * This sets the global profile that is applied to all Elementary
1936     * applications. All running Elementary windows will be affected.
1937     *
1938     * @param profile The profile's name
1939     * @ingroup Profile
1940     *
1941     */
1942    EAPI void         elm_profile_all_set(const char *profile);
1943
1944    /**
1945     * @}
1946     */
1947
1948    /**
1949     * @defgroup Engine Elementary Engine
1950     *
1951     * These are functions setting and querying which rendering engine
1952     * Elementary will use for drawing its windows' pixels.
1953     *
1954     * The following are the available engines:
1955     * @li "software_x11"
1956     * @li "fb"
1957     * @li "directfb"
1958     * @li "software_16_x11"
1959     * @li "software_8_x11"
1960     * @li "xrender_x11"
1961     * @li "opengl_x11"
1962     * @li "software_gdi"
1963     * @li "software_16_wince_gdi"
1964     * @li "sdl"
1965     * @li "software_16_sdl"
1966     * @li "opengl_sdl"
1967     * @li "buffer"
1968     * @li "ews"
1969     * @li "opengl_cocoa"
1970     * @li "psl1ght"
1971     *
1972     * @{
1973     */
1974
1975    /**
1976     * @brief Get Elementary's rendering engine in use.
1977     *
1978     * @return The rendering engine's name
1979     * @note there's no need to free the returned string, here.
1980     *
1981     * This gets the global rendering engine that is applied to all Elementary
1982     * applications.
1983     *
1984     * @see elm_engine_set()
1985     */
1986    EAPI const char  *elm_engine_current_get(void);
1987
1988    /**
1989     * @brief Set Elementary's rendering engine for use.
1990     *
1991     * @param engine The rendering engine's name
1992     *
1993     * This sets global rendering engine that is applied to all Elementary
1994     * applications. Note that it will take effect only to Elementary windows
1995     * created after this is called.
1996     *
1997     * @see elm_win_add()
1998     */
1999    EAPI void         elm_engine_set(const char *engine);
2000
2001    /**
2002     * @}
2003     */
2004
2005    /**
2006     * @defgroup Fonts Elementary Fonts
2007     *
2008     * These are functions dealing with font rendering, selection and the
2009     * like for Elementary applications. One might fetch which system
2010     * fonts are there to use and set custom fonts for individual classes
2011     * of UI items containing text (text classes).
2012     *
2013     * @{
2014     */
2015
2016   typedef struct _Elm_Text_Class
2017     {
2018        const char *name;
2019        const char *desc;
2020     } Elm_Text_Class;
2021
2022   typedef struct _Elm_Font_Overlay
2023     {
2024        const char     *text_class;
2025        const char     *font;
2026        Evas_Font_Size  size;
2027     } Elm_Font_Overlay;
2028
2029   typedef struct _Elm_Font_Properties
2030     {
2031        const char *name;
2032        Eina_List  *styles;
2033     } Elm_Font_Properties;
2034
2035    /**
2036     * Get Elementary's list of supported text classes.
2037     *
2038     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2039     * @ingroup Fonts
2040     *
2041     * Release the list with elm_text_classes_list_free().
2042     */
2043    EAPI const Eina_List     *elm_text_classes_list_get(void);
2044
2045    /**
2046     * Free Elementary's list of supported text classes.
2047     *
2048     * @ingroup Fonts
2049     *
2050     * @see elm_text_classes_list_get().
2051     */
2052    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2053
2054    /**
2055     * Get Elementary's list of font overlays, set with
2056     * elm_font_overlay_set().
2057     *
2058     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2059     * data.
2060     *
2061     * @ingroup Fonts
2062     *
2063     * For each text class, one can set a <b>font overlay</b> for it,
2064     * overriding the default font properties for that class coming from
2065     * the theme in use. There is no need to free this list.
2066     *
2067     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2068     */
2069    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2070
2071    /**
2072     * Set a font overlay for a given Elementary text class.
2073     *
2074     * @param text_class Text class name
2075     * @param font Font name and style string
2076     * @param size Font size
2077     *
2078     * @ingroup Fonts
2079     *
2080     * @p font has to be in the format returned by
2081     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2082     * and elm_font_overlay_unset().
2083     */
2084    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2085
2086    /**
2087     * Unset a font overlay for a given Elementary text class.
2088     *
2089     * @param text_class Text class name
2090     *
2091     * @ingroup Fonts
2092     *
2093     * This will bring back text elements belonging to text class
2094     * @p text_class back to their default font settings.
2095     */
2096    EAPI void                 elm_font_overlay_unset(const char *text_class);
2097
2098    /**
2099     * Apply the changes made with elm_font_overlay_set() and
2100     * elm_font_overlay_unset() on the current Elementary window.
2101     *
2102     * @ingroup Fonts
2103     *
2104     * This applies all font overlays set to all objects in the UI.
2105     */
2106    EAPI void                 elm_font_overlay_apply(void);
2107
2108    /**
2109     * Apply the changes made with elm_font_overlay_set() and
2110     * elm_font_overlay_unset() on all Elementary application windows.
2111     *
2112     * @ingroup Fonts
2113     *
2114     * This applies all font overlays set to all objects in the UI.
2115     */
2116    EAPI void                 elm_font_overlay_all_apply(void);
2117
2118    /**
2119     * Translate a font (family) name string in fontconfig's font names
2120     * syntax into an @c Elm_Font_Properties struct.
2121     *
2122     * @param font The font name and styles string
2123     * @return the font properties struct
2124     *
2125     * @ingroup Fonts
2126     *
2127     * @note The reverse translation can be achived with
2128     * elm_font_fontconfig_name_get(), for one style only (single font
2129     * instance, not family).
2130     */
2131    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2132
2133    /**
2134     * Free font properties return by elm_font_properties_get().
2135     *
2136     * @param efp the font properties struct
2137     *
2138     * @ingroup Fonts
2139     */
2140    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2141
2142    /**
2143     * Translate a font name, bound to a style, into fontconfig's font names
2144     * syntax.
2145     *
2146     * @param name The font (family) name
2147     * @param style The given style (may be @c NULL)
2148     *
2149     * @return the font name and style string
2150     *
2151     * @ingroup Fonts
2152     *
2153     * @note The reverse translation can be achived with
2154     * elm_font_properties_get(), for one style only (single font
2155     * instance, not family).
2156     */
2157    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2158
2159    /**
2160     * Free the font string return by elm_font_fontconfig_name_get().
2161     *
2162     * @param efp the font properties struct
2163     *
2164     * @ingroup Fonts
2165     */
2166    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2167
2168    /**
2169     * Create a font hash table of available system fonts.
2170     *
2171     * One must call it with @p list being the return value of
2172     * evas_font_available_list(). The hash will be indexed by font
2173     * (family) names, being its values @c Elm_Font_Properties blobs.
2174     *
2175     * @param list The list of available system fonts, as returned by
2176     * evas_font_available_list().
2177     * @return the font hash.
2178     *
2179     * @ingroup Fonts
2180     *
2181     * @note The user is supposed to get it populated at least with 3
2182     * default font families (Sans, Serif, Monospace), which should be
2183     * present on most systems.
2184     */
2185    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2186
2187    /**
2188     * Free the hash return by elm_font_available_hash_add().
2189     *
2190     * @param hash the hash to be freed.
2191     *
2192     * @ingroup Fonts
2193     */
2194    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2195
2196    /**
2197     * @}
2198     */
2199
2200    /**
2201     * @defgroup Fingers Fingers
2202     *
2203     * Elementary is designed to be finger-friendly for touchscreens,
2204     * and so in addition to scaling for display resolution, it can
2205     * also scale based on finger "resolution" (or size). You can then
2206     * customize the granularity of the areas meant to receive clicks
2207     * on touchscreens.
2208     *
2209     * Different profiles may have pre-set values for finger sizes.
2210     *
2211     * @ref general_functions_example_page "This" example contemplates
2212     * some of these functions.
2213     *
2214     * @{
2215     */
2216
2217    /**
2218     * Get the configured "finger size"
2219     *
2220     * @return The finger size
2221     *
2222     * This gets the globally configured finger size, <b>in pixels</b>
2223     *
2224     * @ingroup Fingers
2225     */
2226    EAPI Evas_Coord       elm_finger_size_get(void);
2227
2228    /**
2229     * Set the configured finger size
2230     *
2231     * This sets the globally configured finger size in pixels
2232     *
2233     * @param size The finger size
2234     * @ingroup Fingers
2235     */
2236    EAPI void             elm_finger_size_set(Evas_Coord size);
2237
2238    /**
2239     * Set the configured finger size for all applications on the display
2240     *
2241     * This sets the globally configured finger size in pixels for all
2242     * applications on the display
2243     *
2244     * @param size The finger size
2245     * @ingroup Fingers
2246     */
2247    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2248
2249    /**
2250     * @}
2251     */
2252
2253    /**
2254     * @defgroup Focus Focus
2255     *
2256     * An Elementary application has, at all times, one (and only one)
2257     * @b focused object. This is what determines where the input
2258     * events go to within the application's window. Also, focused
2259     * objects can be decorated differently, in order to signal to the
2260     * user where the input is, at a given moment.
2261     *
2262     * Elementary applications also have the concept of <b>focus
2263     * chain</b>: one can cycle through all the windows' focusable
2264     * objects by input (tab key) or programmatically. The default
2265     * focus chain for an application is the one define by the order in
2266     * which the widgets where added in code. One will cycle through
2267     * top level widgets, and, for each one containg sub-objects, cycle
2268     * through them all, before returning to the level
2269     * above. Elementary also allows one to set @b custom focus chains
2270     * for their applications.
2271     *
2272     * Besides the focused decoration a widget may exhibit, when it
2273     * gets focus, Elementary has a @b global focus highlight object
2274     * that can be enabled for a window. If one chooses to do so, this
2275     * extra highlight effect will surround the current focused object,
2276     * too.
2277     *
2278     * @note Some Elementary widgets are @b unfocusable, after
2279     * creation, by their very nature: they are not meant to be
2280     * interacted with input events, but are there just for visual
2281     * purposes.
2282     *
2283     * @ref general_functions_example_page "This" example contemplates
2284     * some of these functions.
2285     */
2286
2287    /**
2288     * Get the enable status of the focus highlight
2289     *
2290     * This gets whether the highlight on focused objects is enabled or not
2291     * @ingroup Focus
2292     */
2293    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2294
2295    /**
2296     * Set the enable status of the focus highlight
2297     *
2298     * Set whether to show or not the highlight on focused objects
2299     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2300     * @ingroup Focus
2301     */
2302    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2303
2304    /**
2305     * Get the enable status of the highlight animation
2306     *
2307     * Get whether the focus highlight, if enabled, will animate its switch from
2308     * one object to the next
2309     * @ingroup Focus
2310     */
2311    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2312
2313    /**
2314     * Set the enable status of the highlight animation
2315     *
2316     * Set whether the focus highlight, if enabled, will animate its switch from
2317     * one object to the next
2318     * @param animate Enable animation if EINA_TRUE, disable otherwise
2319     * @ingroup Focus
2320     */
2321    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2322
2323    /**
2324     * Get the whether an Elementary object has the focus or not.
2325     *
2326     * @param obj The Elementary object to get the information from
2327     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2328     *            not (and on errors).
2329     *
2330     * @see elm_object_focus_set()
2331     *
2332     * @ingroup Focus
2333     */
2334    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2335
2336    /**
2337     * Set/unset focus to a given Elementary object.
2338     *
2339     * @param obj The Elementary object to operate on.
2340     * @param enable @c EINA_TRUE Set focus to a given object,
2341     *               @c EINA_FALSE Unset focus to a given object.
2342     *
2343     * @note When you set focus to this object, if it can handle focus, will
2344     * take the focus away from the one who had it previously and will, for
2345     * now on, be the one receiving input events. Unsetting focus will remove
2346     * the focus from @p obj, passing it back to the previous element in the
2347     * focus chain list.
2348     *
2349     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2350     *
2351     * @ingroup Focus
2352     */
2353    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2354
2355    /**
2356     * Make a given Elementary object the focused one.
2357     *
2358     * @param obj The Elementary object to make focused.
2359     *
2360     * @note This object, if it can handle focus, will take the focus
2361     * away from the one who had it previously and will, for now on, be
2362     * the one receiving input events.
2363     *
2364     * @see elm_object_focus_get()
2365     *
2366     * @ingroup Focus
2367     */
2368    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2369
2370    /**
2371     * Remove the focus from an Elementary object
2372     *
2373     * @param obj The Elementary to take focus from
2374     *
2375     * This removes the focus from @p obj, passing it back to the
2376     * previous element in the focus chain list.
2377     *
2378     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2379     *
2380     * @ingroup Focus
2381     */
2382    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2383
2384    /**
2385     * Set the ability for an Element object to be focused
2386     *
2387     * @param obj The Elementary object to operate on
2388     * @param enable @c EINA_TRUE if the object can be focused, @c
2389     *        EINA_FALSE if not (and on errors)
2390     *
2391     * This sets whether the object @p obj is able to take focus or
2392     * not. Unfocusable objects do nothing when programmatically
2393     * focused, being the nearest focusable parent object the one
2394     * really getting focus. Also, when they receive mouse input, they
2395     * will get the event, but not take away the focus from where it
2396     * was previously.
2397     *
2398     * @ingroup Focus
2399     */
2400    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2401
2402    /**
2403     * Get whether an Elementary object is focusable or not
2404     *
2405     * @param obj The Elementary object to operate on
2406     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2407     *             EINA_FALSE if not (and on errors)
2408     *
2409     * @note Objects which are meant to be interacted with by input
2410     * events are created able to be focused, by default. All the
2411     * others are not.
2412     *
2413     * @ingroup Focus
2414     */
2415    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2416
2417    /**
2418     * Set custom focus chain.
2419     *
2420     * This function overwrites any previous custom focus chain within
2421     * the list of objects. The previous list will be deleted and this list
2422     * will be managed by elementary. After it is set, don't modify it.
2423     *
2424     * @note On focus cycle, only will be evaluated children of this container.
2425     *
2426     * @param obj The container object
2427     * @param objs Chain of objects to pass focus
2428     * @ingroup Focus
2429     */
2430    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2431
2432    /**
2433     * Unset a custom focus chain on a given Elementary widget
2434     *
2435     * @param obj The container object to remove focus chain from
2436     *
2437     * Any focus chain previously set on @p obj (for its child objects)
2438     * is removed entirely after this call.
2439     *
2440     * @ingroup Focus
2441     */
2442    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2443
2444    /**
2445     * Get custom focus chain
2446     *
2447     * @param obj The container object
2448     * @ingroup Focus
2449     */
2450    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2451
2452    /**
2453     * Append object to custom focus chain.
2454     *
2455     * @note If relative_child equal to NULL or not in custom chain, the object
2456     * will be added in end.
2457     *
2458     * @note On focus cycle, only will be evaluated children of this container.
2459     *
2460     * @param obj The container object
2461     * @param child The child to be added in custom chain
2462     * @param relative_child The relative object to position the child
2463     * @ingroup Focus
2464     */
2465    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2466
2467    /**
2468     * Prepend object to custom focus chain.
2469     *
2470     * @note If relative_child equal to NULL or not in custom chain, the object
2471     * will be added in begin.
2472     *
2473     * @note On focus cycle, only will be evaluated children of this container.
2474     *
2475     * @param obj The container object
2476     * @param child The child to be added in custom chain
2477     * @param relative_child The relative object to position the child
2478     * @ingroup Focus
2479     */
2480    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2481
2482    /**
2483     * Give focus to next object in object tree.
2484     *
2485     * Give focus to next object in focus chain of one object sub-tree.
2486     * If the last object of chain already have focus, the focus will go to the
2487     * first object of chain.
2488     *
2489     * @param obj The object root of sub-tree
2490     * @param dir Direction to cycle the focus
2491     *
2492     * @ingroup Focus
2493     */
2494    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2495
2496    /**
2497     * Give focus to near object in one direction.
2498     *
2499     * Give focus to near object in direction of one object.
2500     * If none focusable object in given direction, the focus will not change.
2501     *
2502     * @param obj The reference object
2503     * @param x Horizontal component of direction to focus
2504     * @param y Vertical component of direction to focus
2505     *
2506     * @ingroup Focus
2507     */
2508    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2509
2510    /**
2511     * Make the elementary object and its children to be unfocusable
2512     * (or focusable).
2513     *
2514     * @param obj The Elementary object to operate on
2515     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2516     *        @c EINA_FALSE for focusable.
2517     *
2518     * This sets whether the object @p obj and its children objects
2519     * are able to take focus or not. If the tree is set as unfocusable,
2520     * newest focused object which is not in this tree will get focus.
2521     * This API can be helpful for an object to be deleted.
2522     * When an object will be deleted soon, it and its children may not
2523     * want to get focus (by focus reverting or by other focus controls).
2524     * Then, just use this API before deleting.
2525     *
2526     * @see elm_object_tree_unfocusable_get()
2527     *
2528     * @ingroup Focus
2529     */
2530    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2531
2532    /**
2533     * Get whether an Elementary object and its children are unfocusable or not.
2534     *
2535     * @param obj The Elementary object to get the information from
2536     * @return @c EINA_TRUE, if the tree is unfocussable,
2537     *         @c EINA_FALSE if not (and on errors).
2538     *
2539     * @see elm_object_tree_unfocusable_set()
2540     *
2541     * @ingroup Focus
2542     */
2543    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2544
2545    /**
2546     * @defgroup Scrolling Scrolling
2547     *
2548     * These are functions setting how scrollable views in Elementary
2549     * widgets should behave on user interaction.
2550     *
2551     * @{
2552     */
2553
2554    /**
2555     * Get whether scrollers should bounce when they reach their
2556     * viewport's edge during a scroll.
2557     *
2558     * @return the thumb scroll bouncing state
2559     *
2560     * This is the default behavior for touch screens, in general.
2561     * @ingroup Scrolling
2562     */
2563    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2564
2565    /**
2566     * Set whether scrollers should bounce when they reach their
2567     * viewport's edge during a scroll.
2568     *
2569     * @param enabled the thumb scroll bouncing state
2570     *
2571     * @see elm_thumbscroll_bounce_enabled_get()
2572     * @ingroup Scrolling
2573     */
2574    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2575
2576    /**
2577     * Set whether scrollers should bounce when they reach their
2578     * viewport's edge during a scroll, for all Elementary application
2579     * windows.
2580     *
2581     * @param enabled the thumb scroll bouncing state
2582     *
2583     * @see elm_thumbscroll_bounce_enabled_get()
2584     * @ingroup Scrolling
2585     */
2586    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2587
2588    /**
2589     * Get the amount of inertia a scroller will impose at bounce
2590     * animations.
2591     *
2592     * @return the thumb scroll bounce friction
2593     *
2594     * @ingroup Scrolling
2595     */
2596    EAPI double           elm_scroll_bounce_friction_get(void);
2597
2598    /**
2599     * Set the amount of inertia a scroller will impose at bounce
2600     * animations.
2601     *
2602     * @param friction the thumb scroll bounce friction
2603     *
2604     * @see elm_thumbscroll_bounce_friction_get()
2605     * @ingroup Scrolling
2606     */
2607    EAPI void             elm_scroll_bounce_friction_set(double friction);
2608
2609    /**
2610     * Set the amount of inertia a scroller will impose at bounce
2611     * animations, for all Elementary application windows.
2612     *
2613     * @param friction the thumb scroll bounce friction
2614     *
2615     * @see elm_thumbscroll_bounce_friction_get()
2616     * @ingroup Scrolling
2617     */
2618    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2619
2620    /**
2621     * Get the amount of inertia a <b>paged</b> scroller will impose at
2622     * page fitting animations.
2623     *
2624     * @return the page scroll friction
2625     *
2626     * @ingroup Scrolling
2627     */
2628    EAPI double           elm_scroll_page_scroll_friction_get(void);
2629
2630    /**
2631     * Set the amount of inertia a <b>paged</b> scroller will impose at
2632     * page fitting animations.
2633     *
2634     * @param friction the page scroll friction
2635     *
2636     * @see elm_thumbscroll_page_scroll_friction_get()
2637     * @ingroup Scrolling
2638     */
2639    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2640
2641    /**
2642     * Set the amount of inertia a <b>paged</b> scroller will impose at
2643     * page fitting animations, for all Elementary application windows.
2644     *
2645     * @param friction the page scroll friction
2646     *
2647     * @see elm_thumbscroll_page_scroll_friction_get()
2648     * @ingroup Scrolling
2649     */
2650    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2651
2652    /**
2653     * Get the amount of inertia a scroller will impose at region bring
2654     * animations.
2655     *
2656     * @return the bring in scroll friction
2657     *
2658     * @ingroup Scrolling
2659     */
2660    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2661
2662    /**
2663     * Set the amount of inertia a scroller will impose at region bring
2664     * animations.
2665     *
2666     * @param friction the bring in scroll friction
2667     *
2668     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2669     * @ingroup Scrolling
2670     */
2671    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2672
2673    /**
2674     * Set the amount of inertia a scroller will impose at region bring
2675     * animations, for all Elementary application windows.
2676     *
2677     * @param friction the bring in scroll friction
2678     *
2679     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2680     * @ingroup Scrolling
2681     */
2682    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2683
2684    /**
2685     * Get the amount of inertia scrollers will impose at animations
2686     * triggered by Elementary widgets' zooming API.
2687     *
2688     * @return the zoom friction
2689     *
2690     * @ingroup Scrolling
2691     */
2692    EAPI double           elm_scroll_zoom_friction_get(void);
2693
2694    /**
2695     * Set the amount of inertia scrollers will impose at animations
2696     * triggered by Elementary widgets' zooming API.
2697     *
2698     * @param friction the zoom friction
2699     *
2700     * @see elm_thumbscroll_zoom_friction_get()
2701     * @ingroup Scrolling
2702     */
2703    EAPI void             elm_scroll_zoom_friction_set(double friction);
2704
2705    /**
2706     * Set the amount of inertia scrollers will impose at animations
2707     * triggered by Elementary widgets' zooming API, for all Elementary
2708     * application windows.
2709     *
2710     * @param friction the zoom friction
2711     *
2712     * @see elm_thumbscroll_zoom_friction_get()
2713     * @ingroup Scrolling
2714     */
2715    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2716
2717    /**
2718     * Get whether scrollers should be draggable from any point in their
2719     * views.
2720     *
2721     * @return the thumb scroll state
2722     *
2723     * @note This is the default behavior for touch screens, in general.
2724     * @note All other functions namespaced with "thumbscroll" will only
2725     *       have effect if this mode is enabled.
2726     *
2727     * @ingroup Scrolling
2728     */
2729    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2730
2731    /**
2732     * Set whether scrollers should be draggable from any point in their
2733     * views.
2734     *
2735     * @param enabled the thumb scroll state
2736     *
2737     * @see elm_thumbscroll_enabled_get()
2738     * @ingroup Scrolling
2739     */
2740    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2741
2742    /**
2743     * Set whether scrollers should be draggable from any point in their
2744     * views, for all Elementary application windows.
2745     *
2746     * @param enabled the thumb scroll state
2747     *
2748     * @see elm_thumbscroll_enabled_get()
2749     * @ingroup Scrolling
2750     */
2751    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2752
2753    /**
2754     * Get the number of pixels one should travel while dragging a
2755     * scroller's view to actually trigger scrolling.
2756     *
2757     * @return the thumb scroll threshould
2758     *
2759     * One would use higher values for touch screens, in general, because
2760     * of their inherent imprecision.
2761     * @ingroup Scrolling
2762     */
2763    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2764
2765    /**
2766     * Set the number of pixels one should travel while dragging a
2767     * scroller's view to actually trigger scrolling.
2768     *
2769     * @param threshold the thumb scroll threshould
2770     *
2771     * @see elm_thumbscroll_threshould_get()
2772     * @ingroup Scrolling
2773     */
2774    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2775
2776    /**
2777     * Set the number of pixels one should travel while dragging a
2778     * scroller's view to actually trigger scrolling, for all Elementary
2779     * application windows.
2780     *
2781     * @param threshold the thumb scroll threshould
2782     *
2783     * @see elm_thumbscroll_threshould_get()
2784     * @ingroup Scrolling
2785     */
2786    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2787
2788    /**
2789     * Get the minimum speed of mouse cursor movement which will trigger
2790     * list self scrolling animation after a mouse up event
2791     * (pixels/second).
2792     *
2793     * @return the thumb scroll momentum threshould
2794     *
2795     * @ingroup Scrolling
2796     */
2797    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2798
2799    /**
2800     * Set the minimum speed of mouse cursor movement which will trigger
2801     * list self scrolling animation after a mouse up event
2802     * (pixels/second).
2803     *
2804     * @param threshold the thumb scroll momentum threshould
2805     *
2806     * @see elm_thumbscroll_momentum_threshould_get()
2807     * @ingroup Scrolling
2808     */
2809    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2810
2811    /**
2812     * Set the minimum speed of mouse cursor movement which will trigger
2813     * list self scrolling animation after a mouse up event
2814     * (pixels/second), for all Elementary application windows.
2815     *
2816     * @param threshold the thumb scroll momentum threshould
2817     *
2818     * @see elm_thumbscroll_momentum_threshould_get()
2819     * @ingroup Scrolling
2820     */
2821    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2822
2823    /**
2824     * Get the amount of inertia a scroller will impose at self scrolling
2825     * animations.
2826     *
2827     * @return the thumb scroll friction
2828     *
2829     * @ingroup Scrolling
2830     */
2831    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2832
2833    /**
2834     * Set the amount of inertia a scroller will impose at self scrolling
2835     * animations.
2836     *
2837     * @param friction the thumb scroll friction
2838     *
2839     * @see elm_thumbscroll_friction_get()
2840     * @ingroup Scrolling
2841     */
2842    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2843
2844    /**
2845     * Set the amount of inertia a scroller will impose at self scrolling
2846     * animations, for all Elementary application windows.
2847     *
2848     * @param friction the thumb scroll friction
2849     *
2850     * @see elm_thumbscroll_friction_get()
2851     * @ingroup Scrolling
2852     */
2853    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2854
2855    /**
2856     * Get the amount of lag between your actual mouse cursor dragging
2857     * movement and a scroller's view movement itself, while pushing it
2858     * into bounce state manually.
2859     *
2860     * @return the thumb scroll border friction
2861     *
2862     * @ingroup Scrolling
2863     */
2864    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2865
2866    /**
2867     * Set the amount of lag between your actual mouse cursor dragging
2868     * movement and a scroller's view movement itself, while pushing it
2869     * into bounce state manually.
2870     *
2871     * @param friction the thumb scroll border friction. @c 0.0 for
2872     *        perfect synchrony between two movements, @c 1.0 for maximum
2873     *        lag.
2874     *
2875     * @see elm_thumbscroll_border_friction_get()
2876     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2877     *
2878     * @ingroup Scrolling
2879     */
2880    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2881
2882    /**
2883     * Set the amount of lag between your actual mouse cursor dragging
2884     * movement and a scroller's view movement itself, while pushing it
2885     * into bounce state manually, for all Elementary application windows.
2886     *
2887     * @param friction the thumb scroll border friction. @c 0.0 for
2888     *        perfect synchrony between two movements, @c 1.0 for maximum
2889     *        lag.
2890     *
2891     * @see elm_thumbscroll_border_friction_get()
2892     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2893     *
2894     * @ingroup Scrolling
2895     */
2896    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2897
2898    /**
2899     * Get the sensitivity amount which is be multiplied by the length of
2900     * mouse dragging.
2901     *
2902     * @return the thumb scroll sensitivity friction
2903     *
2904     * @ingroup Scrolling
2905     */
2906    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2907
2908    /**
2909     * Set the sensitivity amount which is be multiplied by the length of
2910     * mouse dragging.
2911     *
2912     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2913     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2914     *        is proper.
2915     *
2916     * @see elm_thumbscroll_sensitivity_friction_get()
2917     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2918     *
2919     * @ingroup Scrolling
2920     */
2921    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2922
2923    /**
2924     * Set the sensitivity amount which is be multiplied by the length of
2925     * mouse dragging, for all Elementary application windows.
2926     *
2927     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2928     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2929     *        is proper.
2930     *
2931     * @see elm_thumbscroll_sensitivity_friction_get()
2932     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2933     *
2934     * @ingroup Scrolling
2935     */
2936    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2937
2938    /**
2939     * @}
2940     */
2941
2942    /**
2943     * @defgroup Scrollhints Scrollhints
2944     *
2945     * Objects when inside a scroller can scroll, but this may not always be
2946     * desirable in certain situations. This allows an object to hint to itself
2947     * and parents to "not scroll" in one of 2 ways. If any child object of a
2948     * scroller has pushed a scroll freeze or hold then it affects all parent
2949     * scrollers until all children have released them.
2950     *
2951     * 1. To hold on scrolling. This means just flicking and dragging may no
2952     * longer scroll, but pressing/dragging near an edge of the scroller will
2953     * still scroll. This is automatically used by the entry object when
2954     * selecting text.
2955     *
2956     * 2. To totally freeze scrolling. This means it stops. until
2957     * popped/released.
2958     *
2959     * @{
2960     */
2961
2962    /**
2963     * Push the scroll hold by 1
2964     *
2965     * This increments the scroll hold count by one. If it is more than 0 it will
2966     * take effect on the parents of the indicated object.
2967     *
2968     * @param obj The object
2969     * @ingroup Scrollhints
2970     */
2971    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2972
2973    /**
2974     * Pop the scroll hold by 1
2975     *
2976     * This decrements the scroll hold count by one. If it is more than 0 it will
2977     * take effect on the parents of the indicated object.
2978     *
2979     * @param obj The object
2980     * @ingroup Scrollhints
2981     */
2982    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2983
2984    /**
2985     * Push the scroll freeze by 1
2986     *
2987     * This increments the scroll freeze count by one. If it is more
2988     * than 0 it will take effect on the parents of the indicated
2989     * object.
2990     *
2991     * @param obj The object
2992     * @ingroup Scrollhints
2993     */
2994    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2995
2996    /**
2997     * Pop the scroll freeze by 1
2998     *
2999     * This decrements the scroll freeze count by one. If it is more
3000     * than 0 it will take effect on the parents of the indicated
3001     * object.
3002     *
3003     * @param obj The object
3004     * @ingroup Scrollhints
3005     */
3006    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3007
3008    /**
3009     * Lock the scrolling of the given widget (and thus all parents)
3010     *
3011     * This locks the given object from scrolling in the X axis (and implicitly
3012     * also locks all parent scrollers too from doing the same).
3013     *
3014     * @param obj The object
3015     * @param lock The lock state (1 == locked, 0 == unlocked)
3016     * @ingroup Scrollhints
3017     */
3018    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3019
3020    /**
3021     * Lock the scrolling of the given widget (and thus all parents)
3022     *
3023     * This locks the given object from scrolling in the Y axis (and implicitly
3024     * also locks all parent scrollers too from doing the same).
3025     *
3026     * @param obj The object
3027     * @param lock The lock state (1 == locked, 0 == unlocked)
3028     * @ingroup Scrollhints
3029     */
3030    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3031
3032    /**
3033     * Get the scrolling lock of the given widget
3034     *
3035     * This gets the lock for X axis scrolling.
3036     *
3037     * @param obj The object
3038     * @ingroup Scrollhints
3039     */
3040    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3041
3042    /**
3043     * Get the scrolling lock of the given widget
3044     *
3045     * This gets the lock for X axis scrolling.
3046     *
3047     * @param obj The object
3048     * @ingroup Scrollhints
3049     */
3050    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3051
3052    /**
3053     * @}
3054     */
3055
3056    /**
3057     * Send a signal to the widget edje object.
3058     *
3059     * This function sends a signal to the edje object of the obj. An
3060     * edje program can respond to a signal by specifying matching
3061     * 'signal' and 'source' fields.
3062     *
3063     * @param obj The object
3064     * @param emission The signal's name.
3065     * @param source The signal's source.
3066     * @ingroup General
3067     */
3068    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3069
3070    /**
3071     * Add a callback for a signal emitted by widget edje object.
3072     *
3073     * This function connects a callback function to a signal emitted by the
3074     * edje object of the obj.
3075     * Globs can occur in either the emission or source name.
3076     *
3077     * @param obj The object
3078     * @param emission The signal's name.
3079     * @param source The signal's source.
3080     * @param func The callback function to be executed when the signal is
3081     * emitted.
3082     * @param data A pointer to data to pass in to the callback function.
3083     * @ingroup General
3084     */
3085    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
3086
3087    /**
3088     * Remove a signal-triggered callback from a widget edje object.
3089     *
3090     * This function removes a callback, previoulsy attached to a
3091     * signal emitted by the edje object of the obj.  The parameters
3092     * emission, source and func must match exactly those passed to a
3093     * previous call to elm_object_signal_callback_add(). The data
3094     * pointer that was passed to this call will be returned.
3095     *
3096     * @param obj The object
3097     * @param emission The signal's name.
3098     * @param source The signal's source.
3099     * @param func The callback function to be executed when the signal is
3100     * emitted.
3101     * @return The data pointer
3102     * @ingroup General
3103     */
3104    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
3105
3106    /**
3107     * Add a callback for input events (key up, key down, mouse wheel)
3108     * on a given Elementary widget
3109     *
3110     * @param obj The widget to add an event callback on
3111     * @param func The callback function to be executed when the event
3112     * happens
3113     * @param data Data to pass in to @p func
3114     *
3115     * Every widget in an Elementary interface set to receive focus,
3116     * with elm_object_focus_allow_set(), will propagate @b all of its
3117     * key up, key down and mouse wheel input events up to its parent
3118     * object, and so on. All of the focusable ones in this chain which
3119     * had an event callback set, with this call, will be able to treat
3120     * those events. There are two ways of making the propagation of
3121     * these event upwards in the tree of widgets to @b cease:
3122     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3123     *   the event was @b not processed, so the propagation will go on.
3124     * - The @c event_info pointer passed to @p func will contain the
3125     *   event's structure and, if you OR its @c event_flags inner
3126     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3127     *   one has already handled it, thus killing the event's
3128     *   propagation, too.
3129     *
3130     * @note Your event callback will be issued on those events taking
3131     * place only if no other child widget of @obj has consumed the
3132     * event already.
3133     *
3134     * @note Not to be confused with @c
3135     * evas_object_event_callback_add(), which will add event callbacks
3136     * per type on general Evas objects (no event propagation
3137     * infrastructure taken in account).
3138     *
3139     * @note Not to be confused with @c
3140     * elm_object_signal_callback_add(), which will add callbacks to @b
3141     * signals coming from a widget's theme, not input events.
3142     *
3143     * @note Not to be confused with @c
3144     * edje_object_signal_callback_add(), which does the same as
3145     * elm_object_signal_callback_add(), but directly on an Edje
3146     * object.
3147     *
3148     * @note Not to be confused with @c
3149     * evas_object_smart_callback_add(), which adds callbacks to smart
3150     * objects' <b>smart events</b>, and not input events.
3151     *
3152     * @see elm_object_event_callback_del()
3153     *
3154     * @ingroup General
3155     */
3156    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3157
3158    /**
3159     * Remove an event callback from a widget.
3160     *
3161     * This function removes a callback, previoulsy attached to event emission
3162     * by the @p obj.
3163     * The parameters func and data must match exactly those passed to
3164     * a previous call to elm_object_event_callback_add(). The data pointer that
3165     * was passed to this call will be returned.
3166     *
3167     * @param obj The object
3168     * @param func The callback function to be executed when the event is
3169     * emitted.
3170     * @param data Data to pass in to the callback function.
3171     * @return The data pointer
3172     * @ingroup General
3173     */
3174    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3175
3176    /**
3177     * Adjust size of an element for finger usage.
3178     *
3179     * @param times_w How many fingers should fit horizontally
3180     * @param w Pointer to the width size to adjust
3181     * @param times_h How many fingers should fit vertically
3182     * @param h Pointer to the height size to adjust
3183     *
3184     * This takes width and height sizes (in pixels) as input and a
3185     * size multiple (which is how many fingers you want to place
3186     * within the area, being "finger" the size set by
3187     * elm_finger_size_set()), and adjusts the size to be large enough
3188     * to accommodate the resulting size -- if it doesn't already
3189     * accommodate it. On return the @p w and @p h sizes pointed to by
3190     * these parameters will be modified, on those conditions.
3191     *
3192     * @note This is kind of a low level Elementary call, most useful
3193     * on size evaluation times for widgets. An external user wouldn't
3194     * be calling, most of the time.
3195     *
3196     * @ingroup Fingers
3197     */
3198    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3199
3200    /**
3201     * Get the duration for occuring long press event.
3202     *
3203     * @return Timeout for long press event
3204     * @ingroup Longpress
3205     */
3206    EAPI double           elm_longpress_timeout_get(void);
3207
3208    /**
3209     * Set the duration for occuring long press event.
3210     *
3211     * @param lonpress_timeout Timeout for long press event
3212     * @ingroup Longpress
3213     */
3214    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3215
3216    /**
3217     * @defgroup Debug Debug
3218     * don't use it unless you are sure
3219     *
3220     * @{
3221     */
3222
3223    /**
3224     * Print Tree object hierarchy in stdout
3225     *
3226     * @param obj The root object
3227     * @ingroup Debug
3228     */
3229    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3230    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3231
3232    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3233    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3234    /**
3235     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3236     *
3237     * @param obj The root object
3238     * @param file The path of output file
3239     * @ingroup Debug
3240     */
3241    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3242
3243    /**
3244     * @}
3245     */
3246
3247    /**
3248     * @defgroup Theme Theme
3249     *
3250     * Elementary uses Edje to theme its widgets, naturally. But for the most
3251     * part this is hidden behind a simpler interface that lets the user set
3252     * extensions and choose the style of widgets in a much easier way.
3253     *
3254     * Instead of thinking in terms of paths to Edje files and their groups
3255     * each time you want to change the appearance of a widget, Elementary
3256     * works so you can add any theme file with extensions or replace the
3257     * main theme at one point in the application, and then just set the style
3258     * of widgets with elm_object_style_set() and related functions. Elementary
3259     * will then look in its list of themes for a matching group and apply it,
3260     * and when the theme changes midway through the application, all widgets
3261     * will be updated accordingly.
3262     *
3263     * There are three concepts you need to know to understand how Elementary
3264     * theming works: default theme, extensions and overlays.
3265     *
3266     * Default theme, obviously enough, is the one that provides the default
3267     * look of all widgets. End users can change the theme used by Elementary
3268     * by setting the @c ELM_THEME environment variable before running an
3269     * application, or globally for all programs using the @c elementary_config
3270     * utility. Applications can change the default theme using elm_theme_set(),
3271     * but this can go against the user wishes, so it's not an adviced practice.
3272     *
3273     * Ideally, applications should find everything they need in the already
3274     * provided theme, but there may be occasions when that's not enough and
3275     * custom styles are required to correctly express the idea. For this
3276     * cases, Elementary has extensions.
3277     *
3278     * Extensions allow the application developer to write styles of its own
3279     * to apply to some widgets. This requires knowledge of how each widget
3280     * is themed, as extensions will always replace the entire group used by
3281     * the widget, so important signals and parts need to be there for the
3282     * object to behave properly (see documentation of Edje for details).
3283     * Once the theme for the extension is done, the application needs to add
3284     * it to the list of themes Elementary will look into, using
3285     * elm_theme_extension_add(), and set the style of the desired widgets as
3286     * he would normally with elm_object_style_set().
3287     *
3288     * Overlays, on the other hand, can replace the look of all widgets by
3289     * overriding the default style. Like extensions, it's up to the application
3290     * developer to write the theme for the widgets it wants, the difference
3291     * being that when looking for the theme, Elementary will check first the
3292     * list of overlays, then the set theme and lastly the list of extensions,
3293     * so with overlays it's possible to replace the default view and every
3294     * widget will be affected. This is very much alike to setting the whole
3295     * theme for the application and will probably clash with the end user
3296     * options, not to mention the risk of ending up with not matching styles
3297     * across the program. Unless there's a very special reason to use them,
3298     * overlays should be avoided for the resons exposed before.
3299     *
3300     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3301     * keeps one default internally and every function that receives one of
3302     * these can be called with NULL to refer to this default (except for
3303     * elm_theme_free()). It's possible to create a new instance of a
3304     * ::Elm_Theme to set other theme for a specific widget (and all of its
3305     * children), but this is as discouraged, if not even more so, than using
3306     * overlays. Don't use this unless you really know what you are doing.
3307     *
3308     * But to be less negative about things, you can look at the following
3309     * examples:
3310     * @li @ref theme_example_01 "Using extensions"
3311     * @li @ref theme_example_02 "Using overlays"
3312     *
3313     * @{
3314     */
3315    /**
3316     * @typedef Elm_Theme
3317     *
3318     * Opaque handler for the list of themes Elementary looks for when
3319     * rendering widgets.
3320     *
3321     * Stay out of this unless you really know what you are doing. For most
3322     * cases, sticking to the default is all a developer needs.
3323     */
3324    typedef struct _Elm_Theme Elm_Theme;
3325
3326    /**
3327     * Create a new specific theme
3328     *
3329     * This creates an empty specific theme that only uses the default theme. A
3330     * specific theme has its own private set of extensions and overlays too
3331     * (which are empty by default). Specific themes do not fall back to themes
3332     * of parent objects. They are not intended for this use. Use styles, overlays
3333     * and extensions when needed, but avoid specific themes unless there is no
3334     * other way (example: you want to have a preview of a new theme you are
3335     * selecting in a "theme selector" window. The preview is inside a scroller
3336     * and should display what the theme you selected will look like, but not
3337     * actually apply it yet. The child of the scroller will have a specific
3338     * theme set to show this preview before the user decides to apply it to all
3339     * applications).
3340     */
3341    EAPI Elm_Theme       *elm_theme_new(void);
3342    /**
3343     * Free a specific theme
3344     *
3345     * @param th The theme to free
3346     *
3347     * This frees a theme created with elm_theme_new().
3348     */
3349    EAPI void             elm_theme_free(Elm_Theme *th);
3350    /**
3351     * Copy the theme fom the source to the destination theme
3352     *
3353     * @param th The source theme to copy from
3354     * @param thdst The destination theme to copy data to
3355     *
3356     * This makes a one-time static copy of all the theme config, extensions
3357     * and overlays from @p th to @p thdst. If @p th references a theme, then
3358     * @p thdst is also set to reference it, with all the theme settings,
3359     * overlays and extensions that @p th had.
3360     */
3361    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3362    /**
3363     * Tell the source theme to reference the ref theme
3364     *
3365     * @param th The theme that will do the referencing
3366     * @param thref The theme that is the reference source
3367     *
3368     * This clears @p th to be empty and then sets it to refer to @p thref
3369     * so @p th acts as an override to @p thref, but where its overrides
3370     * don't apply, it will fall through to @p thref for configuration.
3371     */
3372    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3373    /**
3374     * Return the theme referred to
3375     *
3376     * @param th The theme to get the reference from
3377     * @return The referenced theme handle
3378     *
3379     * This gets the theme set as the reference theme by elm_theme_ref_set().
3380     * If no theme is set as a reference, NULL is returned.
3381     */
3382    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3383    /**
3384     * Return the default theme
3385     *
3386     * @return The default theme handle
3387     *
3388     * This returns the internal default theme setup handle that all widgets
3389     * use implicitly unless a specific theme is set. This is also often use
3390     * as a shorthand of NULL.
3391     */
3392    EAPI Elm_Theme       *elm_theme_default_get(void);
3393    /**
3394     * Prepends a theme overlay to the list of overlays
3395     *
3396     * @param th The theme to add to, or if NULL, the default theme
3397     * @param item The Edje file path to be used
3398     *
3399     * Use this if your application needs to provide some custom overlay theme
3400     * (An Edje file that replaces some default styles of widgets) where adding
3401     * new styles, or changing system theme configuration is not possible. Do
3402     * NOT use this instead of a proper system theme configuration. Use proper
3403     * configuration files, profiles, environment variables etc. to set a theme
3404     * so that the theme can be altered by simple confiugration by a user. Using
3405     * this call to achieve that effect is abusing the API and will create lots
3406     * of trouble.
3407     *
3408     * @see elm_theme_extension_add()
3409     */
3410    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3411    /**
3412     * Delete a theme overlay from the list of overlays
3413     *
3414     * @param th The theme to delete from, or if NULL, the default theme
3415     * @param item The name of the theme overlay
3416     *
3417     * @see elm_theme_overlay_add()
3418     */
3419    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3420    /**
3421     * Appends a theme extension to the list of extensions.
3422     *
3423     * @param th The theme to add to, or if NULL, the default theme
3424     * @param item The Edje file path to be used
3425     *
3426     * This is intended when an application needs more styles of widgets or new
3427     * widget themes that the default does not provide (or may not provide). The
3428     * application has "extended" usage by coming up with new custom style names
3429     * for widgets for specific uses, but as these are not "standard", they are
3430     * not guaranteed to be provided by a default theme. This means the
3431     * application is required to provide these extra elements itself in specific
3432     * Edje files. This call adds one of those Edje files to the theme search
3433     * path to be search after the default theme. The use of this call is
3434     * encouraged when default styles do not meet the needs of the application.
3435     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3436     *
3437     * @see elm_object_style_set()
3438     */
3439    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3440    /**
3441     * Deletes a theme extension from the list of extensions.
3442     *
3443     * @param th The theme to delete from, or if NULL, the default theme
3444     * @param item The name of the theme extension
3445     *
3446     * @see elm_theme_extension_add()
3447     */
3448    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3449    /**
3450     * Set the theme search order for the given theme
3451     *
3452     * @param th The theme to set the search order, or if NULL, the default theme
3453     * @param theme Theme search string
3454     *
3455     * This sets the search string for the theme in path-notation from first
3456     * theme to search, to last, delimited by the : character. Example:
3457     *
3458     * "shiny:/path/to/file.edj:default"
3459     *
3460     * See the ELM_THEME environment variable for more information.
3461     *
3462     * @see elm_theme_get()
3463     * @see elm_theme_list_get()
3464     */
3465    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3466    /**
3467     * Return the theme search order
3468     *
3469     * @param th The theme to get the search order, or if NULL, the default theme
3470     * @return The internal search order path
3471     *
3472     * This function returns a colon separated string of theme elements as
3473     * returned by elm_theme_list_get().
3474     *
3475     * @see elm_theme_set()
3476     * @see elm_theme_list_get()
3477     */
3478    EAPI const char      *elm_theme_get(Elm_Theme *th);
3479    /**
3480     * Return a list of theme elements to be used in a theme.
3481     *
3482     * @param th Theme to get the list of theme elements from.
3483     * @return The internal list of theme elements
3484     *
3485     * This returns the internal list of theme elements (will only be valid as
3486     * long as the theme is not modified by elm_theme_set() or theme is not
3487     * freed by elm_theme_free(). This is a list of strings which must not be
3488     * altered as they are also internal. If @p th is NULL, then the default
3489     * theme element list is returned.
3490     *
3491     * A theme element can consist of a full or relative path to a .edj file,
3492     * or a name, without extension, for a theme to be searched in the known
3493     * theme paths for Elemementary.
3494     *
3495     * @see elm_theme_set()
3496     * @see elm_theme_get()
3497     */
3498    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3499    /**
3500     * Return the full patrh for a theme element
3501     *
3502     * @param f The theme element name
3503     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3504     * @return The full path to the file found.
3505     *
3506     * This returns a string you should free with free() on success, NULL on
3507     * failure. This will search for the given theme element, and if it is a
3508     * full or relative path element or a simple searchable name. The returned
3509     * path is the full path to the file, if searched, and the file exists, or it
3510     * is simply the full path given in the element or a resolved path if
3511     * relative to home. The @p in_search_path boolean pointed to is set to
3512     * EINA_TRUE if the file was a searchable file andis in the search path,
3513     * and EINA_FALSE otherwise.
3514     */
3515    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3516    /**
3517     * Flush the current theme.
3518     *
3519     * @param th Theme to flush
3520     *
3521     * This flushes caches that let elementary know where to find theme elements
3522     * in the given theme. If @p th is NULL, then the default theme is flushed.
3523     * Call this function if source theme data has changed in such a way as to
3524     * make any caches Elementary kept invalid.
3525     */
3526    EAPI void             elm_theme_flush(Elm_Theme *th);
3527    /**
3528     * This flushes all themes (default and specific ones).
3529     *
3530     * This will flush all themes in the current application context, by calling
3531     * elm_theme_flush() on each of them.
3532     */
3533    EAPI void             elm_theme_full_flush(void);
3534    /**
3535     * Set the theme for all elementary using applications on the current display
3536     *
3537     * @param theme The name of the theme to use. Format same as the ELM_THEME
3538     * environment variable.
3539     */
3540    EAPI void             elm_theme_all_set(const char *theme);
3541    /**
3542     * Return a list of theme elements in the theme search path
3543     *
3544     * @return A list of strings that are the theme element names.
3545     *
3546     * This lists all available theme files in the standard Elementary search path
3547     * for theme elements, and returns them in alphabetical order as theme
3548     * element names in a list of strings. Free this with
3549     * elm_theme_name_available_list_free() when you are done with the list.
3550     */
3551    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3552    /**
3553     * Free the list returned by elm_theme_name_available_list_new()
3554     *
3555     * This frees the list of themes returned by
3556     * elm_theme_name_available_list_new(). Once freed the list should no longer
3557     * be used. a new list mys be created.
3558     */
3559    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3560    /**
3561     * Set a specific theme to be used for this object and its children
3562     *
3563     * @param obj The object to set the theme on
3564     * @param th The theme to set
3565     *
3566     * This sets a specific theme that will be used for the given object and any
3567     * child objects it has. If @p th is NULL then the theme to be used is
3568     * cleared and the object will inherit its theme from its parent (which
3569     * ultimately will use the default theme if no specific themes are set).
3570     *
3571     * Use special themes with great care as this will annoy users and make
3572     * configuration difficult. Avoid any custom themes at all if it can be
3573     * helped.
3574     */
3575    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3576    /**
3577     * Get the specific theme to be used
3578     *
3579     * @param obj The object to get the specific theme from
3580     * @return The specifc theme set.
3581     *
3582     * This will return a specific theme set, or NULL if no specific theme is
3583     * set on that object. It will not return inherited themes from parents, only
3584     * the specific theme set for that specific object. See elm_object_theme_set()
3585     * for more information.
3586     */
3587    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3588
3589    /**
3590     * Get a data item from a theme
3591     *
3592     * @param th The theme, or NULL for default theme
3593     * @param key The data key to search with
3594     * @return The data value, or NULL on failure
3595     *
3596     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3597     * It works the same way as edje_file_data_get() except that the return is stringshared.
3598     */
3599    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3600    /**
3601     * @}
3602     */
3603
3604    /* win */
3605    /** @defgroup Win Win
3606     *
3607     * @image html img/widget/win/preview-00.png
3608     * @image latex img/widget/win/preview-00.eps
3609     *
3610     * The window class of Elementary.  Contains functions to manipulate
3611     * windows. The Evas engine used to render the window contents is specified
3612     * in the system or user elementary config files (whichever is found last),
3613     * and can be overridden with the ELM_ENGINE environment variable for
3614     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3615     * compilation setup and modules actually installed at runtime) are (listed
3616     * in order of best supported and most likely to be complete and work to
3617     * lowest quality).
3618     *
3619     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3620     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3621     * rendering in X11)
3622     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3623     * exits)
3624     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3625     * rendering)
3626     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3627     * buffer)
3628     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3629     * rendering using SDL as the buffer)
3630     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3631     * GDI with software)
3632     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3633     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3634     * grayscale using dedicated 8bit software engine in X11)
3635     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3636     * X11 using 16bit software engine)
3637     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3638     * (Windows CE rendering via GDI with 16bit software renderer)
3639     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3640     * buffer with 16bit software renderer)
3641     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3642     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3643     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3644     *
3645     * All engines use a simple string to select the engine to render, EXCEPT
3646     * the "shot" engine. This actually encodes the output of the virtual
3647     * screenshot and how long to delay in the engine string. The engine string
3648     * is encoded in the following way:
3649     *
3650     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3651     *
3652     * Where options are separated by a ":" char if more than one option is
3653     * given, with delay, if provided being the first option and file the last
3654     * (order is important). The delay specifies how long to wait after the
3655     * window is shown before doing the virtual "in memory" rendering and then
3656     * save the output to the file specified by the file option (and then exit).
3657     * If no delay is given, the default is 0.5 seconds. If no file is given the
3658     * default output file is "out.png". Repeat option is for continous
3659     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3660     * fixed to "out001.png" Some examples of using the shot engine:
3661     *
3662     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3663     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3664     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3665     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3666     *   ELM_ENGINE="shot:" elementary_test
3667     *
3668     * Signals that you can add callbacks for are:
3669     *
3670     * @li "delete,request": the user requested to close the window. See
3671     * elm_win_autodel_set().
3672     * @li "focus,in": window got focus
3673     * @li "focus,out": window lost focus
3674     * @li "moved": window that holds the canvas was moved
3675     *
3676     * Examples:
3677     * @li @ref win_example_01
3678     *
3679     * @{
3680     */
3681    /**
3682     * Defines the types of window that can be created
3683     *
3684     * These are hints set on the window so that a running Window Manager knows
3685     * how the window should be handled and/or what kind of decorations it
3686     * should have.
3687     *
3688     * Currently, only the X11 backed engines use them.
3689     */
3690    typedef enum _Elm_Win_Type
3691      {
3692         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3693                          window. Almost every window will be created with this
3694                          type. */
3695         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3696         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3697                            window holding desktop icons. */
3698         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3699                         be kept on top of any other window by the Window
3700                         Manager. */
3701         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3702                            similar. */
3703         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3704         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3705                            pallete. */
3706         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3707         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3708                                  entry in a menubar is clicked. Typically used
3709                                  with elm_win_override_set(). This hint exists
3710                                  for completion only, as the EFL way of
3711                                  implementing a menu would not normally use a
3712                                  separate window for its contents. */
3713         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3714                               triggered by right-clicking an object. */
3715         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3716                            explanatory text that typically appear after the
3717                            mouse cursor hovers over an object for a while.
3718                            Typically used with elm_win_override_set() and also
3719                            not very commonly used in the EFL. */
3720         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3721                                 battery life or a new E-Mail received. */
3722         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3723                          usually used in the EFL. */
3724         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3725                        object being dragged across different windows, or even
3726                        applications. Typically used with
3727                        elm_win_override_set(). */
3728         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3729                                  buffer. No actual window is created for this
3730                                  type, instead the window and all of its
3731                                  contents will be rendered to an image buffer.
3732                                  This allows to have children window inside a
3733                                  parent one just like any other object would
3734                                  be, and do other things like applying @c
3735                                  Evas_Map effects to it. This is the only type
3736                                  of window that requires the @c parent
3737                                  parameter of elm_win_add() to be a valid @c
3738                                  Evas_Object. */
3739      } Elm_Win_Type;
3740
3741    /**
3742     * The differents layouts that can be requested for the virtual keyboard.
3743     *
3744     * When the application window is being managed by Illume, it may request
3745     * any of the following layouts for the virtual keyboard.
3746     */
3747    typedef enum _Elm_Win_Keyboard_Mode
3748      {
3749         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3750         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3751         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3752         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3753         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3754         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3755         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3756         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3757         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3758         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3759         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3760         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3761         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3762         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3763         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3764         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3765      } Elm_Win_Keyboard_Mode;
3766
3767    /**
3768     * Available commands that can be sent to the Illume manager.
3769     *
3770     * When running under an Illume session, a window may send commands to the
3771     * Illume manager to perform different actions.
3772     */
3773    typedef enum _Elm_Illume_Command
3774      {
3775         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3776                                          window */
3777         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3778                                             in the list */
3779         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3780                                          screen */
3781         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3782      } Elm_Illume_Command;
3783
3784    /**
3785     * Adds a window object. If this is the first window created, pass NULL as
3786     * @p parent.
3787     *
3788     * @param parent Parent object to add the window to, or NULL
3789     * @param name The name of the window
3790     * @param type The window type, one of #Elm_Win_Type.
3791     *
3792     * The @p parent paramter can be @c NULL for every window @p type except
3793     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3794     * which the image object will be created.
3795     *
3796     * @return The created object, or NULL on failure
3797     */
3798    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3799    /**
3800     * Adds a window object with standard setup
3801     *
3802     * @param name The name of the window
3803     * @param title The title for the window
3804     *
3805     * This creates a window like elm_win_add() but also puts in a standard
3806     * background with elm_bg_add(), as well as setting the window title to
3807     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3808     * as the parent widget.
3809     * 
3810     * @return The created object, or NULL on failure
3811     *
3812     * @see elm_win_add()
3813     */
3814    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3815    /**
3816     * Add @p subobj as a resize object of window @p obj.
3817     *
3818     *
3819     * Setting an object as a resize object of the window means that the
3820     * @p subobj child's size and position will be controlled by the window
3821     * directly. That is, the object will be resized to match the window size
3822     * and should never be moved or resized manually by the developer.
3823     *
3824     * In addition, resize objects of the window control what the minimum size
3825     * of it will be, as well as whether it can or not be resized by the user.
3826     *
3827     * For the end user to be able to resize a window by dragging the handles
3828     * or borders provided by the Window Manager, or using any other similar
3829     * mechanism, all of the resize objects in the window should have their
3830     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3831     *
3832     * @param obj The window object
3833     * @param subobj The resize object to add
3834     */
3835    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3836    /**
3837     * Delete @p subobj as a resize object of window @p obj.
3838     *
3839     * This function removes the object @p subobj from the resize objects of
3840     * the window @p obj. It will not delete the object itself, which will be
3841     * left unmanaged and should be deleted by the developer, manually handled
3842     * or set as child of some other container.
3843     *
3844     * @param obj The window object
3845     * @param subobj The resize object to add
3846     */
3847    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3848    /**
3849     * Set the title of the window
3850     *
3851     * @param obj The window object
3852     * @param title The title to set
3853     */
3854    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3855    /**
3856     * Get the title of the window
3857     *
3858     * The returned string is an internal one and should not be freed or
3859     * modified. It will also be rendered invalid if a new title is set or if
3860     * the window is destroyed.
3861     *
3862     * @param obj The window object
3863     * @return The title
3864     */
3865    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3866    /**
3867     * Set the window's autodel state.
3868     *
3869     * When closing the window in any way outside of the program control, like
3870     * pressing the X button in the titlebar or using a command from the
3871     * Window Manager, a "delete,request" signal is emitted to indicate that
3872     * this event occurred and the developer can take any action, which may
3873     * include, or not, destroying the window object.
3874     *
3875     * When the @p autodel parameter is set, the window will be automatically
3876     * destroyed when this event occurs, after the signal is emitted.
3877     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3878     * and is up to the program to do so when it's required.
3879     *
3880     * @param obj The window object
3881     * @param autodel If true, the window will automatically delete itself when
3882     * closed
3883     */
3884    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3885    /**
3886     * Get the window's autodel state.
3887     *
3888     * @param obj The window object
3889     * @return If the window will automatically delete itself when closed
3890     *
3891     * @see elm_win_autodel_set()
3892     */
3893    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3894    /**
3895     * Activate a window object.
3896     *
3897     * This function sends a request to the Window Manager to activate the
3898     * window pointed by @p obj. If honored by the WM, the window will receive
3899     * the keyboard focus.
3900     *
3901     * @note This is just a request that a Window Manager may ignore, so calling
3902     * this function does not ensure in any way that the window will be the
3903     * active one after it.
3904     *
3905     * @param obj The window object
3906     */
3907    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3908    /**
3909     * Lower a window object.
3910     *
3911     * Places the window pointed by @p obj at the bottom of the stack, so that
3912     * no other window is covered by it.
3913     *
3914     * If elm_win_override_set() is not set, the Window Manager may ignore this
3915     * request.
3916     *
3917     * @param obj The window object
3918     */
3919    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3920    /**
3921     * Raise a window object.
3922     *
3923     * Places the window pointed by @p obj at the top of the stack, so that it's
3924     * not covered by any other window.
3925     *
3926     * If elm_win_override_set() is not set, the Window Manager may ignore this
3927     * request.
3928     *
3929     * @param obj The window object
3930     */
3931    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3932    /**
3933     * Set the borderless state of a window.
3934     *
3935     * This function requests the Window Manager to not draw any decoration
3936     * around the window.
3937     *
3938     * @param obj The window object
3939     * @param borderless If true, the window is borderless
3940     */
3941    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3942    /**
3943     * Get the borderless state of a window.
3944     *
3945     * @param obj The window object
3946     * @return If true, the window is borderless
3947     */
3948    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3949    /**
3950     * Set the shaped state of a window.
3951     *
3952     * Shaped windows, when supported, will render the parts of the window that
3953     * has no content, transparent.
3954     *
3955     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3956     * background object or cover the entire window in any other way, or the
3957     * parts of the canvas that have no data will show framebuffer artifacts.
3958     *
3959     * @param obj The window object
3960     * @param shaped If true, the window is shaped
3961     *
3962     * @see elm_win_alpha_set()
3963     */
3964    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3965    /**
3966     * Get the shaped state of a window.
3967     *
3968     * @param obj The window object
3969     * @return If true, the window is shaped
3970     *
3971     * @see elm_win_shaped_set()
3972     */
3973    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3974    /**
3975     * Set the alpha channel state of a window.
3976     *
3977     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3978     * possibly making parts of the window completely or partially transparent.
3979     * This is also subject to the underlying system supporting it, like for
3980     * example, running under a compositing manager. If no compositing is
3981     * available, enabling this option will instead fallback to using shaped
3982     * windows, with elm_win_shaped_set().
3983     *
3984     * @param obj The window object
3985     * @param alpha If true, the window has an alpha channel
3986     *
3987     * @see elm_win_alpha_set()
3988     */
3989    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3990    /**
3991     * Get the transparency state of a window.
3992     *
3993     * @param obj The window object
3994     * @return If true, the window is transparent
3995     *
3996     * @see elm_win_transparent_set()
3997     */
3998    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3999    /**
4000     * Set the transparency state of a window.
4001     *
4002     * Use elm_win_alpha_set() instead.
4003     *
4004     * @param obj The window object
4005     * @param transparent If true, the window is transparent
4006     *
4007     * @see elm_win_alpha_set()
4008     */
4009    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4010    /**
4011     * Get the alpha channel state of a window.
4012     *
4013     * @param obj The window object
4014     * @return If true, the window has an alpha channel
4015     */
4016    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4017    /**
4018     * Set the override state of a window.
4019     *
4020     * A window with @p override set to EINA_TRUE will not be managed by the
4021     * Window Manager. This means that no decorations of any kind will be shown
4022     * for it, moving and resizing must be handled by the application, as well
4023     * as the window visibility.
4024     *
4025     * This should not be used for normal windows, and even for not so normal
4026     * ones, it should only be used when there's a good reason and with a lot
4027     * of care. Mishandling override windows may result situations that
4028     * disrupt the normal workflow of the end user.
4029     *
4030     * @param obj The window object
4031     * @param override If true, the window is overridden
4032     */
4033    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4034    /**
4035     * Get the override state of a window.
4036     *
4037     * @param obj The window object
4038     * @return If true, the window is overridden
4039     *
4040     * @see elm_win_override_set()
4041     */
4042    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4043    /**
4044     * Set the fullscreen state of a window.
4045     *
4046     * @param obj The window object
4047     * @param fullscreen If true, the window is fullscreen
4048     */
4049    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4050    /**
4051     * Get the fullscreen state of a window.
4052     *
4053     * @param obj The window object
4054     * @return If true, the window is fullscreen
4055     */
4056    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4057    /**
4058     * Set the maximized state of a window.
4059     *
4060     * @param obj The window object
4061     * @param maximized If true, the window is maximized
4062     */
4063    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4064    /**
4065     * Get the maximized state of a window.
4066     *
4067     * @param obj The window object
4068     * @return If true, the window is maximized
4069     */
4070    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4071    /**
4072     * Set the iconified state of a window.
4073     *
4074     * @param obj The window object
4075     * @param iconified If true, the window is iconified
4076     */
4077    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4078    /**
4079     * Get the iconified state of a window.
4080     *
4081     * @param obj The window object
4082     * @return If true, the window is iconified
4083     */
4084    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4085    /**
4086     * Set the layer of the window.
4087     *
4088     * What this means exactly will depend on the underlying engine used.
4089     *
4090     * In the case of X11 backed engines, the value in @p layer has the
4091     * following meanings:
4092     * @li < 3: The window will be placed below all others.
4093     * @li > 5: The window will be placed above all others.
4094     * @li other: The window will be placed in the default layer.
4095     *
4096     * @param obj The window object
4097     * @param layer The layer of the window
4098     */
4099    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4100    /**
4101     * Get the layer of the window.
4102     *
4103     * @param obj The window object
4104     * @return The layer of the window
4105     *
4106     * @see elm_win_layer_set()
4107     */
4108    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4109    /**
4110     * Set the rotation of the window.
4111     *
4112     * Most engines only work with multiples of 90.
4113     *
4114     * This function is used to set the orientation of the window @p obj to
4115     * match that of the screen. The window itself will be resized to adjust
4116     * to the new geometry of its contents. If you want to keep the window size,
4117     * see elm_win_rotation_with_resize_set().
4118     *
4119     * @param obj The window object
4120     * @param rotation The rotation of the window, in degrees (0-360),
4121     * counter-clockwise.
4122     */
4123    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4124    /**
4125     * Rotates the window and resizes it.
4126     *
4127     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4128     * that they fit inside the current window geometry.
4129     *
4130     * @param obj The window object
4131     * @param layer The rotation of the window in degrees (0-360),
4132     * counter-clockwise.
4133     */
4134    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4135    /**
4136     * Get the rotation of the window.
4137     *
4138     * @param obj The window object
4139     * @return The rotation of the window in degrees (0-360)
4140     *
4141     * @see elm_win_rotation_set()
4142     * @see elm_win_rotation_with_resize_set()
4143     */
4144    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4145    /**
4146     * Set the sticky state of the window.
4147     *
4148     * Hints the Window Manager that the window in @p obj should be left fixed
4149     * at its position even when the virtual desktop it's on moves or changes.
4150     *
4151     * @param obj The window object
4152     * @param sticky If true, the window's sticky state is enabled
4153     */
4154    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4155    /**
4156     * Get the sticky state of the window.
4157     *
4158     * @param obj The window object
4159     * @return If true, the window's sticky state is enabled
4160     *
4161     * @see elm_win_sticky_set()
4162     */
4163    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4164    /**
4165     * Set if this window is an illume conformant window
4166     *
4167     * @param obj The window object
4168     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4169     */
4170    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4171    /**
4172     * Get if this window is an illume conformant window
4173     *
4174     * @param obj The window object
4175     * @return A boolean if this window is illume conformant or not
4176     */
4177    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4178    /**
4179     * Set a window to be an illume quickpanel window
4180     *
4181     * By default window objects are not quickpanel windows.
4182     *
4183     * @param obj The window object
4184     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4185     */
4186    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4187    /**
4188     * Get if this window is a quickpanel or not
4189     *
4190     * @param obj The window object
4191     * @return A boolean if this window is a quickpanel or not
4192     */
4193    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4194    /**
4195     * Set the major priority of a quickpanel window
4196     *
4197     * @param obj The window object
4198     * @param priority The major priority for this quickpanel
4199     */
4200    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4201    /**
4202     * Get the major priority of a quickpanel window
4203     *
4204     * @param obj The window object
4205     * @return The major priority of this quickpanel
4206     */
4207    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4208    /**
4209     * Set the minor priority of a quickpanel window
4210     *
4211     * @param obj The window object
4212     * @param priority The minor priority for this quickpanel
4213     */
4214    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4215    /**
4216     * Get the minor priority of a quickpanel window
4217     *
4218     * @param obj The window object
4219     * @return The minor priority of this quickpanel
4220     */
4221    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4222    /**
4223     * Set which zone this quickpanel should appear in
4224     *
4225     * @param obj The window object
4226     * @param zone The requested zone for this quickpanel
4227     */
4228    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4229    /**
4230     * Get which zone this quickpanel should appear in
4231     *
4232     * @param obj The window object
4233     * @return The requested zone for this quickpanel
4234     */
4235    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4236    /**
4237     * Set the window to be skipped by keyboard focus
4238     *
4239     * This sets the window to be skipped by normal keyboard input. This means
4240     * a window manager will be asked to not focus this window as well as omit
4241     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4242     *
4243     * Call this and enable it on a window BEFORE you show it for the first time,
4244     * otherwise it may have no effect.
4245     *
4246     * Use this for windows that have only output information or might only be
4247     * interacted with by the mouse or fingers, and never for typing input.
4248     * Be careful that this may have side-effects like making the window
4249     * non-accessible in some cases unless the window is specially handled. Use
4250     * this with care.
4251     *
4252     * @param obj The window object
4253     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4254     */
4255    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4256    /**
4257     * Send a command to the windowing environment
4258     *
4259     * This is intended to work in touchscreen or small screen device
4260     * environments where there is a more simplistic window management policy in
4261     * place. This uses the window object indicated to select which part of the
4262     * environment to control (the part that this window lives in), and provides
4263     * a command and an optional parameter structure (use NULL for this if not
4264     * needed).
4265     *
4266     * @param obj The window object that lives in the environment to control
4267     * @param command The command to send
4268     * @param params Optional parameters for the command
4269     */
4270    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4271    /**
4272     * Get the inlined image object handle
4273     *
4274     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4275     * then the window is in fact an evas image object inlined in the parent
4276     * canvas. You can get this object (be careful to not manipulate it as it
4277     * is under control of elementary), and use it to do things like get pixel
4278     * data, save the image to a file, etc.
4279     *
4280     * @param obj The window object to get the inlined image from
4281     * @return The inlined image object, or NULL if none exists
4282     */
4283    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4284    /**
4285     * Set the enabled status for the focus highlight in a window
4286     *
4287     * This function will enable or disable the focus highlight only for the
4288     * given window, regardless of the global setting for it
4289     *
4290     * @param obj The window where to enable the highlight
4291     * @param enabled The enabled value for the highlight
4292     */
4293    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4294    /**
4295     * Get the enabled value of the focus highlight for this window
4296     *
4297     * @param obj The window in which to check if the focus highlight is enabled
4298     *
4299     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4300     */
4301    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4302    /**
4303     * Set the style for the focus highlight on this window
4304     *
4305     * Sets the style to use for theming the highlight of focused objects on
4306     * the given window. If @p style is NULL, the default will be used.
4307     *
4308     * @param obj The window where to set the style
4309     * @param style The style to set
4310     */
4311    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4312    /**
4313     * Get the style set for the focus highlight object
4314     *
4315     * Gets the style set for this windows highilght object, or NULL if none
4316     * is set.
4317     *
4318     * @param obj The window to retrieve the highlights style from
4319     *
4320     * @return The style set or NULL if none was. Default is used in that case.
4321     */
4322    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4323    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4324    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4325    /*...
4326     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4327     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4328     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4329     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4330     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4331     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4332     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4333     *
4334     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4335     * (blank mouse, private mouse obj, defaultmouse)
4336     *
4337     */
4338    /**
4339     * Sets the keyboard mode of the window.
4340     *
4341     * @param obj The window object
4342     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4343     */
4344    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4345    /**
4346     * Gets the keyboard mode of the window.
4347     *
4348     * @param obj The window object
4349     * @return The mode, one of #Elm_Win_Keyboard_Mode
4350     */
4351    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4352    /**
4353     * Sets whether the window is a keyboard.
4354     *
4355     * @param obj The window object
4356     * @param is_keyboard If true, the window is a virtual keyboard
4357     */
4358    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4359    /**
4360     * Gets whether the window is a keyboard.
4361     *
4362     * @param obj The window object
4363     * @return If the window is a virtual keyboard
4364     */
4365    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4366
4367    /**
4368     * Get the screen position of a window.
4369     *
4370     * @param obj The window object
4371     * @param x The int to store the x coordinate to
4372     * @param y The int to store the y coordinate to
4373     */
4374    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4375    /**
4376     * @}
4377     */
4378
4379    /**
4380     * @defgroup Inwin Inwin
4381     *
4382     * @image html img/widget/inwin/preview-00.png
4383     * @image latex img/widget/inwin/preview-00.eps
4384     * @image html img/widget/inwin/preview-01.png
4385     * @image latex img/widget/inwin/preview-01.eps
4386     * @image html img/widget/inwin/preview-02.png
4387     * @image latex img/widget/inwin/preview-02.eps
4388     *
4389     * An inwin is a window inside a window that is useful for a quick popup.
4390     * It does not hover.
4391     *
4392     * It works by creating an object that will occupy the entire window, so it
4393     * must be created using an @ref Win "elm_win" as parent only. The inwin
4394     * object can be hidden or restacked below every other object if it's
4395     * needed to show what's behind it without destroying it. If this is done,
4396     * the elm_win_inwin_activate() function can be used to bring it back to
4397     * full visibility again.
4398     *
4399     * There are three styles available in the default theme. These are:
4400     * @li default: The inwin is sized to take over most of the window it's
4401     * placed in.
4402     * @li minimal: The size of the inwin will be the minimum necessary to show
4403     * its contents.
4404     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4405     * possible, but it's sized vertically the most it needs to fit its\
4406     * contents.
4407     *
4408     * Some examples of Inwin can be found in the following:
4409     * @li @ref inwin_example_01
4410     *
4411     * @{
4412     */
4413    /**
4414     * Adds an inwin to the current window
4415     *
4416     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4417     * Never call this function with anything other than the top-most window
4418     * as its parameter, unless you are fond of undefined behavior.
4419     *
4420     * After creating the object, the widget will set itself as resize object
4421     * for the window with elm_win_resize_object_add(), so when shown it will
4422     * appear to cover almost the entire window (how much of it depends on its
4423     * content and the style used). It must not be added into other container
4424     * objects and it needs not be moved or resized manually.
4425     *
4426     * @param parent The parent object
4427     * @return The new object or NULL if it cannot be created
4428     */
4429    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4430    /**
4431     * Activates an inwin object, ensuring its visibility
4432     *
4433     * This function will make sure that the inwin @p obj is completely visible
4434     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4435     * to the front. It also sets the keyboard focus to it, which will be passed
4436     * onto its content.
4437     *
4438     * The object's theme will also receive the signal "elm,action,show" with
4439     * source "elm".
4440     *
4441     * @param obj The inwin to activate
4442     */
4443    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4444    /**
4445     * Set the content of an inwin object.
4446     *
4447     * Once the content object is set, a previously set one will be deleted.
4448     * If you want to keep that old content object, use the
4449     * elm_win_inwin_content_unset() function.
4450     *
4451     * @param obj The inwin object
4452     * @param content The object to set as content
4453     */
4454    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4455    /**
4456     * Get the content of an inwin object.
4457     *
4458     * Return the content object which is set for this widget.
4459     *
4460     * The returned object is valid as long as the inwin is still alive and no
4461     * other content is set on it. Deleting the object will notify the inwin
4462     * about it and this one will be left empty.
4463     *
4464     * If you need to remove an inwin's content to be reused somewhere else,
4465     * see elm_win_inwin_content_unset().
4466     *
4467     * @param obj The inwin object
4468     * @return The content that is being used
4469     */
4470    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4471    /**
4472     * Unset the content of an inwin object.
4473     *
4474     * Unparent and return the content object which was set for this widget.
4475     *
4476     * @param obj The inwin object
4477     * @return The content that was being used
4478     */
4479    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4480    /**
4481     * @}
4482     */
4483    /* X specific calls - won't work on non-x engines (return 0) */
4484
4485    /**
4486     * Get the Ecore_X_Window of an Evas_Object
4487     *
4488     * @param obj The object
4489     *
4490     * @return The Ecore_X_Window of @p obj
4491     *
4492     * @ingroup Win
4493     */
4494    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4495
4496    /* smart callbacks called:
4497     * "delete,request" - the user requested to delete the window
4498     * "focus,in" - window got focus
4499     * "focus,out" - window lost focus
4500     * "moved" - window that holds the canvas was moved
4501     */
4502
4503    /**
4504     * @defgroup Bg Bg
4505     *
4506     * @image html img/widget/bg/preview-00.png
4507     * @image latex img/widget/bg/preview-00.eps
4508     *
4509     * @brief Background object, used for setting a solid color, image or Edje
4510     * group as background to a window or any container object.
4511     *
4512     * The bg object is used for setting a solid background to a window or
4513     * packing into any container object. It works just like an image, but has
4514     * some properties useful to a background, like setting it to tiled,
4515     * centered, scaled or stretched.
4516     * 
4517     * Default contents parts of the bg widget that you can use for are:
4518     * @li "elm.swallow.content" - overlay of the bg
4519     *
4520     * Here is some sample code using it:
4521     * @li @ref bg_01_example_page
4522     * @li @ref bg_02_example_page
4523     * @li @ref bg_03_example_page
4524     */
4525
4526    /* bg */
4527    typedef enum _Elm_Bg_Option
4528      {
4529         ELM_BG_OPTION_CENTER,  /**< center the background */
4530         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4531         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4532         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4533      } Elm_Bg_Option;
4534
4535    /**
4536     * Add a new background to the parent
4537     *
4538     * @param parent The parent object
4539     * @return The new object or NULL if it cannot be created
4540     *
4541     * @ingroup Bg
4542     */
4543    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4544
4545    /**
4546     * Set the file (image or edje) used for the background
4547     *
4548     * @param obj The bg object
4549     * @param file The file path
4550     * @param group Optional key (group in Edje) within the file
4551     *
4552     * This sets the image file used in the background object. The image (or edje)
4553     * will be stretched (retaining aspect if its an image file) to completely fill
4554     * the bg object. This may mean some parts are not visible.
4555     *
4556     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4557     * even if @p file is NULL.
4558     *
4559     * @ingroup Bg
4560     */
4561    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4562
4563    /**
4564     * Get the file (image or edje) used for the background
4565     *
4566     * @param obj The bg object
4567     * @param file The file path
4568     * @param group Optional key (group in Edje) within the file
4569     *
4570     * @ingroup Bg
4571     */
4572    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4573
4574    /**
4575     * Set the option used for the background image
4576     *
4577     * @param obj The bg object
4578     * @param option The desired background option (TILE, SCALE)
4579     *
4580     * This sets the option used for manipulating the display of the background
4581     * image. The image can be tiled or scaled.
4582     *
4583     * @ingroup Bg
4584     */
4585    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4586
4587    /**
4588     * Get the option used for the background image
4589     *
4590     * @param obj The bg object
4591     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4592     *
4593     * @ingroup Bg
4594     */
4595    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4596    /**
4597     * Set the option used for the background color
4598     *
4599     * @param obj The bg object
4600     * @param r
4601     * @param g
4602     * @param b
4603     *
4604     * This sets the color used for the background rectangle. Its range goes
4605     * from 0 to 255.
4606     *
4607     * @ingroup Bg
4608     */
4609    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4610    /**
4611     * Get the option used for the background color
4612     *
4613     * @param obj The bg object
4614     * @param r
4615     * @param g
4616     * @param b
4617     *
4618     * @ingroup Bg
4619     */
4620    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4621
4622    /**
4623     * Set the overlay object used for the background object.
4624     *
4625     * @param obj The bg object
4626     * @param overlay The overlay object
4627     *
4628     * This provides a way for elm_bg to have an 'overlay' that will be on top
4629     * of the bg. Once the over object is set, a previously set one will be
4630     * deleted, even if you set the new one to NULL. If you want to keep that
4631     * old content object, use the elm_bg_overlay_unset() function.
4632     *
4633     * @deprecated use elm_object_content_set() instead
4634     *
4635     * @ingroup Bg
4636     */
4637
4638    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4639
4640    /**
4641     * Get the overlay object used for the background object.
4642     *
4643     * @param obj The bg object
4644     * @return The content that is being used
4645     *
4646     * Return the content object which is set for this widget
4647     *
4648     * @deprecated use elm_object_content_get() instead
4649     *
4650     * @ingroup Bg
4651     */
4652    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4653
4654    /**
4655     * Get the overlay object used for the background object.
4656     *
4657     * @param obj The bg object
4658     * @return The content that was being used
4659     *
4660     * Unparent and return the overlay object which was set for this widget
4661     *
4662     * @deprecated use elm_object_content_unset() instead
4663     *
4664     * @ingroup Bg
4665     */
4666    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4667
4668    /**
4669     * Set the size of the pixmap representation of the image.
4670     *
4671     * This option just makes sense if an image is going to be set in the bg.
4672     *
4673     * @param obj The bg object
4674     * @param w The new width of the image pixmap representation.
4675     * @param h The new height of the image pixmap representation.
4676     *
4677     * This function sets a new size for pixmap representation of the given bg
4678     * image. It allows the image to be loaded already in the specified size,
4679     * reducing the memory usage and load time when loading a big image with load
4680     * size set to a smaller size.
4681     *
4682     * NOTE: this is just a hint, the real size of the pixmap may differ
4683     * depending on the type of image being loaded, being bigger than requested.
4684     *
4685     * @ingroup Bg
4686     */
4687    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4688    /* smart callbacks called:
4689     */
4690
4691    /**
4692     * @defgroup Icon Icon
4693     *
4694     * @image html img/widget/icon/preview-00.png
4695     * @image latex img/widget/icon/preview-00.eps
4696     *
4697     * An object that provides standard icon images (delete, edit, arrows, etc.)
4698     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4699     *
4700     * The icon image requested can be in the elementary theme, or in the
4701     * freedesktop.org paths. It's possible to set the order of preference from
4702     * where the image will be used.
4703     *
4704     * This API is very similar to @ref Image, but with ready to use images.
4705     *
4706     * Default images provided by the theme are described below.
4707     *
4708     * The first list contains icons that were first intended to be used in
4709     * toolbars, but can be used in many other places too:
4710     * @li home
4711     * @li close
4712     * @li apps
4713     * @li arrow_up
4714     * @li arrow_down
4715     * @li arrow_left
4716     * @li arrow_right
4717     * @li chat
4718     * @li clock
4719     * @li delete
4720     * @li edit
4721     * @li refresh
4722     * @li folder
4723     * @li file
4724     *
4725     * Now some icons that were designed to be used in menus (but again, you can
4726     * use them anywhere else):
4727     * @li menu/home
4728     * @li menu/close
4729     * @li menu/apps
4730     * @li menu/arrow_up
4731     * @li menu/arrow_down
4732     * @li menu/arrow_left
4733     * @li menu/arrow_right
4734     * @li menu/chat
4735     * @li menu/clock
4736     * @li menu/delete
4737     * @li menu/edit
4738     * @li menu/refresh
4739     * @li menu/folder
4740     * @li menu/file
4741     *
4742     * And here we have some media player specific icons:
4743     * @li media_player/forward
4744     * @li media_player/info
4745     * @li media_player/next
4746     * @li media_player/pause
4747     * @li media_player/play
4748     * @li media_player/prev
4749     * @li media_player/rewind
4750     * @li media_player/stop
4751     *
4752     * Signals that you can add callbacks for are:
4753     *
4754     * "clicked" - This is called when a user has clicked the icon
4755     *
4756     * An example of usage for this API follows:
4757     * @li @ref tutorial_icon
4758     */
4759
4760    /**
4761     * @addtogroup Icon
4762     * @{
4763     */
4764
4765    typedef enum _Elm_Icon_Type
4766      {
4767         ELM_ICON_NONE,
4768         ELM_ICON_FILE,
4769         ELM_ICON_STANDARD
4770      } Elm_Icon_Type;
4771    /**
4772     * @enum _Elm_Icon_Lookup_Order
4773     * @typedef Elm_Icon_Lookup_Order
4774     *
4775     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4776     * theme, FDO paths, or both?
4777     *
4778     * @ingroup Icon
4779     */
4780    typedef enum _Elm_Icon_Lookup_Order
4781      {
4782         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4783         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4784         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4785         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4786      } Elm_Icon_Lookup_Order;
4787
4788    /**
4789     * Add a new icon object to the parent.
4790     *
4791     * @param parent The parent object
4792     * @return The new object or NULL if it cannot be created
4793     *
4794     * @see elm_icon_file_set()
4795     *
4796     * @ingroup Icon
4797     */
4798    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4799    /**
4800     * Set the file that will be used as icon.
4801     *
4802     * @param obj The icon object
4803     * @param file The path to file that will be used as icon image
4804     * @param group The group that the icon belongs to an edje file
4805     *
4806     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4807     *
4808     * @note The icon image set by this function can be changed by
4809     * elm_icon_standard_set().
4810     *
4811     * @see elm_icon_file_get()
4812     *
4813     * @ingroup Icon
4814     */
4815    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4816    /**
4817     * Set a location in memory to be used as an icon
4818     *
4819     * @param obj The icon object
4820     * @param img The binary data that will be used as an image
4821     * @param size The size of binary data @p img
4822     * @param format Optional format of @p img to pass to the image loader
4823     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4824     *
4825     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4826     *
4827     * @note The icon image set by this function can be changed by
4828     * elm_icon_standard_set().
4829     *
4830     * @ingroup Icon
4831     */
4832    EAPI Eina_Bool             elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key);  EINA_ARG_NONNULL(1, 2);
4833    /**
4834     * Get the file that will be used as icon.
4835     *
4836     * @param obj The icon object
4837     * @param file The path to file that will be used as the icon image
4838     * @param group The group that the icon belongs to, in edje file
4839     *
4840     * @see elm_icon_file_set()
4841     *
4842     * @ingroup Icon
4843     */
4844    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4845    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4846    /**
4847     * Set the icon by icon standards names.
4848     *
4849     * @param obj The icon object
4850     * @param name The icon name
4851     *
4852     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4853     *
4854     * For example, freedesktop.org defines standard icon names such as "home",
4855     * "network", etc. There can be different icon sets to match those icon
4856     * keys. The @p name given as parameter is one of these "keys", and will be
4857     * used to look in the freedesktop.org paths and elementary theme. One can
4858     * change the lookup order with elm_icon_order_lookup_set().
4859     *
4860     * If name is not found in any of the expected locations and it is the
4861     * absolute path of an image file, this image will be used.
4862     *
4863     * @note The icon image set by this function can be changed by
4864     * elm_icon_file_set().
4865     *
4866     * @see elm_icon_standard_get()
4867     * @see elm_icon_file_set()
4868     *
4869     * @ingroup Icon
4870     */
4871    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4872    /**
4873     * Get the icon name set by icon standard names.
4874     *
4875     * @param obj The icon object
4876     * @return The icon name
4877     *
4878     * If the icon image was set using elm_icon_file_set() instead of
4879     * elm_icon_standard_set(), then this function will return @c NULL.
4880     *
4881     * @see elm_icon_standard_set()
4882     *
4883     * @ingroup Icon
4884     */
4885    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4886    /**
4887     * Set the smooth scaling for an icon object.
4888     *
4889     * @param obj The icon object
4890     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4891     * otherwise. Default is @c EINA_TRUE.
4892     *
4893     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4894     * scaling provides a better resulting image, but is slower.
4895     *
4896     * The smooth scaling should be disabled when making animations that change
4897     * the icon size, since they will be faster. Animations that don't require
4898     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4899     * is already scaled, since the scaled icon image will be cached).
4900     *
4901     * @see elm_icon_smooth_get()
4902     *
4903     * @ingroup Icon
4904     */
4905    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4906    /**
4907     * Get whether smooth scaling is enabled for an icon object.
4908     *
4909     * @param obj The icon object
4910     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4911     *
4912     * @see elm_icon_smooth_set()
4913     *
4914     * @ingroup Icon
4915     */
4916    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4917    /**
4918     * Disable scaling of this object.
4919     *
4920     * @param obj The icon object.
4921     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4922     * otherwise. Default is @c EINA_FALSE.
4923     *
4924     * This function disables scaling of the icon object through the function
4925     * elm_object_scale_set(). However, this does not affect the object
4926     * size/resize in any way. For that effect, take a look at
4927     * elm_icon_scale_set().
4928     *
4929     * @see elm_icon_no_scale_get()
4930     * @see elm_icon_scale_set()
4931     * @see elm_object_scale_set()
4932     *
4933     * @ingroup Icon
4934     */
4935    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4936    /**
4937     * Get whether scaling is disabled on the object.
4938     *
4939     * @param obj The icon object
4940     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4941     *
4942     * @see elm_icon_no_scale_set()
4943     *
4944     * @ingroup Icon
4945     */
4946    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4947    /**
4948     * Set if the object is (up/down) resizable.
4949     *
4950     * @param obj The icon object
4951     * @param scale_up A bool to set if the object is resizable up. Default is
4952     * @c EINA_TRUE.
4953     * @param scale_down A bool to set if the object is resizable down. Default
4954     * is @c EINA_TRUE.
4955     *
4956     * This function limits the icon object resize ability. If @p scale_up is set to
4957     * @c EINA_FALSE, the object can't have its height or width resized to a value
4958     * higher than the original icon size. Same is valid for @p scale_down.
4959     *
4960     * @see elm_icon_scale_get()
4961     *
4962     * @ingroup Icon
4963     */
4964    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4965    /**
4966     * Get if the object is (up/down) resizable.
4967     *
4968     * @param obj The icon object
4969     * @param scale_up A bool to set if the object is resizable up
4970     * @param scale_down A bool to set if the object is resizable down
4971     *
4972     * @see elm_icon_scale_set()
4973     *
4974     * @ingroup Icon
4975     */
4976    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4977    /**
4978     * Get the object's image size
4979     *
4980     * @param obj The icon object
4981     * @param w A pointer to store the width in
4982     * @param h A pointer to store the height in
4983     *
4984     * @ingroup Icon
4985     */
4986    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4987    /**
4988     * Set if the icon fill the entire object area.
4989     *
4990     * @param obj The icon object
4991     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4992     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4993     *
4994     * When the icon object is resized to a different aspect ratio from the
4995     * original icon image, the icon image will still keep its aspect. This flag
4996     * tells how the image should fill the object's area. They are: keep the
4997     * entire icon inside the limits of height and width of the object (@p
4998     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4999     * of the object, and the icon will fill the entire object (@p fill_outside
5000     * is @c EINA_TRUE).
5001     *
5002     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5003     * retain property to false. Thus, the icon image will always keep its
5004     * original aspect ratio.
5005     *
5006     * @see elm_icon_fill_outside_get()
5007     * @see elm_image_fill_outside_set()
5008     *
5009     * @ingroup Icon
5010     */
5011    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5012    /**
5013     * Get if the object is filled outside.
5014     *
5015     * @param obj The icon object
5016     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5017     *
5018     * @see elm_icon_fill_outside_set()
5019     *
5020     * @ingroup Icon
5021     */
5022    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5023    /**
5024     * Set the prescale size for the icon.
5025     *
5026     * @param obj The icon object
5027     * @param size The prescale size. This value is used for both width and
5028     * height.
5029     *
5030     * This function sets a new size for pixmap representation of the given
5031     * icon. It allows the icon to be loaded already in the specified size,
5032     * reducing the memory usage and load time when loading a big icon with load
5033     * size set to a smaller size.
5034     *
5035     * It's equivalent to the elm_bg_load_size_set() function for bg.
5036     *
5037     * @note this is just a hint, the real size of the pixmap may differ
5038     * depending on the type of icon being loaded, being bigger than requested.
5039     *
5040     * @see elm_icon_prescale_get()
5041     * @see elm_bg_load_size_set()
5042     *
5043     * @ingroup Icon
5044     */
5045    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5046    /**
5047     * Get the prescale size for the icon.
5048     *
5049     * @param obj The icon object
5050     * @return The prescale size
5051     *
5052     * @see elm_icon_prescale_set()
5053     *
5054     * @ingroup Icon
5055     */
5056    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5057    /**
5058     * Gets the image object of the icon. DO NOT MODIFY THIS.
5059     *
5060     * @param obj The icon object
5061     * @return The internal icon object
5062     *
5063     * @ingroup Icon
5064     */
5065    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5066    /**
5067     * Sets the icon lookup order used by elm_icon_standard_set().
5068     *
5069     * @param obj The icon object
5070     * @param order The icon lookup order (can be one of
5071     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5072     * or ELM_ICON_LOOKUP_THEME)
5073     *
5074     * @see elm_icon_order_lookup_get()
5075     * @see Elm_Icon_Lookup_Order
5076     *
5077     * @ingroup Icon
5078     */
5079    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5080    /**
5081     * Gets the icon lookup order.
5082     *
5083     * @param obj The icon object
5084     * @return The icon lookup order
5085     *
5086     * @see elm_icon_order_lookup_set()
5087     * @see Elm_Icon_Lookup_Order
5088     *
5089     * @ingroup Icon
5090     */
5091    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5092    /**
5093     * Enable or disable preloading of the icon
5094     *
5095     * @param obj The icon object
5096     * @param disable If EINA_TRUE, preloading will be disabled
5097     * @ingroup Icon
5098     */
5099    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5100    /**
5101     * Get if the icon supports animation or not.
5102     *
5103     * @param obj The icon object
5104     * @return @c EINA_TRUE if the icon supports animation,
5105     *         @c EINA_FALSE otherwise.
5106     *
5107     * Return if this elm icon's image can be animated. Currently Evas only
5108     * supports gif animation. If the return value is EINA_FALSE, other
5109     * elm_icon_animated_XXX APIs won't work.
5110     * @ingroup Icon
5111     */
5112    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5113    /**
5114     * Set animation mode of the icon.
5115     *
5116     * @param obj The icon object
5117     * @param anim @c EINA_TRUE if the object do animation job,
5118     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5119     *
5120     * Since the default animation mode is set to EINA_FALSE, 
5121     * the icon is shown without animation.
5122     * This might be desirable when the application developer wants to show
5123     * a snapshot of the animated icon.
5124     * Set it to EINA_TRUE when the icon needs to be animated.
5125     * @ingroup Icon
5126     */
5127    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5128    /**
5129     * Get animation mode of the icon.
5130     *
5131     * @param obj The icon object
5132     * @return The animation mode of the icon object
5133     * @see elm_icon_animated_set
5134     * @ingroup Icon
5135     */
5136    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5137    /**
5138     * Set animation play mode of the icon.
5139     *
5140     * @param obj The icon object
5141     * @param play @c EINA_TRUE the object play animation images,
5142     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5143     *
5144     * To play elm icon's animation, set play to EINA_TURE.
5145     * For example, you make gif player using this set/get API and click event.
5146     *
5147     * 1. Click event occurs
5148     * 2. Check play flag using elm_icon_animaged_play_get
5149     * 3. If elm icon was playing, set play to EINA_FALSE.
5150     *    Then animation will be stopped and vice versa
5151     * @ingroup Icon
5152     */
5153    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5154    /**
5155     * Get animation play mode of the icon.
5156     *
5157     * @param obj The icon object
5158     * @return The play mode of the icon object
5159     *
5160     * @see elm_icon_animated_play_get
5161     * @ingroup Icon
5162     */
5163    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5164
5165    /* compatibility code to avoid API and ABI breaks */
5166    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5167      {
5168         elm_icon_animated_set(obj, animated);
5169      }
5170
5171    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5172      {
5173         return elm_icon_animated_get(obj);
5174      }
5175
5176    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5177      {
5178         elm_icon_animated_play_set(obj, play);
5179      }
5180
5181    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5182      {
5183         return elm_icon_animated_play_get(obj);
5184      }
5185
5186    /**
5187     * @}
5188     */
5189
5190    /**
5191     * @defgroup Image Image
5192     *
5193     * @image html img/widget/image/preview-00.png
5194     * @image latex img/widget/image/preview-00.eps
5195
5196     *
5197     * An object that allows one to load an image file to it. It can be used
5198     * anywhere like any other elementary widget.
5199     *
5200     * This widget provides most of the functionality provided from @ref Bg or @ref
5201     * Icon, but with a slightly different API (use the one that fits better your
5202     * needs).
5203     *
5204     * The features not provided by those two other image widgets are:
5205     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5206     * @li change the object orientation with elm_image_orient_set();
5207     * @li and turning the image editable with elm_image_editable_set().
5208     *
5209     * Signals that you can add callbacks for are:
5210     *
5211     * @li @c "clicked" - This is called when a user has clicked the image
5212     *
5213     * An example of usage for this API follows:
5214     * @li @ref tutorial_image
5215     */
5216
5217    /**
5218     * @addtogroup Image
5219     * @{
5220     */
5221
5222    /**
5223     * @enum _Elm_Image_Orient
5224     * @typedef Elm_Image_Orient
5225     *
5226     * Possible orientation options for elm_image_orient_set().
5227     *
5228     * @image html elm_image_orient_set.png
5229     * @image latex elm_image_orient_set.eps width=\textwidth
5230     *
5231     * @ingroup Image
5232     */
5233    typedef enum _Elm_Image_Orient
5234      {
5235         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5236         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5237         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5238         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5239         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5240         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5241         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5242         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5243      } Elm_Image_Orient;
5244
5245    /**
5246     * Add a new image to the parent.
5247     *
5248     * @param parent The parent object
5249     * @return The new object or NULL if it cannot be created
5250     *
5251     * @see elm_image_file_set()
5252     *
5253     * @ingroup Image
5254     */
5255    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5256    /**
5257     * Set the file that will be used as image.
5258     *
5259     * @param obj The image object
5260     * @param file The path to file that will be used as image
5261     * @param group The group that the image belongs in edje file (if it's an
5262     * edje image)
5263     *
5264     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5265     *
5266     * @see elm_image_file_get()
5267     *
5268     * @ingroup Image
5269     */
5270    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5271    /**
5272     * Get the file that will be used as image.
5273     *
5274     * @param obj The image object
5275     * @param file The path to file
5276     * @param group The group that the image belongs in edje file
5277     *
5278     * @see elm_image_file_set()
5279     *
5280     * @ingroup Image
5281     */
5282    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5283    /**
5284     * Set the smooth effect for an image.
5285     *
5286     * @param obj The image object
5287     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5288     * otherwise. Default is @c EINA_TRUE.
5289     *
5290     * Set the scaling algorithm to be used when scaling the image. Smooth
5291     * scaling provides a better resulting image, but is slower.
5292     *
5293     * The smooth scaling should be disabled when making animations that change
5294     * the image size, since it will be faster. Animations that don't require
5295     * resizing of the image can keep the smooth scaling enabled (even if the
5296     * image is already scaled, since the scaled image will be cached).
5297     *
5298     * @see elm_image_smooth_get()
5299     *
5300     * @ingroup Image
5301     */
5302    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5303    /**
5304     * Get the smooth effect for an image.
5305     *
5306     * @param obj The image object
5307     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5308     *
5309     * @see elm_image_smooth_get()
5310     *
5311     * @ingroup Image
5312     */
5313    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314
5315    /**
5316     * Gets the current size of the image.
5317     *
5318     * @param obj The image object.
5319     * @param w Pointer to store width, or NULL.
5320     * @param h Pointer to store height, or NULL.
5321     *
5322     * This is the real size of the image, not the size of the object.
5323     *
5324     * On error, neither w or h will be written.
5325     *
5326     * @ingroup Image
5327     */
5328    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5329    /**
5330     * Disable scaling of this object.
5331     *
5332     * @param obj The image object.
5333     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5334     * otherwise. Default is @c EINA_FALSE.
5335     *
5336     * This function disables scaling of the elm_image widget through the
5337     * function elm_object_scale_set(). However, this does not affect the widget
5338     * size/resize in any way. For that effect, take a look at
5339     * elm_image_scale_set().
5340     *
5341     * @see elm_image_no_scale_get()
5342     * @see elm_image_scale_set()
5343     * @see elm_object_scale_set()
5344     *
5345     * @ingroup Image
5346     */
5347    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5348    /**
5349     * Get whether scaling is disabled on the object.
5350     *
5351     * @param obj The image object
5352     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5353     *
5354     * @see elm_image_no_scale_set()
5355     *
5356     * @ingroup Image
5357     */
5358    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5359    /**
5360     * Set if the object is (up/down) resizable.
5361     *
5362     * @param obj The image object
5363     * @param scale_up A bool to set if the object is resizable up. Default is
5364     * @c EINA_TRUE.
5365     * @param scale_down A bool to set if the object is resizable down. Default
5366     * is @c EINA_TRUE.
5367     *
5368     * This function limits the image resize ability. If @p scale_up is set to
5369     * @c EINA_FALSE, the object can't have its height or width resized to a value
5370     * higher than the original image size. Same is valid for @p scale_down.
5371     *
5372     * @see elm_image_scale_get()
5373     *
5374     * @ingroup Image
5375     */
5376    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5377    /**
5378     * Get if the object is (up/down) resizable.
5379     *
5380     * @param obj The image object
5381     * @param scale_up A bool to set if the object is resizable up
5382     * @param scale_down A bool to set if the object is resizable down
5383     *
5384     * @see elm_image_scale_set()
5385     *
5386     * @ingroup Image
5387     */
5388    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5389    /**
5390     * Set if the image fills the entire object area, when keeping the aspect ratio.
5391     *
5392     * @param obj The image object
5393     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5394     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5395     *
5396     * When the image should keep its aspect ratio even if resized to another
5397     * aspect ratio, there are two possibilities to resize it: keep the entire
5398     * image inside the limits of height and width of the object (@p fill_outside
5399     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5400     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5401     *
5402     * @note This option will have no effect if
5403     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5404     *
5405     * @see elm_image_fill_outside_get()
5406     * @see elm_image_aspect_ratio_retained_set()
5407     *
5408     * @ingroup Image
5409     */
5410    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5411    /**
5412     * Get if the object is filled outside
5413     *
5414     * @param obj The image object
5415     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5416     *
5417     * @see elm_image_fill_outside_set()
5418     *
5419     * @ingroup Image
5420     */
5421    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5422    /**
5423     * Set the prescale size for the image
5424     *
5425     * @param obj The image object
5426     * @param size The prescale size. This value is used for both width and
5427     * height.
5428     *
5429     * This function sets a new size for pixmap representation of the given
5430     * image. It allows the image to be loaded already in the specified size,
5431     * reducing the memory usage and load time when loading a big image with load
5432     * size set to a smaller size.
5433     *
5434     * It's equivalent to the elm_bg_load_size_set() function for bg.
5435     *
5436     * @note this is just a hint, the real size of the pixmap may differ
5437     * depending on the type of image being loaded, being bigger than requested.
5438     *
5439     * @see elm_image_prescale_get()
5440     * @see elm_bg_load_size_set()
5441     *
5442     * @ingroup Image
5443     */
5444    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5445    /**
5446     * Get the prescale size for the image
5447     *
5448     * @param obj The image object
5449     * @return The prescale size
5450     *
5451     * @see elm_image_prescale_set()
5452     *
5453     * @ingroup Image
5454     */
5455    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5456    /**
5457     * Set the image orientation.
5458     *
5459     * @param obj The image object
5460     * @param orient The image orientation @ref Elm_Image_Orient
5461     *  Default is #ELM_IMAGE_ORIENT_NONE.
5462     *
5463     * This function allows to rotate or flip the given image.
5464     *
5465     * @see elm_image_orient_get()
5466     * @see @ref Elm_Image_Orient
5467     *
5468     * @ingroup Image
5469     */
5470    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5471    /**
5472     * Get the image orientation.
5473     *
5474     * @param obj The image object
5475     * @return The image orientation @ref Elm_Image_Orient
5476     *
5477     * @see elm_image_orient_set()
5478     * @see @ref Elm_Image_Orient
5479     *
5480     * @ingroup Image
5481     */
5482    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5483    /**
5484     * Make the image 'editable'.
5485     *
5486     * @param obj Image object.
5487     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5488     *
5489     * This means the image is a valid drag target for drag and drop, and can be
5490     * cut or pasted too.
5491     *
5492     * @ingroup Image
5493     */
5494    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5495    /**
5496     * Check if the image 'editable'.
5497     *
5498     * @param obj Image object.
5499     * @return Editability.
5500     *
5501     * A return value of EINA_TRUE means the image is a valid drag target
5502     * for drag and drop, and can be cut or pasted too.
5503     *
5504     * @ingroup Image
5505     */
5506    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507    /**
5508     * Get the basic Evas_Image object from this object (widget).
5509     *
5510     * @param obj The image object to get the inlined image from
5511     * @return The inlined image object, or NULL if none exists
5512     *
5513     * This function allows one to get the underlying @c Evas_Object of type
5514     * Image from this elementary widget. It can be useful to do things like get
5515     * the pixel data, save the image to a file, etc.
5516     *
5517     * @note Be careful to not manipulate it, as it is under control of
5518     * elementary.
5519     *
5520     * @ingroup Image
5521     */
5522    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5523    /**
5524     * Set whether the original aspect ratio of the image should be kept on resize.
5525     *
5526     * @param obj The image object.
5527     * @param retained @c EINA_TRUE if the image should retain the aspect,
5528     * @c EINA_FALSE otherwise.
5529     *
5530     * The original aspect ratio (width / height) of the image is usually
5531     * distorted to match the object's size. Enabling this option will retain
5532     * this original aspect, and the way that the image is fit into the object's
5533     * area depends on the option set by elm_image_fill_outside_set().
5534     *
5535     * @see elm_image_aspect_ratio_retained_get()
5536     * @see elm_image_fill_outside_set()
5537     *
5538     * @ingroup Image
5539     */
5540    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5541    /**
5542     * Get if the object retains the original aspect ratio.
5543     *
5544     * @param obj The image object.
5545     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5546     * otherwise.
5547     *
5548     * @ingroup Image
5549     */
5550    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5551
5552    /**
5553     * @}
5554     */
5555
5556    /* glview */
5557    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5558
5559    /* old API compatibility */
5560    typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5561
5562    typedef enum _Elm_GLView_Mode
5563      {
5564         ELM_GLVIEW_ALPHA   = 1,
5565         ELM_GLVIEW_DEPTH   = 2,
5566         ELM_GLVIEW_STENCIL = 4
5567      } Elm_GLView_Mode;
5568
5569    /**
5570     * Defines a policy for the glview resizing.
5571     *
5572     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5573     */
5574    typedef enum _Elm_GLView_Resize_Policy
5575      {
5576         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5577         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5578      } Elm_GLView_Resize_Policy;
5579
5580    typedef enum _Elm_GLView_Render_Policy
5581      {
5582         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5583         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5584      } Elm_GLView_Render_Policy;
5585
5586    /**
5587     * @defgroup GLView
5588     *
5589     * A simple GLView widget that allows GL rendering.
5590     *
5591     * Signals that you can add callbacks for are:
5592     *
5593     * @{
5594     */
5595
5596    /**
5597     * Add a new glview to the parent
5598     *
5599     * @param parent The parent object
5600     * @return The new object or NULL if it cannot be created
5601     *
5602     * @ingroup GLView
5603     */
5604    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5605
5606    /**
5607     * Sets the size of the glview
5608     *
5609     * @param obj The glview object
5610     * @param width width of the glview object
5611     * @param height height of the glview object
5612     *
5613     * @ingroup GLView
5614     */
5615    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5616
5617    /**
5618     * Gets the size of the glview.
5619     *
5620     * @param obj The glview object
5621     * @param width width of the glview object
5622     * @param height height of the glview object
5623     *
5624     * Note that this function returns the actual image size of the
5625     * glview.  This means that when the scale policy is set to
5626     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5627     * size.
5628     *
5629     * @ingroup GLView
5630     */
5631    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5632
5633    /**
5634     * Gets the gl api struct for gl rendering
5635     *
5636     * @param obj The glview object
5637     * @return The api object or NULL if it cannot be created
5638     *
5639     * @ingroup GLView
5640     */
5641    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5642
5643    /**
5644     * Set the mode of the GLView. Supports Three simple modes.
5645     *
5646     * @param obj The glview object
5647     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5648     * @return True if set properly.
5649     *
5650     * @ingroup GLView
5651     */
5652    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5653
5654    /**
5655     * Set the resize policy for the glview object.
5656     *
5657     * @param obj The glview object.
5658     * @param policy The scaling policy.
5659     *
5660     * By default, the resize policy is set to
5661     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5662     * destroys the previous surface and recreates the newly specified
5663     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5664     * however, glview only scales the image object and not the underlying
5665     * GL Surface.
5666     *
5667     * @ingroup GLView
5668     */
5669    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5670
5671    /**
5672     * Set the render policy for the glview object.
5673     *
5674     * @param obj The glview object.
5675     * @param policy The render policy.
5676     *
5677     * By default, the render policy is set to
5678     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5679     * that during the render loop, glview is only redrawn if it needs
5680     * to be redrawn. (i.e. When it is visible) If the policy is set to
5681     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5682     * whether it is visible/need redrawing or not.
5683     *
5684     * @ingroup GLView
5685     */
5686    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5687
5688    /**
5689     * Set the init function that runs once in the main loop.
5690     *
5691     * @param obj The glview object.
5692     * @param func The init function to be registered.
5693     *
5694     * The registered init function gets called once during the render loop.
5695     *
5696     * @ingroup GLView
5697     */
5698    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5699
5700    /**
5701     * Set the render function that runs in the main loop.
5702     *
5703     * @param obj The glview object.
5704     * @param func The delete function to be registered.
5705     *
5706     * The registered del function gets called when GLView object is deleted.
5707     *
5708     * @ingroup GLView
5709     */
5710    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5711
5712    /**
5713     * Set the resize function that gets called when resize happens.
5714     *
5715     * @param obj The glview object.
5716     * @param func The resize function to be registered.
5717     *
5718     * @ingroup GLView
5719     */
5720    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5721
5722    /**
5723     * Set the render function that runs in the main loop.
5724     *
5725     * @param obj The glview object.
5726     * @param func The render function to be registered.
5727     *
5728     * @ingroup GLView
5729     */
5730    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5731
5732    /**
5733     * Notifies that there has been changes in the GLView.
5734     *
5735     * @param obj The glview object.
5736     *
5737     * @ingroup GLView
5738     */
5739    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5740
5741    /**
5742     * @}
5743     */
5744
5745    /* box */
5746    /**
5747     * @defgroup Box Box
5748     *
5749     * @image html img/widget/box/preview-00.png
5750     * @image latex img/widget/box/preview-00.eps width=\textwidth
5751     *
5752     * @image html img/box.png
5753     * @image latex img/box.eps width=\textwidth
5754     *
5755     * A box arranges objects in a linear fashion, governed by a layout function
5756     * that defines the details of this arrangement.
5757     *
5758     * By default, the box will use an internal function to set the layout to
5759     * a single row, either vertical or horizontal. This layout is affected
5760     * by a number of parameters, such as the homogeneous flag set by
5761     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5762     * elm_box_align_set() and the hints set to each object in the box.
5763     *
5764     * For this default layout, it's possible to change the orientation with
5765     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5766     * placing its elements ordered from top to bottom. When horizontal is set,
5767     * the order will go from left to right. If the box is set to be
5768     * homogeneous, every object in it will be assigned the same space, that
5769     * of the largest object. Padding can be used to set some spacing between
5770     * the cell given to each object. The alignment of the box, set with
5771     * elm_box_align_set(), determines how the bounding box of all the elements
5772     * will be placed within the space given to the box widget itself.
5773     *
5774     * The size hints of each object also affect how they are placed and sized
5775     * within the box. evas_object_size_hint_min_set() will give the minimum
5776     * size the object can have, and the box will use it as the basis for all
5777     * latter calculations. Elementary widgets set their own minimum size as
5778     * needed, so there's rarely any need to use it manually.
5779     *
5780     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5781     * used to tell whether the object will be allocated the minimum size it
5782     * needs or if the space given to it should be expanded. It's important
5783     * to realize that expanding the size given to the object is not the same
5784     * thing as resizing the object. It could very well end being a small
5785     * widget floating in a much larger empty space. If not set, the weight
5786     * for objects will normally be 0.0 for both axis, meaning the widget will
5787     * not be expanded. To take as much space possible, set the weight to
5788     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5789     *
5790     * Besides how much space each object is allocated, it's possible to control
5791     * how the widget will be placed within that space using
5792     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5793     * for both axis, meaning the object will be centered, but any value from
5794     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5795     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5796     * is -1.0, means the object will be resized to fill the entire space it
5797     * was allocated.
5798     *
5799     * In addition, customized functions to define the layout can be set, which
5800     * allow the application developer to organize the objects within the box
5801     * in any number of ways.
5802     *
5803     * The special elm_box_layout_transition() function can be used
5804     * to switch from one layout to another, animating the motion of the
5805     * children of the box.
5806     *
5807     * @note Objects should not be added to box objects using _add() calls.
5808     *
5809     * Some examples on how to use boxes follow:
5810     * @li @ref box_example_01
5811     * @li @ref box_example_02
5812     *
5813     * @{
5814     */
5815    /**
5816     * @typedef Elm_Box_Transition
5817     *
5818     * Opaque handler containing the parameters to perform an animated
5819     * transition of the layout the box uses.
5820     *
5821     * @see elm_box_transition_new()
5822     * @see elm_box_layout_set()
5823     * @see elm_box_layout_transition()
5824     */
5825    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5826
5827    /**
5828     * Add a new box to the parent
5829     *
5830     * By default, the box will be in vertical mode and non-homogeneous.
5831     *
5832     * @param parent The parent object
5833     * @return The new object or NULL if it cannot be created
5834     */
5835    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5836    /**
5837     * Set the horizontal orientation
5838     *
5839     * By default, box object arranges their contents vertically from top to
5840     * bottom.
5841     * By calling this function with @p horizontal as EINA_TRUE, the box will
5842     * become horizontal, arranging contents from left to right.
5843     *
5844     * @note This flag is ignored if a custom layout function is set.
5845     *
5846     * @param obj The box object
5847     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5848     * EINA_FALSE = vertical)
5849     */
5850    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5851    /**
5852     * Get the horizontal orientation
5853     *
5854     * @param obj The box object
5855     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5856     */
5857    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5858    /**
5859     * Set the box to arrange its children homogeneously
5860     *
5861     * If enabled, homogeneous layout makes all items the same size, according
5862     * to the size of the largest of its children.
5863     *
5864     * @note This flag is ignored if a custom layout function is set.
5865     *
5866     * @param obj The box object
5867     * @param homogeneous The homogeneous flag
5868     */
5869    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5870    /**
5871     * Get whether the box is using homogeneous mode or not
5872     *
5873     * @param obj The box object
5874     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5875     */
5876    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5877    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5878    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5879    /**
5880     * Add an object to the beginning of the pack list
5881     *
5882     * Pack @p subobj into the box @p obj, placing it first in the list of
5883     * children objects. The actual position the object will get on screen
5884     * depends on the layout used. If no custom layout is set, it will be at
5885     * the top or left, depending if the box is vertical or horizontal,
5886     * respectively.
5887     *
5888     * @param obj The box object
5889     * @param subobj The object to add to the box
5890     *
5891     * @see elm_box_pack_end()
5892     * @see elm_box_pack_before()
5893     * @see elm_box_pack_after()
5894     * @see elm_box_unpack()
5895     * @see elm_box_unpack_all()
5896     * @see elm_box_clear()
5897     */
5898    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5899    /**
5900     * Add an object at the end of the pack list
5901     *
5902     * Pack @p subobj into the box @p obj, placing it last in the list of
5903     * children objects. The actual position the object will get on screen
5904     * depends on the layout used. If no custom layout is set, it will be at
5905     * the bottom or right, depending if the box is vertical or horizontal,
5906     * respectively.
5907     *
5908     * @param obj The box object
5909     * @param subobj The object to add to the box
5910     *
5911     * @see elm_box_pack_start()
5912     * @see elm_box_pack_before()
5913     * @see elm_box_pack_after()
5914     * @see elm_box_unpack()
5915     * @see elm_box_unpack_all()
5916     * @see elm_box_clear()
5917     */
5918    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5919    /**
5920     * Adds an object to the box before the indicated object
5921     *
5922     * This will add the @p subobj to the box indicated before the object
5923     * indicated with @p before. If @p before is not already in the box, results
5924     * are undefined. Before means either to the left of the indicated object or
5925     * above it depending on orientation.
5926     *
5927     * @param obj The box object
5928     * @param subobj The object to add to the box
5929     * @param before The object before which to add it
5930     *
5931     * @see elm_box_pack_start()
5932     * @see elm_box_pack_end()
5933     * @see elm_box_pack_after()
5934     * @see elm_box_unpack()
5935     * @see elm_box_unpack_all()
5936     * @see elm_box_clear()
5937     */
5938    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5939    /**
5940     * Adds an object to the box after the indicated object
5941     *
5942     * This will add the @p subobj to the box indicated after the object
5943     * indicated with @p after. If @p after is not already in the box, results
5944     * are undefined. After means either to the right of the indicated object or
5945     * below it depending on orientation.
5946     *
5947     * @param obj The box object
5948     * @param subobj The object to add to the box
5949     * @param after The object after which to add it
5950     *
5951     * @see elm_box_pack_start()
5952     * @see elm_box_pack_end()
5953     * @see elm_box_pack_before()
5954     * @see elm_box_unpack()
5955     * @see elm_box_unpack_all()
5956     * @see elm_box_clear()
5957     */
5958    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5959    /**
5960     * Clear the box of all children
5961     *
5962     * Remove all the elements contained by the box, deleting the respective
5963     * objects.
5964     *
5965     * @param obj The box object
5966     *
5967     * @see elm_box_unpack()
5968     * @see elm_box_unpack_all()
5969     */
5970    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5971    /**
5972     * Unpack a box item
5973     *
5974     * Remove the object given by @p subobj from the box @p obj without
5975     * deleting it.
5976     *
5977     * @param obj The box object
5978     *
5979     * @see elm_box_unpack_all()
5980     * @see elm_box_clear()
5981     */
5982    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5983    /**
5984     * Remove all items from the box, without deleting them
5985     *
5986     * Clear the box from all children, but don't delete the respective objects.
5987     * If no other references of the box children exist, the objects will never
5988     * be deleted, and thus the application will leak the memory. Make sure
5989     * when using this function that you hold a reference to all the objects
5990     * in the box @p obj.
5991     *
5992     * @param obj The box object
5993     *
5994     * @see elm_box_clear()
5995     * @see elm_box_unpack()
5996     */
5997    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5998    /**
5999     * Retrieve a list of the objects packed into the box
6000     *
6001     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6002     * The order of the list corresponds to the packing order the box uses.
6003     *
6004     * You must free this list with eina_list_free() once you are done with it.
6005     *
6006     * @param obj The box object
6007     */
6008    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6009    /**
6010     * Set the space (padding) between the box's elements.
6011     *
6012     * Extra space in pixels that will be added between a box child and its
6013     * neighbors after its containing cell has been calculated. This padding
6014     * is set for all elements in the box, besides any possible padding that
6015     * individual elements may have through their size hints.
6016     *
6017     * @param obj The box object
6018     * @param horizontal The horizontal space between elements
6019     * @param vertical The vertical space between elements
6020     */
6021    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6022    /**
6023     * Get the space (padding) between the box's elements.
6024     *
6025     * @param obj The box object
6026     * @param horizontal The horizontal space between elements
6027     * @param vertical The vertical space between elements
6028     *
6029     * @see elm_box_padding_set()
6030     */
6031    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6032    /**
6033     * Set the alignment of the whole bouding box of contents.
6034     *
6035     * Sets how the bounding box containing all the elements of the box, after
6036     * their sizes and position has been calculated, will be aligned within
6037     * the space given for the whole box widget.
6038     *
6039     * @param obj The box object
6040     * @param horizontal The horizontal alignment of elements
6041     * @param vertical The vertical alignment of elements
6042     */
6043    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6044    /**
6045     * Get the alignment of the whole bouding box of contents.
6046     *
6047     * @param obj The box object
6048     * @param horizontal The horizontal alignment of elements
6049     * @param vertical The vertical alignment of elements
6050     *
6051     * @see elm_box_align_set()
6052     */
6053    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6054
6055    /**
6056     * Force the box to recalculate its children packing.
6057     *
6058     * If any children was added or removed, box will not calculate the
6059     * values immediately rather leaving it to the next main loop
6060     * iteration. While this is great as it would save lots of
6061     * recalculation, whenever you need to get the position of a just
6062     * added item you must force recalculate before doing so.
6063     *
6064     * @param obj The box object.
6065     */
6066    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6067
6068    /**
6069     * Set the layout defining function to be used by the box
6070     *
6071     * Whenever anything changes that requires the box in @p obj to recalculate
6072     * the size and position of its elements, the function @p cb will be called
6073     * to determine what the layout of the children will be.
6074     *
6075     * Once a custom function is set, everything about the children layout
6076     * is defined by it. The flags set by elm_box_horizontal_set() and
6077     * elm_box_homogeneous_set() no longer have any meaning, and the values
6078     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6079     * layout function to decide if they are used and how. These last two
6080     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6081     * passed to @p cb. The @c Evas_Object the function receives is not the
6082     * Elementary widget, but the internal Evas Box it uses, so none of the
6083     * functions described here can be used on it.
6084     *
6085     * Any of the layout functions in @c Evas can be used here, as well as the
6086     * special elm_box_layout_transition().
6087     *
6088     * The final @p data argument received by @p cb is the same @p data passed
6089     * here, and the @p free_data function will be called to free it
6090     * whenever the box is destroyed or another layout function is set.
6091     *
6092     * Setting @p cb to NULL will revert back to the default layout function.
6093     *
6094     * @param obj The box object
6095     * @param cb The callback function used for layout
6096     * @param data Data that will be passed to layout function
6097     * @param free_data Function called to free @p data
6098     *
6099     * @see elm_box_layout_transition()
6100     */
6101    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);
6102    /**
6103     * Special layout function that animates the transition from one layout to another
6104     *
6105     * Normally, when switching the layout function for a box, this will be
6106     * reflected immediately on screen on the next render, but it's also
6107     * possible to do this through an animated transition.
6108     *
6109     * This is done by creating an ::Elm_Box_Transition and setting the box
6110     * layout to this function.
6111     *
6112     * For example:
6113     * @code
6114     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6115     *                            evas_object_box_layout_vertical, // start
6116     *                            NULL, // data for initial layout
6117     *                            NULL, // free function for initial data
6118     *                            evas_object_box_layout_horizontal, // end
6119     *                            NULL, // data for final layout
6120     *                            NULL, // free function for final data
6121     *                            anim_end, // will be called when animation ends
6122     *                            NULL); // data for anim_end function\
6123     * elm_box_layout_set(box, elm_box_layout_transition, t,
6124     *                    elm_box_transition_free);
6125     * @endcode
6126     *
6127     * @note This function can only be used with elm_box_layout_set(). Calling
6128     * it directly will not have the expected results.
6129     *
6130     * @see elm_box_transition_new
6131     * @see elm_box_transition_free
6132     * @see elm_box_layout_set
6133     */
6134    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6135    /**
6136     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6137     *
6138     * If you want to animate the change from one layout to another, you need
6139     * to set the layout function of the box to elm_box_layout_transition(),
6140     * passing as user data to it an instance of ::Elm_Box_Transition with the
6141     * necessary information to perform this animation. The free function to
6142     * set for the layout is elm_box_transition_free().
6143     *
6144     * The parameters to create an ::Elm_Box_Transition sum up to how long
6145     * will it be, in seconds, a layout function to describe the initial point,
6146     * another for the final position of the children and one function to be
6147     * called when the whole animation ends. This last function is useful to
6148     * set the definitive layout for the box, usually the same as the end
6149     * layout for the animation, but could be used to start another transition.
6150     *
6151     * @param start_layout The layout function that will be used to start the animation
6152     * @param start_layout_data The data to be passed the @p start_layout function
6153     * @param start_layout_free_data Function to free @p start_layout_data
6154     * @param end_layout The layout function that will be used to end the animation
6155     * @param end_layout_free_data The data to be passed the @p end_layout function
6156     * @param end_layout_free_data Function to free @p end_layout_data
6157     * @param transition_end_cb Callback function called when animation ends
6158     * @param transition_end_data Data to be passed to @p transition_end_cb
6159     * @return An instance of ::Elm_Box_Transition
6160     *
6161     * @see elm_box_transition_new
6162     * @see elm_box_layout_transition
6163     */
6164    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);
6165    /**
6166     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6167     *
6168     * This function is mostly useful as the @c free_data parameter in
6169     * elm_box_layout_set() when elm_box_layout_transition().
6170     *
6171     * @param data The Elm_Box_Transition instance to be freed.
6172     *
6173     * @see elm_box_transition_new
6174     * @see elm_box_layout_transition
6175     */
6176    EAPI void                elm_box_transition_free(void *data);
6177    /**
6178     * @}
6179     */
6180
6181    /* button */
6182    /**
6183     * @defgroup Button Button
6184     *
6185     * @image html img/widget/button/preview-00.png
6186     * @image latex img/widget/button/preview-00.eps
6187     * @image html img/widget/button/preview-01.png
6188     * @image latex img/widget/button/preview-01.eps
6189     * @image html img/widget/button/preview-02.png
6190     * @image latex img/widget/button/preview-02.eps
6191     *
6192     * This is a push-button. Press it and run some function. It can contain
6193     * a simple label and icon object and it also has an autorepeat feature.
6194     *
6195     * This widgets emits the following signals:
6196     * @li "clicked": the user clicked the button (press/release).
6197     * @li "repeated": the user pressed the button without releasing it.
6198     * @li "pressed": button was pressed.
6199     * @li "unpressed": button was released after being pressed.
6200     * In all three cases, the @c event parameter of the callback will be
6201     * @c NULL.
6202     *
6203     * Also, defined in the default theme, the button has the following styles
6204     * available:
6205     * @li default: a normal button.
6206     * @li anchor: Like default, but the button fades away when the mouse is not
6207     * over it, leaving only the text or icon.
6208     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6209     * continuous look across its options.
6210     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6211     *
6212     * Default contents parts of the button widget that you can use for are:
6213     * @li "elm.swallow.content" - A icon of the button
6214     *
6215     * Default text parts of the button widget that you can use for are:
6216     * @li "elm.text" - Label of the button
6217     *
6218     * Follow through a complete example @ref button_example_01 "here".
6219     * @{
6220     */
6221
6222    typedef enum
6223      {
6224         UIControlStateDefault,
6225         UIControlStateHighlighted,
6226         UIControlStateDisabled,
6227         UIControlStateFocused,
6228         UIControlStateReserved
6229      } UIControlState;
6230
6231    /**
6232     * Add a new button to the parent's canvas
6233     *
6234     * @param parent The parent object
6235     * @return The new object or NULL if it cannot be created
6236     */
6237    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6238    /**
6239     * Set the label used in the button
6240     *
6241     * The passed @p label can be NULL to clean any existing text in it and
6242     * leave the button as an icon only object.
6243     *
6244     * @param obj The button object
6245     * @param label The text will be written on the button
6246     * @deprecated use elm_object_text_set() instead.
6247     */
6248    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6249    /**
6250     * Get the label set for the button
6251     *
6252     * The string returned is an internal pointer and should not be freed or
6253     * altered. It will also become invalid when the button is destroyed.
6254     * The string returned, if not NULL, is a stringshare, so if you need to
6255     * keep it around even after the button is destroyed, you can use
6256     * eina_stringshare_ref().
6257     *
6258     * @param obj The button object
6259     * @return The text set to the label, or NULL if nothing is set
6260     * @deprecated use elm_object_text_set() instead.
6261     */
6262    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6263    /**
6264     * Set the label for each state of button
6265     *
6266     * The passed @p label can be NULL to clean any existing text in it and
6267     * leave the button as an icon only object for the state.
6268     *
6269     * @param obj The button object
6270     * @param label The text will be written on the button
6271     * @param state The state of button
6272     *
6273     * @ingroup Button
6274     */
6275    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6276    /**
6277     * Get the label of button for each state
6278     *
6279     * The string returned is an internal pointer and should not be freed or
6280     * altered. It will also become invalid when the button is destroyed.
6281     * The string returned, if not NULL, is a stringshare, so if you need to
6282     * keep it around even after the button is destroyed, you can use
6283     * eina_stringshare_ref().
6284     *
6285     * @param obj The button object
6286     * @param state The state of button
6287     * @return The title of button for state
6288     *
6289     * @ingroup Button
6290     */
6291    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6292    /**
6293     * Set the icon used for the button
6294     *
6295     * Setting a new icon will delete any other that was previously set, making
6296     * any reference to them invalid. If you need to maintain the previous
6297     * object alive, unset it first with elm_button_icon_unset().
6298     *
6299     * @param obj The button object
6300     * @param icon The icon object for the button
6301     * @deprecated use elm_object_content_set() instead.
6302     */
6303    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6304    /**
6305     * Get the icon used for the button
6306     *
6307     * Return the icon object which is set for this widget. If the button is
6308     * destroyed or another icon is set, the returned object will be deleted
6309     * and any reference to it will be invalid.
6310     *
6311     * @param obj The button object
6312     * @return The icon object that is being used
6313     *
6314     * @deprecated use elm_button_icon_unset() instead
6315     */
6316    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6317    /**
6318     * Remove the icon set without deleting it and return the object
6319     *
6320     * This function drops the reference the button holds of the icon object
6321     * and returns this last object. It is used in case you want to remove any
6322     * icon, or set another one, without deleting the actual object. The button
6323     * will be left without an icon set.
6324     *
6325     * @param obj The button object
6326     * @return The icon object that was being used
6327     * @deprecated use elm_object_content_unset() instead.
6328     */
6329    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6330    /**
6331     * Turn on/off the autorepeat event generated when the button is kept pressed
6332     *
6333     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6334     * signal when they are clicked.
6335     *
6336     * When on, keeping a button pressed will continuously emit a @c repeated
6337     * signal until the button is released. The time it takes until it starts
6338     * emitting the signal is given by
6339     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6340     * new emission by elm_button_autorepeat_gap_timeout_set().
6341     *
6342     * @param obj The button object
6343     * @param on  A bool to turn on/off the event
6344     */
6345    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6346    /**
6347     * Get whether the autorepeat feature is enabled
6348     *
6349     * @param obj The button object
6350     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6351     *
6352     * @see elm_button_autorepeat_set()
6353     */
6354    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6355    /**
6356     * Set the initial timeout before the autorepeat event is generated
6357     *
6358     * Sets the timeout, in seconds, since the button is pressed until the
6359     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6360     * won't be any delay and the even will be fired the moment the button is
6361     * pressed.
6362     *
6363     * @param obj The button object
6364     * @param t   Timeout in seconds
6365     *
6366     * @see elm_button_autorepeat_set()
6367     * @see elm_button_autorepeat_gap_timeout_set()
6368     */
6369    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6370    /**
6371     * Get the initial timeout before the autorepeat event is generated
6372     *
6373     * @param obj The button object
6374     * @return Timeout in seconds
6375     *
6376     * @see elm_button_autorepeat_initial_timeout_set()
6377     */
6378    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6379    /**
6380     * Set the interval between each generated autorepeat event
6381     *
6382     * After the first @c repeated event is fired, all subsequent ones will
6383     * follow after a delay of @p t seconds for each.
6384     *
6385     * @param obj The button object
6386     * @param t   Interval in seconds
6387     *
6388     * @see elm_button_autorepeat_initial_timeout_set()
6389     */
6390    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6391    /**
6392     * Get the interval between each generated autorepeat event
6393     *
6394     * @param obj The button object
6395     * @return Interval in seconds
6396     */
6397    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6398    /**
6399     * @}
6400     */
6401
6402    /**
6403     * @defgroup File_Selector_Button File Selector Button
6404     *
6405     * @image html img/widget/fileselector_button/preview-00.png
6406     * @image latex img/widget/fileselector_button/preview-00.eps
6407     * @image html img/widget/fileselector_button/preview-01.png
6408     * @image latex img/widget/fileselector_button/preview-01.eps
6409     * @image html img/widget/fileselector_button/preview-02.png
6410     * @image latex img/widget/fileselector_button/preview-02.eps
6411     *
6412     * This is a button that, when clicked, creates an Elementary
6413     * window (or inner window) <b> with a @ref Fileselector "file
6414     * selector widget" within</b>. When a file is chosen, the (inner)
6415     * window is closed and the button emits a signal having the
6416     * selected file as it's @c event_info.
6417     *
6418     * This widget encapsulates operations on its internal file
6419     * selector on its own API. There is less control over its file
6420     * selector than that one would have instatiating one directly.
6421     *
6422     * The following styles are available for this button:
6423     * @li @c "default"
6424     * @li @c "anchor"
6425     * @li @c "hoversel_vertical"
6426     * @li @c "hoversel_vertical_entry"
6427     *
6428     * Smart callbacks one can register to:
6429     * - @c "file,chosen" - the user has selected a path, whose string
6430     *   pointer comes as the @c event_info data (a stringshared
6431     *   string)
6432     *
6433     * Here is an example on its usage:
6434     * @li @ref fileselector_button_example
6435     *
6436     * @see @ref File_Selector_Entry for a similar widget.
6437     * @{
6438     */
6439
6440    /**
6441     * Add a new file selector button widget to the given parent
6442     * Elementary (container) object
6443     *
6444     * @param parent The parent object
6445     * @return a new file selector button widget handle or @c NULL, on
6446     * errors
6447     */
6448    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6449
6450    /**
6451     * Set the label for a given file selector button widget
6452     *
6453     * @param obj The file selector button widget
6454     * @param label The text label to be displayed on @p obj
6455     *
6456     * @deprecated use elm_object_text_set() instead.
6457     */
6458    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6459
6460    /**
6461     * Get the label set for a given file selector button widget
6462     *
6463     * @param obj The file selector button widget
6464     * @return The button label
6465     *
6466     * @deprecated use elm_object_text_set() instead.
6467     */
6468    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6469
6470    /**
6471     * Set the icon on a given file selector button widget
6472     *
6473     * @param obj The file selector button widget
6474     * @param icon The icon object for the button
6475     *
6476     * Once the icon object is set, a previously set one will be
6477     * deleted. If you want to keep the latter, use the
6478     * elm_fileselector_button_icon_unset() function.
6479     *
6480     * @see elm_fileselector_button_icon_get()
6481     */
6482    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6483
6484    /**
6485     * Get the icon set for a given file selector button widget
6486     *
6487     * @param obj The file selector button widget
6488     * @return The icon object currently set on @p obj or @c NULL, if
6489     * none is
6490     *
6491     * @see elm_fileselector_button_icon_set()
6492     */
6493    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6494
6495    /**
6496     * Unset the icon used in a given file selector button widget
6497     *
6498     * @param obj The file selector button widget
6499     * @return The icon object that was being used on @p obj or @c
6500     * NULL, on errors
6501     *
6502     * Unparent and return the icon object which was set for this
6503     * widget.
6504     *
6505     * @see elm_fileselector_button_icon_set()
6506     */
6507    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6508
6509    /**
6510     * Set the title for a given file selector button widget's window
6511     *
6512     * @param obj The file selector button widget
6513     * @param title The title string
6514     *
6515     * This will change the window's title, when the file selector pops
6516     * out after a click on the button. Those windows have the default
6517     * (unlocalized) value of @c "Select a file" as titles.
6518     *
6519     * @note It will only take any effect if the file selector
6520     * button widget is @b not under "inwin mode".
6521     *
6522     * @see elm_fileselector_button_window_title_get()
6523     */
6524    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6525
6526    /**
6527     * Get the title set for a given file selector button widget's
6528     * window
6529     *
6530     * @param obj The file selector button widget
6531     * @return Title of the file selector button's window
6532     *
6533     * @see elm_fileselector_button_window_title_get() for more details
6534     */
6535    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6536
6537    /**
6538     * Set the size of a given file selector button widget's window,
6539     * holding the file selector itself.
6540     *
6541     * @param obj The file selector button widget
6542     * @param width The window's width
6543     * @param height The window's height
6544     *
6545     * @note it will only take any effect if the file selector button
6546     * widget is @b not under "inwin mode". The default size for the
6547     * window (when applicable) is 400x400 pixels.
6548     *
6549     * @see elm_fileselector_button_window_size_get()
6550     */
6551    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6552
6553    /**
6554     * Get the size of a given file selector button widget's window,
6555     * holding the file selector itself.
6556     *
6557     * @param obj The file selector button widget
6558     * @param width Pointer into which to store the width value
6559     * @param height Pointer into which to store the height value
6560     *
6561     * @note Use @c NULL pointers on the size values you're not
6562     * interested in: they'll be ignored by the function.
6563     *
6564     * @see elm_fileselector_button_window_size_set(), for more details
6565     */
6566    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6567
6568    /**
6569     * Set the initial file system path for a given file selector
6570     * button widget
6571     *
6572     * @param obj The file selector button widget
6573     * @param path The path string
6574     *
6575     * It must be a <b>directory</b> path, which will have the contents
6576     * displayed initially in the file selector's view, when invoked
6577     * from @p obj. The default initial path is the @c "HOME"
6578     * environment variable's value.
6579     *
6580     * @see elm_fileselector_button_path_get()
6581     */
6582    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6583
6584    /**
6585     * Get the initial file system path set for a given file selector
6586     * button widget
6587     *
6588     * @param obj The file selector button widget
6589     * @return path The path string
6590     *
6591     * @see elm_fileselector_button_path_set() for more details
6592     */
6593    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6594
6595    /**
6596     * Enable/disable a tree view in the given file selector button
6597     * widget's internal file selector
6598     *
6599     * @param obj The file selector button widget
6600     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6601     * disable
6602     *
6603     * This has the same effect as elm_fileselector_expandable_set(),
6604     * but now applied to a file selector button's internal file
6605     * selector.
6606     *
6607     * @note There's no way to put a file selector button's internal
6608     * file selector in "grid mode", as one may do with "pure" file
6609     * selectors.
6610     *
6611     * @see elm_fileselector_expandable_get()
6612     */
6613    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6614
6615    /**
6616     * Get whether tree view is enabled for the given file selector
6617     * button widget's internal file selector
6618     *
6619     * @param obj The file selector button widget
6620     * @return @c EINA_TRUE if @p obj widget's internal file selector
6621     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6622     *
6623     * @see elm_fileselector_expandable_set() for more details
6624     */
6625    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6626
6627    /**
6628     * Set whether a given file selector button widget's internal file
6629     * selector is to display folders only or the directory contents,
6630     * as well.
6631     *
6632     * @param obj The file selector button widget
6633     * @param only @c EINA_TRUE to make @p obj widget's internal file
6634     * selector only display directories, @c EINA_FALSE to make files
6635     * to be displayed in it too
6636     *
6637     * This has the same effect as elm_fileselector_folder_only_set(),
6638     * but now applied to a file selector button's internal file
6639     * selector.
6640     *
6641     * @see elm_fileselector_folder_only_get()
6642     */
6643    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6644
6645    /**
6646     * Get whether a given file selector button widget's internal file
6647     * selector is displaying folders only or the directory contents,
6648     * as well.
6649     *
6650     * @param obj The file selector button widget
6651     * @return @c EINA_TRUE if @p obj widget's internal file
6652     * selector is only displaying directories, @c EINA_FALSE if files
6653     * are being displayed in it too (and on errors)
6654     *
6655     * @see elm_fileselector_button_folder_only_set() for more details
6656     */
6657    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6658
6659    /**
6660     * Enable/disable the file name entry box where the user can type
6661     * in a name for a file, in a given file selector button widget's
6662     * internal file selector.
6663     *
6664     * @param obj The file selector button widget
6665     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6666     * file selector a "saving dialog", @c EINA_FALSE otherwise
6667     *
6668     * This has the same effect as elm_fileselector_is_save_set(),
6669     * but now applied to a file selector button's internal file
6670     * selector.
6671     *
6672     * @see elm_fileselector_is_save_get()
6673     */
6674    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6675
6676    /**
6677     * Get whether the given file selector button widget's internal
6678     * file selector is in "saving dialog" mode
6679     *
6680     * @param obj The file selector button widget
6681     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6682     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6683     * errors)
6684     *
6685     * @see elm_fileselector_button_is_save_set() for more details
6686     */
6687    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6688
6689    /**
6690     * Set whether a given file selector button widget's internal file
6691     * selector will raise an Elementary "inner window", instead of a
6692     * dedicated Elementary window. By default, it won't.
6693     *
6694     * @param obj The file selector button widget
6695     * @param value @c EINA_TRUE to make it use an inner window, @c
6696     * EINA_TRUE to make it use a dedicated window
6697     *
6698     * @see elm_win_inwin_add() for more information on inner windows
6699     * @see elm_fileselector_button_inwin_mode_get()
6700     */
6701    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6702
6703    /**
6704     * Get whether a given file selector button widget's internal file
6705     * selector will raise an Elementary "inner window", instead of a
6706     * dedicated Elementary window.
6707     *
6708     * @param obj The file selector button widget
6709     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6710     * if it will use a dedicated window
6711     *
6712     * @see elm_fileselector_button_inwin_mode_set() for more details
6713     */
6714    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6715
6716    /**
6717     * @}
6718     */
6719
6720     /**
6721     * @defgroup File_Selector_Entry File Selector Entry
6722     *
6723     * @image html img/widget/fileselector_entry/preview-00.png
6724     * @image latex img/widget/fileselector_entry/preview-00.eps
6725     *
6726     * This is an entry made to be filled with or display a <b>file
6727     * system path string</b>. Besides the entry itself, the widget has
6728     * a @ref File_Selector_Button "file selector button" on its side,
6729     * which will raise an internal @ref Fileselector "file selector widget",
6730     * when clicked, for path selection aided by file system
6731     * navigation.
6732     *
6733     * This file selector may appear in an Elementary window or in an
6734     * inner window. When a file is chosen from it, the (inner) window
6735     * is closed and the selected file's path string is exposed both as
6736     * an smart event and as the new text on the entry.
6737     *
6738     * This widget encapsulates operations on its internal file
6739     * selector on its own API. There is less control over its file
6740     * selector than that one would have instatiating one directly.
6741     *
6742     * Smart callbacks one can register to:
6743     * - @c "changed" - The text within the entry was changed
6744     * - @c "activated" - The entry has had editing finished and
6745     *   changes are to be "committed"
6746     * - @c "press" - The entry has been clicked
6747     * - @c "longpressed" - The entry has been clicked (and held) for a
6748     *   couple seconds
6749     * - @c "clicked" - The entry has been clicked
6750     * - @c "clicked,double" - The entry has been double clicked
6751     * - @c "focused" - The entry has received focus
6752     * - @c "unfocused" - The entry has lost focus
6753     * - @c "selection,paste" - A paste action has occurred on the
6754     *   entry
6755     * - @c "selection,copy" - A copy action has occurred on the entry
6756     * - @c "selection,cut" - A cut action has occurred on the entry
6757     * - @c "unpressed" - The file selector entry's button was released
6758     *   after being pressed.
6759     * - @c "file,chosen" - The user has selected a path via the file
6760     *   selector entry's internal file selector, whose string pointer
6761     *   comes as the @c event_info data (a stringshared string)
6762     *
6763     * Here is an example on its usage:
6764     * @li @ref fileselector_entry_example
6765     *
6766     * @see @ref File_Selector_Button for a similar widget.
6767     * @{
6768     */
6769
6770    /**
6771     * Add a new file selector entry widget to the given parent
6772     * Elementary (container) object
6773     *
6774     * @param parent The parent object
6775     * @return a new file selector entry widget handle or @c NULL, on
6776     * errors
6777     */
6778    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6779
6780    /**
6781     * Set the label for a given file selector entry widget's button
6782     *
6783     * @param obj The file selector entry widget
6784     * @param label The text label to be displayed on @p obj widget's
6785     * button
6786     *
6787     * @deprecated use elm_object_text_set() instead.
6788     */
6789    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6790
6791    /**
6792     * Get the label set for a given file selector entry widget's button
6793     *
6794     * @param obj The file selector entry widget
6795     * @return The widget button's label
6796     *
6797     * @deprecated use elm_object_text_set() instead.
6798     */
6799    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6800
6801    /**
6802     * Set the icon on a given file selector entry widget's button
6803     *
6804     * @param obj The file selector entry widget
6805     * @param icon The icon object for the entry's button
6806     *
6807     * Once the icon object is set, a previously set one will be
6808     * deleted. If you want to keep the latter, use the
6809     * elm_fileselector_entry_button_icon_unset() function.
6810     *
6811     * @see elm_fileselector_entry_button_icon_get()
6812     */
6813    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6814
6815    /**
6816     * Get the icon set for a given file selector entry widget's button
6817     *
6818     * @param obj The file selector entry widget
6819     * @return The icon object currently set on @p obj widget's button
6820     * or @c NULL, if none is
6821     *
6822     * @see elm_fileselector_entry_button_icon_set()
6823     */
6824    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6825
6826    /**
6827     * Unset the icon used in a given file selector entry widget's
6828     * button
6829     *
6830     * @param obj The file selector entry widget
6831     * @return The icon object that was being used on @p obj widget's
6832     * button or @c NULL, on errors
6833     *
6834     * Unparent and return the icon object which was set for this
6835     * widget's button.
6836     *
6837     * @see elm_fileselector_entry_button_icon_set()
6838     */
6839    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6840
6841    /**
6842     * Set the title for a given file selector entry widget's window
6843     *
6844     * @param obj The file selector entry widget
6845     * @param title The title string
6846     *
6847     * This will change the window's title, when the file selector pops
6848     * out after a click on the entry's button. Those windows have the
6849     * default (unlocalized) value of @c "Select a file" as titles.
6850     *
6851     * @note It will only take any effect if the file selector
6852     * entry widget is @b not under "inwin mode".
6853     *
6854     * @see elm_fileselector_entry_window_title_get()
6855     */
6856    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6857
6858    /**
6859     * Get the title set for a given file selector entry widget's
6860     * window
6861     *
6862     * @param obj The file selector entry widget
6863     * @return Title of the file selector entry's window
6864     *
6865     * @see elm_fileselector_entry_window_title_get() for more details
6866     */
6867    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6868
6869    /**
6870     * Set the size of a given file selector entry widget's window,
6871     * holding the file selector itself.
6872     *
6873     * @param obj The file selector entry widget
6874     * @param width The window's width
6875     * @param height The window's height
6876     *
6877     * @note it will only take any effect if the file selector entry
6878     * widget is @b not under "inwin mode". The default size for the
6879     * window (when applicable) is 400x400 pixels.
6880     *
6881     * @see elm_fileselector_entry_window_size_get()
6882     */
6883    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6884
6885    /**
6886     * Get the size of a given file selector entry widget's window,
6887     * holding the file selector itself.
6888     *
6889     * @param obj The file selector entry widget
6890     * @param width Pointer into which to store the width value
6891     * @param height Pointer into which to store the height value
6892     *
6893     * @note Use @c NULL pointers on the size values you're not
6894     * interested in: they'll be ignored by the function.
6895     *
6896     * @see elm_fileselector_entry_window_size_set(), for more details
6897     */
6898    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6899
6900    /**
6901     * Set the initial file system path and the entry's path string for
6902     * a given file selector entry widget
6903     *
6904     * @param obj The file selector entry widget
6905     * @param path The path string
6906     *
6907     * It must be a <b>directory</b> path, which will have the contents
6908     * displayed initially in the file selector's view, when invoked
6909     * from @p obj. The default initial path is the @c "HOME"
6910     * environment variable's value.
6911     *
6912     * @see elm_fileselector_entry_path_get()
6913     */
6914    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6915
6916    /**
6917     * Get the entry's path string for a given file selector entry
6918     * widget
6919     *
6920     * @param obj The file selector entry widget
6921     * @return path The path string
6922     *
6923     * @see elm_fileselector_entry_path_set() for more details
6924     */
6925    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6926
6927    /**
6928     * Enable/disable a tree view in the given file selector entry
6929     * widget's internal file selector
6930     *
6931     * @param obj The file selector entry widget
6932     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6933     * disable
6934     *
6935     * This has the same effect as elm_fileselector_expandable_set(),
6936     * but now applied to a file selector entry's internal file
6937     * selector.
6938     *
6939     * @note There's no way to put a file selector entry's internal
6940     * file selector in "grid mode", as one may do with "pure" file
6941     * selectors.
6942     *
6943     * @see elm_fileselector_expandable_get()
6944     */
6945    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6946
6947    /**
6948     * Get whether tree view is enabled for the given file selector
6949     * entry widget's internal file selector
6950     *
6951     * @param obj The file selector entry widget
6952     * @return @c EINA_TRUE if @p obj widget's internal file selector
6953     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6954     *
6955     * @see elm_fileselector_expandable_set() for more details
6956     */
6957    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6958
6959    /**
6960     * Set whether a given file selector entry widget's internal file
6961     * selector is to display folders only or the directory contents,
6962     * as well.
6963     *
6964     * @param obj The file selector entry widget
6965     * @param only @c EINA_TRUE to make @p obj widget's internal file
6966     * selector only display directories, @c EINA_FALSE to make files
6967     * to be displayed in it too
6968     *
6969     * This has the same effect as elm_fileselector_folder_only_set(),
6970     * but now applied to a file selector entry's internal file
6971     * selector.
6972     *
6973     * @see elm_fileselector_folder_only_get()
6974     */
6975    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6976
6977    /**
6978     * Get whether a given file selector entry widget's internal file
6979     * selector is displaying folders only or the directory contents,
6980     * as well.
6981     *
6982     * @param obj The file selector entry widget
6983     * @return @c EINA_TRUE if @p obj widget's internal file
6984     * selector is only displaying directories, @c EINA_FALSE if files
6985     * are being displayed in it too (and on errors)
6986     *
6987     * @see elm_fileselector_entry_folder_only_set() for more details
6988     */
6989    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6990
6991    /**
6992     * Enable/disable the file name entry box where the user can type
6993     * in a name for a file, in a given file selector entry widget's
6994     * internal file selector.
6995     *
6996     * @param obj The file selector entry widget
6997     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6998     * file selector a "saving dialog", @c EINA_FALSE otherwise
6999     *
7000     * This has the same effect as elm_fileselector_is_save_set(),
7001     * but now applied to a file selector entry's internal file
7002     * selector.
7003     *
7004     * @see elm_fileselector_is_save_get()
7005     */
7006    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7007
7008    /**
7009     * Get whether the given file selector entry widget's internal
7010     * file selector is in "saving dialog" mode
7011     *
7012     * @param obj The file selector entry widget
7013     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7014     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7015     * errors)
7016     *
7017     * @see elm_fileselector_entry_is_save_set() for more details
7018     */
7019    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7020
7021    /**
7022     * Set whether a given file selector entry widget's internal file
7023     * selector will raise an Elementary "inner window", instead of a
7024     * dedicated Elementary window. By default, it won't.
7025     *
7026     * @param obj The file selector entry widget
7027     * @param value @c EINA_TRUE to make it use an inner window, @c
7028     * EINA_TRUE to make it use a dedicated window
7029     *
7030     * @see elm_win_inwin_add() for more information on inner windows
7031     * @see elm_fileselector_entry_inwin_mode_get()
7032     */
7033    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7034
7035    /**
7036     * Get whether a given file selector entry widget's internal file
7037     * selector will raise an Elementary "inner window", instead of a
7038     * dedicated Elementary window.
7039     *
7040     * @param obj The file selector entry widget
7041     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7042     * if it will use a dedicated window
7043     *
7044     * @see elm_fileselector_entry_inwin_mode_set() for more details
7045     */
7046    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7047
7048    /**
7049     * Set the initial file system path for a given file selector entry
7050     * widget
7051     *
7052     * @param obj The file selector entry widget
7053     * @param path The path string
7054     *
7055     * It must be a <b>directory</b> path, which will have the contents
7056     * displayed initially in the file selector's view, when invoked
7057     * from @p obj. The default initial path is the @c "HOME"
7058     * environment variable's value.
7059     *
7060     * @see elm_fileselector_entry_path_get()
7061     */
7062    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7063
7064    /**
7065     * Get the parent directory's path to the latest file selection on
7066     * a given filer selector entry widget
7067     *
7068     * @param obj The file selector object
7069     * @return The (full) path of the directory of the last selection
7070     * on @p obj widget, a @b stringshared string
7071     *
7072     * @see elm_fileselector_entry_path_set()
7073     */
7074    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7075
7076    /**
7077     * @}
7078     */
7079
7080    /**
7081     * @defgroup Scroller Scroller
7082     *
7083     * A scroller holds a single object and "scrolls it around". This means that
7084     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7085     * region around, allowing to move through a much larger object that is
7086     * contained in the scroller. The scroller will always have a small minimum
7087     * size by default as it won't be limited by the contents of the scroller.
7088     *
7089     * Signals that you can add callbacks for are:
7090     * @li "edge,left" - the left edge of the content has been reached
7091     * @li "edge,right" - the right edge of the content has been reached
7092     * @li "edge,top" - the top edge of the content has been reached
7093     * @li "edge,bottom" - the bottom edge of the content has been reached
7094     * @li "scroll" - the content has been scrolled (moved)
7095     * @li "scroll,anim,start" - scrolling animation has started
7096     * @li "scroll,anim,stop" - scrolling animation has stopped
7097     * @li "scroll,drag,start" - dragging the contents around has started
7098     * @li "scroll,drag,stop" - dragging the contents around has stopped
7099     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7100     * user intervetion.
7101     *
7102     * @note When Elemementary is in embedded mode the scrollbars will not be
7103     * dragable, they appear merely as indicators of how much has been scrolled.
7104     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7105     * fingerscroll) won't work.
7106     *
7107     * To set/get/unset the content of the panel, you can use
7108     * elm_object_content_set/get/unset APIs.
7109     * Once the content object is set, a previously set one will be deleted.
7110     * If you want to keep that old content object, use the
7111     * elm_object_content_unset() function
7112     *
7113     * In @ref tutorial_scroller you'll find an example of how to use most of
7114     * this API.
7115     * @{
7116     */
7117    /**
7118     * @brief Type that controls when scrollbars should appear.
7119     *
7120     * @see elm_scroller_policy_set()
7121     */
7122    typedef enum _Elm_Scroller_Policy
7123      {
7124         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7125         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7126         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7127         ELM_SCROLLER_POLICY_LAST
7128      } Elm_Scroller_Policy;
7129    /**
7130     * @brief Add a new scroller to the parent
7131     *
7132     * @param parent The parent object
7133     * @return The new object or NULL if it cannot be created
7134     */
7135    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7136    /**
7137     * @brief Set the content of the scroller widget (the object to be scrolled around).
7138     *
7139     * @param obj The scroller object
7140     * @param content The new content object
7141     *
7142     * Once the content object is set, a previously set one will be deleted.
7143     * If you want to keep that old content object, use the
7144     * elm_scroller_content_unset() function.
7145     * @deprecated use elm_object_content_set() instead
7146     */
7147    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7148    /**
7149     * @brief Get the content of the scroller widget
7150     *
7151     * @param obj The slider object
7152     * @return The content that is being used
7153     *
7154     * Return the content object which is set for this widget
7155     *
7156     * @see elm_scroller_content_set()
7157     * @deprecated use elm_object_content_get() instead.
7158     */
7159    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7160    /**
7161     * @brief Unset the content of the scroller widget
7162     *
7163     * @param obj The slider object
7164     * @return The content that was being used
7165     *
7166     * Unparent and return the content object which was set for this widget
7167     *
7168     * @see elm_scroller_content_set()
7169     * @deprecated use elm_object_content_unset() instead.
7170     */
7171    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7172    /**
7173     * @brief Set custom theme elements for the scroller
7174     *
7175     * @param obj The scroller object
7176     * @param widget The widget name to use (default is "scroller")
7177     * @param base The base name to use (default is "base")
7178     */
7179    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7180    /**
7181     * @brief Make the scroller minimum size limited to the minimum size of the content
7182     *
7183     * @param obj The scroller object
7184     * @param w Enable limiting minimum size horizontally
7185     * @param h Enable limiting minimum size vertically
7186     *
7187     * By default the scroller will be as small as its design allows,
7188     * irrespective of its content. This will make the scroller minimum size the
7189     * right size horizontally and/or vertically to perfectly fit its content in
7190     * that direction.
7191     */
7192    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7193    /**
7194     * @brief Show a specific virtual region within the scroller content object
7195     *
7196     * @param obj The scroller object
7197     * @param x X coordinate of the region
7198     * @param y Y coordinate of the region
7199     * @param w Width of the region
7200     * @param h Height of the region
7201     *
7202     * This will ensure all (or part if it does not fit) of the designated
7203     * region in the virtual content object (0, 0 starting at the top-left of the
7204     * virtual content object) is shown within the scroller.
7205     */
7206    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);
7207    /**
7208     * @brief Set the scrollbar visibility policy
7209     *
7210     * @param obj The scroller object
7211     * @param policy_h Horizontal scrollbar policy
7212     * @param policy_v Vertical scrollbar policy
7213     *
7214     * This sets the scrollbar visibility policy for the given scroller.
7215     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7216     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7217     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7218     * respectively for the horizontal and vertical scrollbars.
7219     */
7220    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7221    /**
7222     * @brief Gets scrollbar visibility policy
7223     *
7224     * @param obj The scroller object
7225     * @param policy_h Horizontal scrollbar policy
7226     * @param policy_v Vertical scrollbar policy
7227     *
7228     * @see elm_scroller_policy_set()
7229     */
7230    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7231    /**
7232     * @brief Get the currently visible content region
7233     *
7234     * @param obj The scroller object
7235     * @param x X coordinate of the region
7236     * @param y Y coordinate of the region
7237     * @param w Width of the region
7238     * @param h Height of the region
7239     *
7240     * This gets the current region in the content object that is visible through
7241     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7242     * w, @p h values pointed to.
7243     *
7244     * @note All coordinates are relative to the content.
7245     *
7246     * @see elm_scroller_region_show()
7247     */
7248    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);
7249    /**
7250     * @brief Get the size of the content object
7251     *
7252     * @param obj The scroller object
7253     * @param w Width of the content object.
7254     * @param h Height of the content object.
7255     *
7256     * This gets the size of the content object of the scroller.
7257     */
7258    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7259    /**
7260     * @brief Set bouncing behavior
7261     *
7262     * @param obj The scroller object
7263     * @param h_bounce Allow bounce horizontally
7264     * @param v_bounce Allow bounce vertically
7265     *
7266     * When scrolling, the scroller may "bounce" when reaching an edge of the
7267     * content object. This is a visual way to indicate the end has been reached.
7268     * This is enabled by default for both axis. This API will set if it is enabled
7269     * for the given axis with the boolean parameters for each axis.
7270     */
7271    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7272    /**
7273     * @brief Get the bounce behaviour
7274     *
7275     * @param obj The Scroller object
7276     * @param h_bounce Will the scroller bounce horizontally or not
7277     * @param v_bounce Will the scroller bounce vertically or not
7278     *
7279     * @see elm_scroller_bounce_set()
7280     */
7281    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7282    /**
7283     * @brief Set scroll page size relative to viewport size.
7284     *
7285     * @param obj The scroller object
7286     * @param h_pagerel The horizontal page relative size
7287     * @param v_pagerel The vertical page relative size
7288     *
7289     * The scroller is capable of limiting scrolling by the user to "pages". That
7290     * is to jump by and only show a "whole page" at a time as if the continuous
7291     * area of the scroller content is split into page sized pieces. This sets
7292     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7293     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7294     * axis. This is mutually exclusive with page size
7295     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7296     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7297     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7298     * the other axis.
7299     */
7300    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7301    /**
7302     * @brief Set scroll page size.
7303     *
7304     * @param obj The scroller object
7305     * @param h_pagesize The horizontal page size
7306     * @param v_pagesize The vertical page size
7307     *
7308     * This sets the page size to an absolute fixed value, with 0 turning it off
7309     * for that axis.
7310     *
7311     * @see elm_scroller_page_relative_set()
7312     */
7313    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7314    /**
7315     * @brief Get scroll current page number.
7316     *
7317     * @param obj The scroller object
7318     * @param h_pagenumber The horizontal page number
7319     * @param v_pagenumber The vertical page number
7320     *
7321     * The page number starts from 0. 0 is the first page.
7322     * Current page means the page which meets the top-left of the viewport.
7323     * If there are two or more pages in the viewport, it returns the number of the page
7324     * which meets the top-left of the viewport.
7325     *
7326     * @see elm_scroller_last_page_get()
7327     * @see elm_scroller_page_show()
7328     * @see elm_scroller_page_brint_in()
7329     */
7330    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7331    /**
7332     * @brief Get scroll last page number.
7333     *
7334     * @param obj The scroller object
7335     * @param h_pagenumber The horizontal page number
7336     * @param v_pagenumber The vertical page number
7337     *
7338     * The page number starts from 0. 0 is the first page.
7339     * This returns the last page number among the pages.
7340     *
7341     * @see elm_scroller_current_page_get()
7342     * @see elm_scroller_page_show()
7343     * @see elm_scroller_page_brint_in()
7344     */
7345    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7346    /**
7347     * Show a specific virtual region within the scroller content object by page number.
7348     *
7349     * @param obj The scroller object
7350     * @param h_pagenumber The horizontal page number
7351     * @param v_pagenumber The vertical page number
7352     *
7353     * 0, 0 of the indicated page is located at the top-left of the viewport.
7354     * This will jump to the page directly without animation.
7355     *
7356     * Example of usage:
7357     *
7358     * @code
7359     * sc = elm_scroller_add(win);
7360     * elm_scroller_content_set(sc, content);
7361     * elm_scroller_page_relative_set(sc, 1, 0);
7362     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7363     * elm_scroller_page_show(sc, h_page + 1, v_page);
7364     * @endcode
7365     *
7366     * @see elm_scroller_page_bring_in()
7367     */
7368    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7369    /**
7370     * Show a specific virtual region within the scroller content object by page number.
7371     *
7372     * @param obj The scroller object
7373     * @param h_pagenumber The horizontal page number
7374     * @param v_pagenumber The vertical page number
7375     *
7376     * 0, 0 of the indicated page is located at the top-left of the viewport.
7377     * This will slide to the page with animation.
7378     *
7379     * Example of usage:
7380     *
7381     * @code
7382     * sc = elm_scroller_add(win);
7383     * elm_scroller_content_set(sc, content);
7384     * elm_scroller_page_relative_set(sc, 1, 0);
7385     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7386     * elm_scroller_page_bring_in(sc, h_page, v_page);
7387     * @endcode
7388     *
7389     * @see elm_scroller_page_show()
7390     */
7391    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7392    /**
7393     * @brief Show a specific virtual region within the scroller content object.
7394     *
7395     * @param obj The scroller object
7396     * @param x X coordinate of the region
7397     * @param y Y coordinate of the region
7398     * @param w Width of the region
7399     * @param h Height of the region
7400     *
7401     * This will ensure all (or part if it does not fit) of the designated
7402     * region in the virtual content object (0, 0 starting at the top-left of the
7403     * virtual content object) is shown within the scroller. Unlike
7404     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7405     * to this location (if configuration in general calls for transitions). It
7406     * may not jump immediately to the new location and make take a while and
7407     * show other content along the way.
7408     *
7409     * @see elm_scroller_region_show()
7410     */
7411    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);
7412    /**
7413     * @brief Set event propagation on a scroller
7414     *
7415     * @param obj The scroller object
7416     * @param propagation If propagation is enabled or not
7417     *
7418     * This enables or disabled event propagation from the scroller content to
7419     * the scroller and its parent. By default event propagation is disabled.
7420     */
7421    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7422    /**
7423     * @brief Get event propagation for a scroller
7424     *
7425     * @param obj The scroller object
7426     * @return The propagation state
7427     *
7428     * This gets the event propagation for a scroller.
7429     *
7430     * @see elm_scroller_propagate_events_set()
7431     */
7432    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7433    /**
7434     * @brief Set scrolling gravity on a scroller
7435     *
7436     * @param obj The scroller object
7437     * @param x The scrolling horizontal gravity
7438     * @param y The scrolling vertical gravity
7439     *
7440     * The gravity, defines how the scroller will adjust its view
7441     * when the size of the scroller contents increase.
7442     *
7443     * The scroller will adjust the view to glue itself as follows.
7444     *
7445     *  x=0.0, for showing the left most region of the content.
7446     *  x=1.0, for showing the right most region of the content.
7447     *  y=0.0, for showing the bottom most region of the content.
7448     *  y=1.0, for showing the top most region of the content.
7449     *
7450     * Default values for x and y are 0.0
7451     */
7452    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7453    /**
7454     * @brief Get scrolling gravity values for a scroller
7455     *
7456     * @param obj The scroller object
7457     * @param x The scrolling horizontal gravity
7458     * @param y The scrolling vertical gravity
7459     *
7460     * This gets gravity values for a scroller.
7461     *
7462     * @see elm_scroller_gravity_set()
7463     *
7464     */
7465    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7466    /**
7467     * @}
7468     */
7469
7470    /**
7471     * @defgroup Label Label
7472     *
7473     * @image html img/widget/label/preview-00.png
7474     * @image latex img/widget/label/preview-00.eps
7475     *
7476     * @brief Widget to display text, with simple html-like markup.
7477     *
7478     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7479     * text doesn't fit the geometry of the label it will be ellipsized or be
7480     * cut. Elementary provides several themes for this widget:
7481     * @li default - No animation
7482     * @li marker - Centers the text in the label and make it bold by default
7483     * @li slide_long - The entire text appears from the right of the screen and
7484     * slides until it disappears in the left of the screen(reappering on the
7485     * right again).
7486     * @li slide_short - The text appears in the left of the label and slides to
7487     * the right to show the overflow. When all of the text has been shown the
7488     * position is reset.
7489     * @li slide_bounce - The text appears in the left of the label and slides to
7490     * the right to show the overflow. When all of the text has been shown the
7491     * animation reverses, moving the text to the left.
7492     *
7493     * Custom themes can of course invent new markup tags and style them any way
7494     * they like.
7495     *
7496     * The following signals may be emitted by the label widget:
7497     * @li "language,changed": The program's language changed.
7498     *
7499     * See @ref tutorial_label for a demonstration of how to use a label widget.
7500     * @{
7501     */
7502    /**
7503     * @brief Add a new label to the parent
7504     *
7505     * @param parent The parent object
7506     * @return The new object or NULL if it cannot be created
7507     */
7508    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7509    /**
7510     * @brief Set the label on the label object
7511     *
7512     * @param obj The label object
7513     * @param label The label will be used on the label object
7514     * @deprecated See elm_object_text_set()
7515     */
7516    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 */
7517    /**
7518     * @brief Get the label used on the label object
7519     *
7520     * @param obj The label object
7521     * @return The string inside the label
7522     * @deprecated See elm_object_text_get()
7523     */
7524    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7525    /**
7526     * @brief Set the wrapping behavior of the label
7527     *
7528     * @param obj The label object
7529     * @param wrap To wrap text or not
7530     *
7531     * By default no wrapping is done. Possible values for @p wrap are:
7532     * @li ELM_WRAP_NONE - No wrapping
7533     * @li ELM_WRAP_CHAR - wrap between characters
7534     * @li ELM_WRAP_WORD - wrap between words
7535     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7536     */
7537    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7538    /**
7539     * @brief Get the wrapping behavior of the label
7540     *
7541     * @param obj The label object
7542     * @return Wrap type
7543     *
7544     * @see elm_label_line_wrap_set()
7545     */
7546    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7547    /**
7548     * @brief Set wrap width of the label
7549     *
7550     * @param obj The label object
7551     * @param w The wrap width in pixels at a minimum where words need to wrap
7552     *
7553     * This function sets the maximum width size hint of the label.
7554     *
7555     * @warning This is only relevant if the label is inside a container.
7556     */
7557    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7558    /**
7559     * @brief Get wrap width of the label
7560     *
7561     * @param obj The label object
7562     * @return The wrap width in pixels at a minimum where words need to wrap
7563     *
7564     * @see elm_label_wrap_width_set()
7565     */
7566    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7567    /**
7568     * @brief Set wrap height of the label
7569     *
7570     * @param obj The label object
7571     * @param h The wrap height in pixels at a minimum where words need to wrap
7572     *
7573     * This function sets the maximum height size hint of the label.
7574     *
7575     * @warning This is only relevant if the label is inside a container.
7576     */
7577    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7578    /**
7579     * @brief get wrap width of the label
7580     *
7581     * @param obj The label object
7582     * @return The wrap height in pixels at a minimum where words need to wrap
7583     */
7584    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7585    /**
7586     * @brief Set the font size on the label object.
7587     *
7588     * @param obj The label object
7589     * @param size font size
7590     *
7591     * @warning NEVER use this. It is for hyper-special cases only. use styles
7592     * instead. e.g. "big", "medium", "small" - or better name them by use:
7593     * "title", "footnote", "quote" etc.
7594     */
7595    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7596    /**
7597     * @brief Set the text color on the label object
7598     *
7599     * @param obj The label object
7600     * @param r Red property background color of The label object
7601     * @param g Green property background color of The label object
7602     * @param b Blue property background color of The label object
7603     * @param a Alpha property background color of The label object
7604     *
7605     * @warning NEVER use this. It is for hyper-special cases only. use styles
7606     * instead. e.g. "big", "medium", "small" - or better name them by use:
7607     * "title", "footnote", "quote" etc.
7608     */
7609    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);
7610    /**
7611     * @brief Set the text align on the label object
7612     *
7613     * @param obj The label object
7614     * @param align align mode ("left", "center", "right")
7615     *
7616     * @warning NEVER use this. It is for hyper-special cases only. use styles
7617     * instead. e.g. "big", "medium", "small" - or better name them by use:
7618     * "title", "footnote", "quote" etc.
7619     */
7620    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7621    /**
7622     * @brief Set background color of the label
7623     *
7624     * @param obj The label object
7625     * @param r Red property background color of The label object
7626     * @param g Green property background color of The label object
7627     * @param b Blue property background color of The label object
7628     * @param a Alpha property background alpha of The label object
7629     *
7630     * @warning NEVER use this. It is for hyper-special cases only. use styles
7631     * instead. e.g. "big", "medium", "small" - or better name them by use:
7632     * "title", "footnote", "quote" etc.
7633     */
7634    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);
7635    /**
7636     * @brief Set the ellipsis behavior of the label
7637     *
7638     * @param obj The label object
7639     * @param ellipsis To ellipsis text or not
7640     *
7641     * If set to true and the text doesn't fit in the label an ellipsis("...")
7642     * will be shown at the end of the widget.
7643     *
7644     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7645     * choosen wrap method was ELM_WRAP_WORD.
7646     */
7647    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7648    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7649    /**
7650     * @brief Set the text slide of the label
7651     *
7652     * @param obj The label object
7653     * @param slide To start slide or stop
7654     *
7655     * If set to true, the text of the label will slide/scroll through the length of
7656     * label.
7657     *
7658     * @warning This only works with the themes "slide_short", "slide_long" and
7659     * "slide_bounce".
7660     */
7661    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7662    /**
7663     * @brief Get the text slide mode of the label
7664     *
7665     * @param obj The label object
7666     * @return slide slide mode value
7667     *
7668     * @see elm_label_slide_set()
7669     */
7670    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7671    /**
7672     * @brief Set the slide duration(speed) of the label
7673     *
7674     * @param obj The label object
7675     * @return The duration in seconds in moving text from slide begin position
7676     * to slide end position
7677     */
7678    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7679    /**
7680     * @brief Get the slide duration(speed) of the label
7681     *
7682     * @param obj The label object
7683     * @return The duration time in moving text from slide begin position to slide end position
7684     *
7685     * @see elm_label_slide_duration_set()
7686     */
7687    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7688    /**
7689     * @}
7690     */
7691
7692    /**
7693     * @defgroup Toggle Toggle
7694     *
7695     * @image html img/widget/toggle/preview-00.png
7696     * @image latex img/widget/toggle/preview-00.eps
7697     *
7698     * @brief A toggle is a slider which can be used to toggle between
7699     * two values.  It has two states: on and off.
7700     *
7701     * This widget is deprecated. Please use elm_check_add() instead using the
7702     * toggle style like:
7703     * 
7704     * @code
7705     * obj = elm_check_add(parent);
7706     * elm_object_style_set(obj, "toggle");
7707     * elm_object_text_part_set(obj, "on", "ON");
7708     * elm_object_text_part_set(obj, "off", "OFF");
7709     * @endcode
7710     * 
7711     * Signals that you can add callbacks for are:
7712     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7713     *                 until the toggle is released by the cursor (assuming it
7714     *                 has been triggered by the cursor in the first place).
7715     *
7716     * @ref tutorial_toggle show how to use a toggle.
7717     * @{
7718     */
7719    /**
7720     * @brief Add a toggle to @p parent.
7721     *
7722     * @param parent The parent object
7723     *
7724     * @return The toggle object
7725     */
7726    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7727    /**
7728     * @brief Sets the label to be displayed with the toggle.
7729     *
7730     * @param obj The toggle object
7731     * @param label The label to be displayed
7732     *
7733     * @deprecated use elm_object_text_set() instead.
7734     */
7735    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7736    /**
7737     * @brief Gets the label of the toggle
7738     *
7739     * @param obj  toggle object
7740     * @return The label of the toggle
7741     *
7742     * @deprecated use elm_object_text_get() instead.
7743     */
7744    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7745    /**
7746     * @brief Set the icon used for the toggle
7747     *
7748     * @param obj The toggle object
7749     * @param icon The icon object for the button
7750     *
7751     * Once the icon object is set, a previously set one will be deleted
7752     * If you want to keep that old content object, use the
7753     * elm_toggle_icon_unset() function.
7754     *
7755     * @deprecated use elm_object_content_set() instead.
7756     */
7757    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7758    /**
7759     * @brief Get the icon used for the toggle
7760     *
7761     * @param obj The toggle object
7762     * @return The icon object that is being used
7763     *
7764     * Return the icon object which is set for this widget.
7765     *
7766     * @see elm_toggle_icon_set()
7767     *
7768     * @deprecated use elm_object_content_get() instead.
7769     */
7770    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7771    /**
7772     * @brief Unset the icon used for the toggle
7773     *
7774     * @param obj The toggle object
7775     * @return The icon object that was being used
7776     *
7777     * Unparent and return the icon object which was set for this widget.
7778     *
7779     * @see elm_toggle_icon_set()
7780     *
7781     * @deprecated use elm_object_content_unset() instead.
7782     */
7783    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7784    /**
7785     * @brief Sets the labels to be associated with the on and off states of the toggle.
7786     *
7787     * @param obj The toggle object
7788     * @param onlabel The label displayed when the toggle is in the "on" state
7789     * @param offlabel The label displayed when the toggle is in the "off" state
7790     *
7791     * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7792     * instead.
7793     */
7794    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7795    /**
7796     * @brief Gets the labels associated with the on and off states of the
7797     * toggle.
7798     *
7799     * @param obj The toggle object
7800     * @param onlabel A char** to place the onlabel of @p obj into
7801     * @param offlabel A char** to place the offlabel of @p obj into
7802     *
7803     * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7804     * instead.
7805     */
7806    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7807    /**
7808     * @brief Sets the state of the toggle to @p state.
7809     *
7810     * @param obj The toggle object
7811     * @param state The state of @p obj
7812     *
7813     * @deprecated use elm_check_state_set() instead.
7814     */
7815    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7816    /**
7817     * @brief Gets the state of the toggle to @p state.
7818     *
7819     * @param obj The toggle object
7820     * @return The state of @p obj
7821     *
7822     * @deprecated use elm_check_state_get() instead.
7823     */
7824    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7825    /**
7826     * @brief Sets the state pointer of the toggle to @p statep.
7827     *
7828     * @param obj The toggle object
7829     * @param statep The state pointer of @p obj
7830     *
7831     * @deprecated use elm_check_state_pointer_set() instead.
7832     */
7833    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7834    /**
7835     * @}
7836     */
7837
7838    /**
7839     * @defgroup Frame Frame
7840     *
7841     * @image html img/widget/frame/preview-00.png
7842     * @image latex img/widget/frame/preview-00.eps
7843     *
7844     * @brief Frame is a widget that holds some content and has a title.
7845     *
7846     * The default look is a frame with a title, but Frame supports multple
7847     * styles:
7848     * @li default
7849     * @li pad_small
7850     * @li pad_medium
7851     * @li pad_large
7852     * @li pad_huge
7853     * @li outdent_top
7854     * @li outdent_bottom
7855     *
7856     * Of all this styles only default shows the title. Frame emits no signals.
7857     *
7858     * Default contents parts of the frame widget that you can use for are:
7859     * @li "elm.swallow.content" - A content of the frame
7860     *
7861     * Default text parts of the frame widget that you can use for are:
7862     * @li "elm.text" - Label of the frame
7863     *
7864     * For a detailed example see the @ref tutorial_frame.
7865     *
7866     * @{
7867     */
7868    /**
7869     * @brief Add a new frame to the parent
7870     *
7871     * @param parent The parent object
7872     * @return The new object or NULL if it cannot be created
7873     */
7874    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7875    /**
7876     * @brief Set the frame label
7877     *
7878     * @param obj The frame object
7879     * @param label The label of this frame object
7880     *
7881     * @deprecated use elm_object_text_set() instead.
7882     */
7883    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7884    /**
7885     * @brief Get the frame label
7886     *
7887     * @param obj The frame object
7888     *
7889     * @return The label of this frame objet or NULL if unable to get frame
7890     *
7891     * @deprecated use elm_object_text_get() instead.
7892     */
7893    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7894    /**
7895     * @brief Set the content of the frame widget
7896     *
7897     * Once the content object is set, a previously set one will be deleted.
7898     * If you want to keep that old content object, use the
7899     * elm_frame_content_unset() function.
7900     *
7901     * @param obj The frame object
7902     * @param content The content will be filled in this frame object
7903     *
7904     * @deprecated use elm_object_content_set() instead.
7905     */
7906    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7907    /**
7908     * @brief Get the content of the frame widget
7909     *
7910     * Return the content object which is set for this widget
7911     *
7912     * @param obj The frame object
7913     * @return The content that is being used
7914     *
7915     * @deprecated use elm_object_content_get() instead.
7916     */
7917    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7918    /**
7919     * @brief Unset the content of the frame widget
7920     *
7921     * Unparent and return the content object which was set for this widget
7922     *
7923     * @param obj The frame object
7924     * @return The content that was being used
7925     *
7926     * @deprecated use elm_object_content_unset() instead.
7927     */
7928    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7929    /**
7930     * @}
7931     */
7932
7933    /**
7934     * @defgroup Table Table
7935     *
7936     * A container widget to arrange other widgets in a table where items can
7937     * also span multiple columns or rows - even overlap (and then be raised or
7938     * lowered accordingly to adjust stacking if they do overlap).
7939     *
7940     * For a Table widget the row/column count is not fixed.
7941     * The table widget adjusts itself when subobjects are added to it dynamically.
7942     *
7943     * The followin are examples of how to use a table:
7944     * @li @ref tutorial_table_01
7945     * @li @ref tutorial_table_02
7946     *
7947     * @{
7948     */
7949    /**
7950     * @brief Add a new table to the parent
7951     *
7952     * @param parent The parent object
7953     * @return The new object or NULL if it cannot be created
7954     */
7955    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7956    /**
7957     * @brief Set the homogeneous layout in the table
7958     *
7959     * @param obj The layout object
7960     * @param homogeneous A boolean to set if the layout is homogeneous in the
7961     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7962     */
7963    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7964    /**
7965     * @brief Get the current table homogeneous mode.
7966     *
7967     * @param obj The table object
7968     * @return A boolean to indicating if the layout is homogeneous in the table
7969     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7970     */
7971    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7972    /**
7973     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7974     */
7975    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7976    /**
7977     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7978     */
7979    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7980    /**
7981     * @brief Set padding between cells.
7982     *
7983     * @param obj The layout object.
7984     * @param horizontal set the horizontal padding.
7985     * @param vertical set the vertical padding.
7986     *
7987     * Default value is 0.
7988     */
7989    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7990    /**
7991     * @brief Get padding between cells.
7992     *
7993     * @param obj The layout object.
7994     * @param horizontal set the horizontal padding.
7995     * @param vertical set the vertical padding.
7996     */
7997    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7998    /**
7999     * @brief Add a subobject on the table with the coordinates passed
8000     *
8001     * @param obj The table object
8002     * @param subobj The subobject to be added to the table
8003     * @param x Row number
8004     * @param y Column number
8005     * @param w rowspan
8006     * @param h colspan
8007     *
8008     * @note All positioning inside the table is relative to rows and columns, so
8009     * a value of 0 for x and y, means the top left cell of the table, and a
8010     * value of 1 for w and h means @p subobj only takes that 1 cell.
8011     */
8012    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8013    /**
8014     * @brief Remove child from table.
8015     *
8016     * @param obj The table object
8017     * @param subobj The subobject
8018     */
8019    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8020    /**
8021     * @brief Faster way to remove all child objects from a table object.
8022     *
8023     * @param obj The table object
8024     * @param clear If true, will delete children, else just remove from table.
8025     */
8026    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8027    /**
8028     * @brief Set the packing location of an existing child of the table
8029     *
8030     * @param subobj The subobject to be modified in the table
8031     * @param x Row number
8032     * @param y Column number
8033     * @param w rowspan
8034     * @param h colspan
8035     *
8036     * Modifies the position of an object already in the table.
8037     *
8038     * @note All positioning inside the table is relative to rows and columns, so
8039     * a value of 0 for x and y, means the top left cell of the table, and a
8040     * value of 1 for w and h means @p subobj only takes that 1 cell.
8041     */
8042    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8043    /**
8044     * @brief Get the packing location of an existing child of the table
8045     *
8046     * @param subobj The subobject to be modified in the table
8047     * @param x Row number
8048     * @param y Column number
8049     * @param w rowspan
8050     * @param h colspan
8051     *
8052     * @see elm_table_pack_set()
8053     */
8054    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8055    /**
8056     * @}
8057     */
8058
8059    /**
8060     * @defgroup Gengrid Gengrid (Generic grid)
8061     *
8062     * This widget aims to position objects in a grid layout while
8063     * actually creating and rendering only the visible ones, using the
8064     * same idea as the @ref Genlist "genlist": the user defines a @b
8065     * class for each item, specifying functions that will be called at
8066     * object creation, deletion, etc. When those items are selected by
8067     * the user, a callback function is issued. Users may interact with
8068     * a gengrid via the mouse (by clicking on items to select them and
8069     * clicking on the grid's viewport and swiping to pan the whole
8070     * view) or via the keyboard, navigating through item with the
8071     * arrow keys.
8072     *
8073     * @section Gengrid_Layouts Gengrid layouts
8074     *
8075     * Gengrid may layout its items in one of two possible layouts:
8076     * - horizontal or
8077     * - vertical.
8078     *
8079     * When in "horizontal mode", items will be placed in @b columns,
8080     * from top to bottom and, when the space for a column is filled,
8081     * another one is started on the right, thus expanding the grid
8082     * horizontally, making for horizontal scrolling. When in "vertical
8083     * mode" , though, items will be placed in @b rows, from left to
8084     * right and, when the space for a row is filled, another one is
8085     * started below, thus expanding the grid vertically (and making
8086     * for vertical scrolling).
8087     *
8088     * @section Gengrid_Items Gengrid items
8089     *
8090     * An item in a gengrid can have 0 or more text labels (they can be
8091     * regular text or textblock Evas objects - that's up to the style
8092     * to determine), 0 or more icons (which are simply objects
8093     * swallowed into the gengrid item's theming Edje object) and 0 or
8094     * more <b>boolean states</b>, which have the behavior left to the
8095     * user to define. The Edje part names for each of these properties
8096     * will be looked up, in the theme file for the gengrid, under the
8097     * Edje (string) data items named @c "labels", @c "icons" and @c
8098     * "states", respectively. For each of those properties, if more
8099     * than one part is provided, they must have names listed separated
8100     * by spaces in the data fields. For the default gengrid item
8101     * theme, we have @b one label part (@c "elm.text"), @b two icon
8102     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8103     * no state parts.
8104     *
8105     * A gengrid item may be at one of several styles. Elementary
8106     * provides one by default - "default", but this can be extended by
8107     * system or application custom themes/overlays/extensions (see
8108     * @ref Theme "themes" for more details).
8109     *
8110     * @section Gengrid_Item_Class Gengrid item classes
8111     *
8112     * In order to have the ability to add and delete items on the fly,
8113     * gengrid implements a class (callback) system where the
8114     * application provides a structure with information about that
8115     * type of item (gengrid may contain multiple different items with
8116     * different classes, states and styles). Gengrid will call the
8117     * functions in this struct (methods) when an item is "realized"
8118     * (i.e., created dynamically, while the user is scrolling the
8119     * grid). All objects will simply be deleted when no longer needed
8120     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8121     * contains the following members:
8122     * - @c item_style - This is a constant string and simply defines
8123     * the name of the item style. It @b must be specified and the
8124     * default should be @c "default".
8125     * - @c func.label_get - This function is called when an item
8126     * object is actually created. The @c data parameter will point to
8127     * the same data passed to elm_gengrid_item_append() and related
8128     * item creation functions. The @c obj parameter is the gengrid
8129     * object itself, while the @c part one is the name string of one
8130     * of the existing text parts in the Edje group implementing the
8131     * item's theme. This function @b must return a strdup'()ed string,
8132     * as the caller will free() it when done. See
8133     * #Elm_Gengrid_Item_Label_Get_Cb.
8134     * - @c func.content_get - This function is called when an item object
8135     * is actually created. The @c data parameter will point to the
8136     * same data passed to elm_gengrid_item_append() and related item
8137     * creation functions. The @c obj parameter is the gengrid object
8138     * itself, while the @c part one is the name string of one of the
8139     * existing (content) swallow parts in the Edje group implementing the
8140     * item's theme. It must return @c NULL, when no content is desired,
8141     * or a valid object handle, otherwise. The object will be deleted
8142     * by the gengrid on its deletion or when the item is "unrealized".
8143     * See #Elm_Gengrid_Item_Content_Get_Cb.
8144     * - @c func.state_get - This function is called when an item
8145     * object is actually created. The @c data parameter will point to
8146     * the same data passed to elm_gengrid_item_append() and related
8147     * item creation functions. The @c obj parameter is the gengrid
8148     * object itself, while the @c part one is the name string of one
8149     * of the state parts in the Edje group implementing the item's
8150     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8151     * true/on. Gengrids will emit a signal to its theming Edje object
8152     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8153     * "source" arguments, respectively, when the state is true (the
8154     * default is false), where @c XXX is the name of the (state) part.
8155     * See #Elm_Gengrid_Item_State_Get_Cb.
8156     * - @c func.del - This is called when elm_gengrid_item_del() is
8157     * called on an item or elm_gengrid_clear() is called on the
8158     * gengrid. This is intended for use when gengrid items are
8159     * deleted, so any data attached to the item (e.g. its data
8160     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8161     *
8162     * @section Gengrid_Usage_Hints Usage hints
8163     *
8164     * If the user wants to have multiple items selected at the same
8165     * time, elm_gengrid_multi_select_set() will permit it. If the
8166     * gengrid is single-selection only (the default), then
8167     * elm_gengrid_select_item_get() will return the selected item or
8168     * @c NULL, if none is selected. If the gengrid is under
8169     * multi-selection, then elm_gengrid_selected_items_get() will
8170     * return a list (that is only valid as long as no items are
8171     * modified (added, deleted, selected or unselected) of child items
8172     * on a gengrid.
8173     *
8174     * If an item changes (internal (boolean) state, label or content 
8175     * changes), then use elm_gengrid_item_update() to have gengrid
8176     * update the item with the new state. A gengrid will re-"realize"
8177     * the item, thus calling the functions in the
8178     * #Elm_Gengrid_Item_Class set for that item.
8179     *
8180     * To programmatically (un)select an item, use
8181     * elm_gengrid_item_selected_set(). To get its selected state use
8182     * elm_gengrid_item_selected_get(). To make an item disabled
8183     * (unable to be selected and appear differently) use
8184     * elm_gengrid_item_disabled_set() to set this and
8185     * elm_gengrid_item_disabled_get() to get the disabled state.
8186     *
8187     * Grid cells will only have their selection smart callbacks called
8188     * when firstly getting selected. Any further clicks will do
8189     * nothing, unless you enable the "always select mode", with
8190     * elm_gengrid_always_select_mode_set(), thus making every click to
8191     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8192     * turn off the ability to select items entirely in the widget and
8193     * they will neither appear selected nor call the selection smart
8194     * callbacks.
8195     *
8196     * Remember that you can create new styles and add your own theme
8197     * augmentation per application with elm_theme_extension_add(). If
8198     * you absolutely must have a specific style that overrides any
8199     * theme the user or system sets up you can use
8200     * elm_theme_overlay_add() to add such a file.
8201     *
8202     * @section Gengrid_Smart_Events Gengrid smart events
8203     *
8204     * Smart events that you can add callbacks for are:
8205     * - @c "activated" - The user has double-clicked or pressed
8206     *   (enter|return|spacebar) on an item. The @c event_info parameter
8207     *   is the gengrid item that was activated.
8208     * - @c "clicked,double" - The user has double-clicked an item.
8209     *   The @c event_info parameter is the gengrid item that was double-clicked.
8210     * - @c "longpressed" - This is called when the item is pressed for a certain
8211     *   amount of time. By default it's 1 second.
8212     * - @c "selected" - The user has made an item selected. The
8213     *   @c event_info parameter is the gengrid item that was selected.
8214     * - @c "unselected" - The user has made an item unselected. The
8215     *   @c event_info parameter is the gengrid item that was unselected.
8216     * - @c "realized" - This is called when the item in the gengrid
8217     *   has its implementing Evas object instantiated, de facto. @c
8218     *   event_info is the gengrid item that was created. The object
8219     *   may be deleted at any time, so it is highly advised to the
8220     *   caller @b not to use the object pointer returned from
8221     *   elm_gengrid_item_object_get(), because it may point to freed
8222     *   objects.
8223     * - @c "unrealized" - This is called when the implementing Evas
8224     *   object for this item is deleted. @c event_info is the gengrid
8225     *   item that was deleted.
8226     * - @c "changed" - Called when an item is added, removed, resized
8227     *   or moved and when the gengrid is resized or gets "horizontal"
8228     *   property changes.
8229     * - @c "scroll,anim,start" - This is called when scrolling animation has
8230     *   started.
8231     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8232     *   stopped.
8233     * - @c "drag,start,up" - Called when the item in the gengrid has
8234     *   been dragged (not scrolled) up.
8235     * - @c "drag,start,down" - Called when the item in the gengrid has
8236     *   been dragged (not scrolled) down.
8237     * - @c "drag,start,left" - Called when the item in the gengrid has
8238     *   been dragged (not scrolled) left.
8239     * - @c "drag,start,right" - Called when the item in the gengrid has
8240     *   been dragged (not scrolled) right.
8241     * - @c "drag,stop" - Called when the item in the gengrid has
8242     *   stopped being dragged.
8243     * - @c "drag" - Called when the item in the gengrid is being
8244     *   dragged.
8245     * - @c "scroll" - called when the content has been scrolled
8246     *   (moved).
8247     * - @c "scroll,drag,start" - called when dragging the content has
8248     *   started.
8249     * - @c "scroll,drag,stop" - called when dragging the content has
8250     *   stopped.
8251     * - @c "edge,top" - This is called when the gengrid is scrolled until
8252     *   the top edge.
8253     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8254     *   until the bottom edge.
8255     * - @c "edge,left" - This is called when the gengrid is scrolled
8256     *   until the left edge.
8257     * - @c "edge,right" - This is called when the gengrid is scrolled
8258     *   until the right edge.
8259     *
8260     * List of gengrid examples:
8261     * @li @ref gengrid_example
8262     */
8263
8264    /**
8265     * @addtogroup Gengrid
8266     * @{
8267     */
8268
8269    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8270    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8271    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8272    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8273    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8274    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
8275    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8276
8277    /* temporary compatibility code */
8278    typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8279    typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8280    typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8281    typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8282
8283    /**
8284     * @struct _Elm_Gengrid_Item_Class
8285     *
8286     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8287     * field details.
8288     */
8289    struct _Elm_Gengrid_Item_Class
8290      {
8291         const char             *item_style;
8292         struct _Elm_Gengrid_Item_Class_Func
8293           {
8294              Elm_Gengrid_Item_Label_Get_Cb label_get;
8295              union { /* temporary compatibility code */
8296                Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8297                Elm_Gengrid_Item_Content_Get_Cb content_get;
8298              };
8299              Elm_Gengrid_Item_State_Get_Cb state_get;
8300              Elm_Gengrid_Item_Del_Cb       del;
8301           } func;
8302      }; /**< #Elm_Gengrid_Item_Class member definitions */
8303    /**
8304     * Add a new gengrid widget to the given parent Elementary
8305     * (container) object
8306     *
8307     * @param parent The parent object
8308     * @return a new gengrid widget handle or @c NULL, on errors
8309     *
8310     * This function inserts a new gengrid widget on the canvas.
8311     *
8312     * @see elm_gengrid_item_size_set()
8313     * @see elm_gengrid_group_item_size_set()
8314     * @see elm_gengrid_horizontal_set()
8315     * @see elm_gengrid_item_append()
8316     * @see elm_gengrid_item_del()
8317     * @see elm_gengrid_clear()
8318     *
8319     * @ingroup Gengrid
8320     */
8321    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8322
8323    /**
8324     * Set the size for the items of a given gengrid widget
8325     *
8326     * @param obj The gengrid object.
8327     * @param w The items' width.
8328     * @param h The items' height;
8329     *
8330     * A gengrid, after creation, has still no information on the size
8331     * to give to each of its cells. So, you most probably will end up
8332     * with squares one @ref Fingers "finger" wide, the default
8333     * size. Use this function to force a custom size for you items,
8334     * making them as big as you wish.
8335     *
8336     * @see elm_gengrid_item_size_get()
8337     *
8338     * @ingroup Gengrid
8339     */
8340    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8341
8342    /**
8343     * Get the size set for the items of a given gengrid widget
8344     *
8345     * @param obj The gengrid object.
8346     * @param w Pointer to a variable where to store the items' width.
8347     * @param h Pointer to a variable where to store the items' height.
8348     *
8349     * @note Use @c NULL pointers on the size values you're not
8350     * interested in: they'll be ignored by the function.
8351     *
8352     * @see elm_gengrid_item_size_get() for more details
8353     *
8354     * @ingroup Gengrid
8355     */
8356    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8357
8358    /**
8359     * Set the items grid's alignment within a given gengrid widget
8360     *
8361     * @param obj The gengrid object.
8362     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8363     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8364     *
8365     * This sets the alignment of the whole grid of items of a gengrid
8366     * within its given viewport. By default, those values are both
8367     * 0.5, meaning that the gengrid will have its items grid placed
8368     * exactly in the middle of its viewport.
8369     *
8370     * @note If given alignment values are out of the cited ranges,
8371     * they'll be changed to the nearest boundary values on the valid
8372     * ranges.
8373     *
8374     * @see elm_gengrid_align_get()
8375     *
8376     * @ingroup Gengrid
8377     */
8378    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8379
8380    /**
8381     * Get the items grid's alignment values within a given gengrid
8382     * widget
8383     *
8384     * @param obj The gengrid object.
8385     * @param align_x Pointer to a variable where to store the
8386     * horizontal alignment.
8387     * @param align_y Pointer to a variable where to store the vertical
8388     * alignment.
8389     *
8390     * @note Use @c NULL pointers on the alignment values you're not
8391     * interested in: they'll be ignored by the function.
8392     *
8393     * @see elm_gengrid_align_set() for more details
8394     *
8395     * @ingroup Gengrid
8396     */
8397    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8398
8399    /**
8400     * Set whether a given gengrid widget is or not able have items
8401     * @b reordered
8402     *
8403     * @param obj The gengrid object
8404     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8405     * @c EINA_FALSE to turn it off
8406     *
8407     * If a gengrid is set to allow reordering, a click held for more
8408     * than 0.5 over a given item will highlight it specially,
8409     * signalling the gengrid has entered the reordering state. From
8410     * that time on, the user will be able to, while still holding the
8411     * mouse button down, move the item freely in the gengrid's
8412     * viewport, replacing to said item to the locations it goes to.
8413     * The replacements will be animated and, whenever the user
8414     * releases the mouse button, the item being replaced gets a new
8415     * definitive place in the grid.
8416     *
8417     * @see elm_gengrid_reorder_mode_get()
8418     *
8419     * @ingroup Gengrid
8420     */
8421    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8422
8423    /**
8424     * Get whether a given gengrid widget is or not able have items
8425     * @b reordered
8426     *
8427     * @param obj The gengrid object
8428     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8429     * off
8430     *
8431     * @see elm_gengrid_reorder_mode_set() for more details
8432     *
8433     * @ingroup Gengrid
8434     */
8435    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8436
8437    /**
8438     * Append a new item in a given gengrid widget.
8439     *
8440     * @param obj The gengrid object.
8441     * @param gic The item class for the item.
8442     * @param data The item data.
8443     * @param func Convenience function called when the item is
8444     * selected.
8445     * @param func_data Data to be passed to @p func.
8446     * @return A handle to the item added or @c NULL, on errors.
8447     *
8448     * This adds an item to the beginning of the gengrid.
8449     *
8450     * @see elm_gengrid_item_prepend()
8451     * @see elm_gengrid_item_insert_before()
8452     * @see elm_gengrid_item_insert_after()
8453     * @see elm_gengrid_item_del()
8454     *
8455     * @ingroup Gengrid
8456     */
8457    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);
8458
8459    /**
8460     * Prepend a new item in a given gengrid widget.
8461     *
8462     * @param obj The gengrid object.
8463     * @param gic The item class for the item.
8464     * @param data The item data.
8465     * @param func Convenience function called when the item is
8466     * selected.
8467     * @param func_data Data to be passed to @p func.
8468     * @return A handle to the item added or @c NULL, on errors.
8469     *
8470     * This adds an item to the end of the gengrid.
8471     *
8472     * @see elm_gengrid_item_append()
8473     * @see elm_gengrid_item_insert_before()
8474     * @see elm_gengrid_item_insert_after()
8475     * @see elm_gengrid_item_del()
8476     *
8477     * @ingroup Gengrid
8478     */
8479    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);
8480
8481    /**
8482     * Insert an item before another in a gengrid widget
8483     *
8484     * @param obj The gengrid object.
8485     * @param gic The item class for the item.
8486     * @param data The item data.
8487     * @param relative The item to place this new one before.
8488     * @param func Convenience function called when the item is
8489     * selected.
8490     * @param func_data Data to be passed to @p func.
8491     * @return A handle to the item added or @c NULL, on errors.
8492     *
8493     * This inserts an item before another in the gengrid.
8494     *
8495     * @see elm_gengrid_item_append()
8496     * @see elm_gengrid_item_prepend()
8497     * @see elm_gengrid_item_insert_after()
8498     * @see elm_gengrid_item_del()
8499     *
8500     * @ingroup Gengrid
8501     */
8502    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);
8503
8504    /**
8505     * Insert an item after another in a gengrid widget
8506     *
8507     * @param obj The gengrid object.
8508     * @param gic The item class for the item.
8509     * @param data The item data.
8510     * @param relative The item to place this new one after.
8511     * @param func Convenience function called when the item is
8512     * selected.
8513     * @param func_data Data to be passed to @p func.
8514     * @return A handle to the item added or @c NULL, on errors.
8515     *
8516     * This inserts an item after another in the gengrid.
8517     *
8518     * @see elm_gengrid_item_append()
8519     * @see elm_gengrid_item_prepend()
8520     * @see elm_gengrid_item_insert_after()
8521     * @see elm_gengrid_item_del()
8522     *
8523     * @ingroup Gengrid
8524     */
8525    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);
8526
8527    /**
8528     * Insert an item in a gengrid widget using a user-defined sort function.
8529     *
8530     * @param obj The gengrid object.
8531     * @param gic The item class for the item.
8532     * @param data The item data.
8533     * @param comp User defined comparison function that defines the sort order based on
8534     * Elm_Gen_Item and its data param.
8535     * @param func Convenience function called when the item is selected.
8536     * @param func_data Data to be passed to @p func.
8537     * @return A handle to the item added or @c NULL, on errors.
8538     *
8539     * This inserts an item in the gengrid based on user defined comparison function.
8540     *
8541     * @see elm_gengrid_item_append()
8542     * @see elm_gengrid_item_prepend()
8543     * @see elm_gengrid_item_insert_after()
8544     * @see elm_gengrid_item_del()
8545     * @see elm_gengrid_item_direct_sorted_insert()
8546     *
8547     * @ingroup Gengrid
8548     */
8549    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);
8550
8551    /**
8552     * Insert an item in a gengrid widget using a user-defined sort function.
8553     *
8554     * @param obj The gengrid object.
8555     * @param gic The item class for the item.
8556     * @param data The item data.
8557     * @param comp User defined comparison function that defines the sort order based on
8558     * Elm_Gen_Item.
8559     * @param func Convenience function called when the item is selected.
8560     * @param func_data Data to be passed to @p func.
8561     * @return A handle to the item added or @c NULL, on errors.
8562     *
8563     * This inserts an item in the gengrid based on user defined comparison function.
8564     *
8565     * @see elm_gengrid_item_append()
8566     * @see elm_gengrid_item_prepend()
8567     * @see elm_gengrid_item_insert_after()
8568     * @see elm_gengrid_item_del()
8569     * @see elm_gengrid_item_sorted_insert()
8570     *
8571     * @ingroup Gengrid
8572     */
8573    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);
8574
8575    /**
8576     * Set whether items on a given gengrid widget are to get their
8577     * selection callbacks issued for @b every subsequent selection
8578     * click on them or just for the first click.
8579     *
8580     * @param obj The gengrid object
8581     * @param always_select @c EINA_TRUE to make items "always
8582     * selected", @c EINA_FALSE, otherwise
8583     *
8584     * By default, grid items will only call their selection callback
8585     * function when firstly getting selected, any subsequent further
8586     * clicks will do nothing. With this call, you make those
8587     * subsequent clicks also to issue the selection callbacks.
8588     *
8589     * @note <b>Double clicks</b> will @b always be reported on items.
8590     *
8591     * @see elm_gengrid_always_select_mode_get()
8592     *
8593     * @ingroup Gengrid
8594     */
8595    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8596
8597    /**
8598     * Get whether items on a given gengrid widget have their selection
8599     * callbacks issued for @b every subsequent selection click on them
8600     * or just for the first click.
8601     *
8602     * @param obj The gengrid object.
8603     * @return @c EINA_TRUE if the gengrid items are "always selected",
8604     * @c EINA_FALSE, otherwise
8605     *
8606     * @see elm_gengrid_always_select_mode_set() for more details
8607     *
8608     * @ingroup Gengrid
8609     */
8610    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8611
8612    /**
8613     * Set whether items on a given gengrid widget can be selected or not.
8614     *
8615     * @param obj The gengrid object
8616     * @param no_select @c EINA_TRUE to make items selectable,
8617     * @c EINA_FALSE otherwise
8618     *
8619     * This will make items in @p obj selectable or not. In the latter
8620     * case, any user interaction on the gengrid items will neither make
8621     * them appear selected nor them call their selection callback
8622     * functions.
8623     *
8624     * @see elm_gengrid_no_select_mode_get()
8625     *
8626     * @ingroup Gengrid
8627     */
8628    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8629
8630    /**
8631     * Get whether items on a given gengrid widget can be selected or
8632     * not.
8633     *
8634     * @param obj The gengrid object
8635     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8636     * otherwise
8637     *
8638     * @see elm_gengrid_no_select_mode_set() for more details
8639     *
8640     * @ingroup Gengrid
8641     */
8642    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8643
8644    /**
8645     * Enable or disable multi-selection in a given gengrid widget
8646     *
8647     * @param obj The gengrid object.
8648     * @param multi @c EINA_TRUE, to enable multi-selection,
8649     * @c EINA_FALSE to disable it.
8650     *
8651     * Multi-selection is the ability to have @b more than one
8652     * item selected, on a given gengrid, simultaneously. When it is
8653     * enabled, a sequence of clicks on different items will make them
8654     * all selected, progressively. A click on an already selected item
8655     * will unselect it. If interacting via the keyboard,
8656     * multi-selection is enabled while holding the "Shift" key.
8657     *
8658     * @note By default, multi-selection is @b disabled on gengrids
8659     *
8660     * @see elm_gengrid_multi_select_get()
8661     *
8662     * @ingroup Gengrid
8663     */
8664    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8665
8666    /**
8667     * Get whether multi-selection is enabled or disabled for a given
8668     * gengrid widget
8669     *
8670     * @param obj The gengrid object.
8671     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8672     * EINA_FALSE otherwise
8673     *
8674     * @see elm_gengrid_multi_select_set() for more details
8675     *
8676     * @ingroup Gengrid
8677     */
8678    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8679
8680    /**
8681     * Enable or disable bouncing effect for a given gengrid widget
8682     *
8683     * @param obj The gengrid object
8684     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8685     * @c EINA_FALSE to disable it
8686     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8687     * @c EINA_FALSE to disable it
8688     *
8689     * The bouncing effect occurs whenever one reaches the gengrid's
8690     * edge's while panning it -- it will scroll past its limits a
8691     * little bit and return to the edge again, in a animated for,
8692     * automatically.
8693     *
8694     * @note By default, gengrids have bouncing enabled on both axis
8695     *
8696     * @see elm_gengrid_bounce_get()
8697     *
8698     * @ingroup Gengrid
8699     */
8700    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8701
8702    /**
8703     * Get whether bouncing effects are enabled or disabled, for a
8704     * given gengrid widget, on each axis
8705     *
8706     * @param obj The gengrid object
8707     * @param h_bounce Pointer to a variable where to store the
8708     * horizontal bouncing flag.
8709     * @param v_bounce Pointer to a variable where to store the
8710     * vertical bouncing flag.
8711     *
8712     * @see elm_gengrid_bounce_set() for more details
8713     *
8714     * @ingroup Gengrid
8715     */
8716    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8717
8718    /**
8719     * Set a given gengrid widget's scrolling page size, relative to
8720     * its viewport size.
8721     *
8722     * @param obj The gengrid object
8723     * @param h_pagerel The horizontal page (relative) size
8724     * @param v_pagerel The vertical page (relative) size
8725     *
8726     * The gengrid's scroller is capable of binding scrolling by the
8727     * user to "pages". It means that, while scrolling and, specially
8728     * after releasing the mouse button, the grid will @b snap to the
8729     * nearest displaying page's area. When page sizes are set, the
8730     * grid's continuous content area is split into (equal) page sized
8731     * pieces.
8732     *
8733     * This function sets the size of a page <b>relatively to the
8734     * viewport dimensions</b> of the gengrid, for each axis. A value
8735     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8736     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8737     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8738     * 1.0. Values beyond those will make it behave behave
8739     * inconsistently. If you only want one axis to snap to pages, use
8740     * the value @c 0.0 for the other one.
8741     *
8742     * There is a function setting page size values in @b absolute
8743     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8744     * is mutually exclusive to this one.
8745     *
8746     * @see elm_gengrid_page_relative_get()
8747     *
8748     * @ingroup Gengrid
8749     */
8750    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8751
8752    /**
8753     * Get a given gengrid widget's scrolling page size, relative to
8754     * its viewport size.
8755     *
8756     * @param obj The gengrid object
8757     * @param h_pagerel Pointer to a variable where to store the
8758     * horizontal page (relative) size
8759     * @param v_pagerel Pointer to a variable where to store the
8760     * vertical page (relative) size
8761     *
8762     * @see elm_gengrid_page_relative_set() for more details
8763     *
8764     * @ingroup Gengrid
8765     */
8766    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8767
8768    /**
8769     * Set a given gengrid widget's scrolling page size
8770     *
8771     * @param obj The gengrid object
8772     * @param h_pagerel The horizontal page size, in pixels
8773     * @param v_pagerel The vertical page size, in pixels
8774     *
8775     * The gengrid's scroller is capable of binding scrolling by the
8776     * user to "pages". It means that, while scrolling and, specially
8777     * after releasing the mouse button, the grid will @b snap to the
8778     * nearest displaying page's area. When page sizes are set, the
8779     * grid's continuous content area is split into (equal) page sized
8780     * pieces.
8781     *
8782     * This function sets the size of a page of the gengrid, in pixels,
8783     * for each axis. Sane usable values are, between @c 0 and the
8784     * dimensions of @p obj, for each axis. Values beyond those will
8785     * make it behave behave inconsistently. If you only want one axis
8786     * to snap to pages, use the value @c 0 for the other one.
8787     *
8788     * There is a function setting page size values in @b relative
8789     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8790     * use is mutually exclusive to this one.
8791     *
8792     * @ingroup Gengrid
8793     */
8794    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8795
8796    /**
8797     * Set the direction in which a given gengrid widget will expand while
8798     * placing its items.
8799     *
8800     * @param obj The gengrid object.
8801     * @param setting @c EINA_TRUE to make the gengrid expand
8802     * horizontally, @c EINA_FALSE to expand vertically.
8803     *
8804     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8805     * in @b columns, from top to bottom and, when the space for a
8806     * column is filled, another one is started on the right, thus
8807     * expanding the grid horizontally. When in "vertical mode"
8808     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8809     * to right and, when the space for a row is filled, another one is
8810     * started below, thus expanding the grid vertically.
8811     *
8812     * @see elm_gengrid_horizontal_get()
8813     *
8814     * @ingroup Gengrid
8815     */
8816    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8817
8818    /**
8819     * Get for what direction a given gengrid widget will expand while
8820     * placing its items.
8821     *
8822     * @param obj The gengrid object.
8823     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8824     * @c EINA_FALSE if it's set to expand vertically.
8825     *
8826     * @see elm_gengrid_horizontal_set() for more detais
8827     *
8828     * @ingroup Gengrid
8829     */
8830    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8831
8832    /**
8833     * Get the first item in a given gengrid widget
8834     *
8835     * @param obj The gengrid object
8836     * @return The first item's handle or @c NULL, if there are no
8837     * items in @p obj (and on errors)
8838     *
8839     * This returns the first item in the @p obj's internal list of
8840     * items.
8841     *
8842     * @see elm_gengrid_last_item_get()
8843     *
8844     * @ingroup Gengrid
8845     */
8846    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8847
8848    /**
8849     * Get the last item in a given gengrid widget
8850     *
8851     * @param obj The gengrid object
8852     * @return The last item's handle or @c NULL, if there are no
8853     * items in @p obj (and on errors)
8854     *
8855     * This returns the last item in the @p obj's internal list of
8856     * items.
8857     *
8858     * @see elm_gengrid_first_item_get()
8859     *
8860     * @ingroup Gengrid
8861     */
8862    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8863
8864    /**
8865     * Get the @b next item in a gengrid widget's internal list of items,
8866     * given a handle to one of those items.
8867     *
8868     * @param item The gengrid item to fetch next from
8869     * @return The item after @p item, or @c NULL if there's none (and
8870     * on errors)
8871     *
8872     * This returns the item placed after the @p item, on the container
8873     * gengrid.
8874     *
8875     * @see elm_gengrid_item_prev_get()
8876     *
8877     * @ingroup Gengrid
8878     */
8879    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8880
8881    /**
8882     * Get the @b previous item in a gengrid widget's internal list of items,
8883     * given a handle to one of those items.
8884     *
8885     * @param item The gengrid item to fetch previous from
8886     * @return The item before @p item, or @c NULL if there's none (and
8887     * on errors)
8888     *
8889     * This returns the item placed before the @p item, on the container
8890     * gengrid.
8891     *
8892     * @see elm_gengrid_item_next_get()
8893     *
8894     * @ingroup Gengrid
8895     */
8896    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8897
8898    /**
8899     * Get the gengrid object's handle which contains a given gengrid
8900     * item
8901     *
8902     * @param item The item to fetch the container from
8903     * @return The gengrid (parent) object
8904     *
8905     * This returns the gengrid object itself that an item belongs to.
8906     *
8907     * @ingroup Gengrid
8908     */
8909    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8910
8911    /**
8912     * Remove a gengrid item from its parent, deleting it.
8913     *
8914     * @param item The item to be removed.
8915     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8916     *
8917     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8918     * once.
8919     *
8920     * @ingroup Gengrid
8921     */
8922    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8923
8924    /**
8925     * Update the contents of a given gengrid item
8926     *
8927     * @param item The gengrid item
8928     *
8929     * This updates an item by calling all the item class functions
8930     * again to get the contents, labels and states. Use this when the
8931     * original item data has changed and you want the changes to be
8932     * reflected.
8933     *
8934     * @ingroup Gengrid
8935     */
8936    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8937
8938    /**
8939     * Get the Gengrid Item class for the given Gengrid Item.
8940     *
8941     * @param item The gengrid item
8942     *
8943     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8944     * the function pointers and item_style.
8945     *
8946     * @ingroup Gengrid
8947     */
8948    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8949
8950    /**
8951     * Get the Gengrid Item class for the given Gengrid Item.
8952     *
8953     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8954     * the function pointers and item_style.
8955     *
8956     * @param item The gengrid item
8957     * @param gic The gengrid item class describing the function pointers and the item style.
8958     *
8959     * @ingroup Gengrid
8960     */
8961    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8962
8963    /**
8964     * Return the data associated to a given gengrid item
8965     *
8966     * @param item The gengrid item.
8967     * @return the data associated with this item.
8968     *
8969     * This returns the @c data value passed on the
8970     * elm_gengrid_item_append() and related item addition calls.
8971     *
8972     * @see elm_gengrid_item_append()
8973     * @see elm_gengrid_item_data_set()
8974     *
8975     * @ingroup Gengrid
8976     */
8977    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8978
8979    /**
8980     * Set the data associated with a given gengrid item
8981     *
8982     * @param item The gengrid item
8983     * @param data The data pointer to set on it
8984     *
8985     * This @b overrides the @c data value passed on the
8986     * elm_gengrid_item_append() and related item addition calls. This
8987     * function @b won't call elm_gengrid_item_update() automatically,
8988     * so you'd issue it afterwards if you want to have the item
8989     * updated to reflect the new data.
8990     *
8991     * @see elm_gengrid_item_data_get()
8992     * @see elm_gengrid_item_update()
8993     *
8994     * @ingroup Gengrid
8995     */
8996    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8997
8998    /**
8999     * Get a given gengrid item's position, relative to the whole
9000     * gengrid's grid area.
9001     *
9002     * @param item The Gengrid item.
9003     * @param x Pointer to variable to store the item's <b>row number</b>.
9004     * @param y Pointer to variable to store the item's <b>column number</b>.
9005     *
9006     * This returns the "logical" position of the item within the
9007     * gengrid. For example, @c (0, 1) would stand for first row,
9008     * second column.
9009     *
9010     * @ingroup Gengrid
9011     */
9012    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9013
9014    /**
9015     * Set whether a given gengrid item is selected or not
9016     *
9017     * @param item The gengrid item
9018     * @param selected Use @c EINA_TRUE, to make it selected, @c
9019     * EINA_FALSE to make it unselected
9020     *
9021     * This sets the selected state of an item. If multi-selection is
9022     * not enabled on the containing gengrid and @p selected is @c
9023     * EINA_TRUE, any other previously selected items will get
9024     * unselected in favor of this new one.
9025     *
9026     * @see elm_gengrid_item_selected_get()
9027     *
9028     * @ingroup Gengrid
9029     */
9030    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9031
9032    /**
9033     * Get whether a given gengrid item is selected or not
9034     *
9035     * @param item The gengrid item
9036     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9037     *
9038     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9039     *
9040     * @see elm_gengrid_item_selected_set() for more details
9041     *
9042     * @ingroup Gengrid
9043     */
9044    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9045
9046    /**
9047     * Get the real Evas object created to implement the view of a
9048     * given gengrid item
9049     *
9050     * @param item The gengrid item.
9051     * @return the Evas object implementing this item's view.
9052     *
9053     * This returns the actual Evas object used to implement the
9054     * specified gengrid item's view. This may be @c NULL, as it may
9055     * not have been created or may have been deleted, at any time, by
9056     * the gengrid. <b>Do not modify this object</b> (move, resize,
9057     * show, hide, etc.), as the gengrid is controlling it. This
9058     * function is for querying, emitting custom signals or hooking
9059     * lower level callbacks for events on that object. Do not delete
9060     * this object under any circumstances.
9061     *
9062     * @see elm_gengrid_item_data_get()
9063     *
9064     * @ingroup Gengrid
9065     */
9066    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9067
9068    /**
9069     * Show the portion of a gengrid's internal grid containing a given
9070     * item, @b immediately.
9071     *
9072     * @param item The item to display
9073     *
9074     * This causes gengrid to @b redraw its viewport's contents to the
9075     * region contining the given @p item item, if it is not fully
9076     * visible.
9077     *
9078     * @see elm_gengrid_item_bring_in()
9079     *
9080     * @ingroup Gengrid
9081     */
9082    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9083
9084    /**
9085     * Animatedly bring in, to the visible area of a gengrid, a given
9086     * item on it.
9087     *
9088     * @param item The gengrid item to display
9089     *
9090     * This causes gengrid to jump to the given @p item and show
9091     * it (by scrolling), if it is not fully visible. This will use
9092     * animation to do so and take a period of time to complete.
9093     *
9094     * @see elm_gengrid_item_show()
9095     *
9096     * @ingroup Gengrid
9097     */
9098    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9099
9100    /**
9101     * Set whether a given gengrid item is disabled or not.
9102     *
9103     * @param item The gengrid item
9104     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9105     * to enable it back.
9106     *
9107     * A disabled item cannot be selected or unselected. It will also
9108     * change its appearance, to signal the user it's disabled.
9109     *
9110     * @see elm_gengrid_item_disabled_get()
9111     *
9112     * @ingroup Gengrid
9113     */
9114    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9115
9116    /**
9117     * Get whether a given gengrid item is disabled or not.
9118     *
9119     * @param item The gengrid item
9120     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9121     * (and on errors).
9122     *
9123     * @see elm_gengrid_item_disabled_set() for more details
9124     *
9125     * @ingroup Gengrid
9126     */
9127    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9128
9129    /**
9130     * Set the text to be shown in a given gengrid item's tooltips.
9131     *
9132     * @param item The gengrid item
9133     * @param text The text to set in the content
9134     *
9135     * This call will setup the text to be used as tooltip to that item
9136     * (analogous to elm_object_tooltip_text_set(), but being item
9137     * tooltips with higher precedence than object tooltips). It can
9138     * have only one tooltip at a time, so any previous tooltip data
9139     * will get removed.
9140     *
9141     * @ingroup Gengrid
9142     */
9143    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9144
9145    /**
9146     * Set the content to be shown in a given gengrid item's tooltip
9147     *
9148     * @param item The gengrid item.
9149     * @param func The function returning the tooltip contents.
9150     * @param data What to provide to @a func as callback data/context.
9151     * @param del_cb Called when data is not needed anymore, either when
9152     *        another callback replaces @p func, the tooltip is unset with
9153     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9154     *        dies. This callback receives as its first parameter the
9155     *        given @p data, being @c event_info the item handle.
9156     *
9157     * This call will setup the tooltip's contents to @p item
9158     * (analogous to elm_object_tooltip_content_cb_set(), but being
9159     * item tooltips with higher precedence than object tooltips). It
9160     * can have only one tooltip at a time, so any previous tooltip
9161     * content will get removed. @p func (with @p data) will be called
9162     * every time Elementary needs to show the tooltip and it should
9163     * return a valid Evas object, which will be fully managed by the
9164     * tooltip system, getting deleted when the tooltip is gone.
9165     *
9166     * @ingroup Gengrid
9167     */
9168    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);
9169
9170    /**
9171     * Unset a tooltip from a given gengrid item
9172     *
9173     * @param item gengrid item to remove a previously set tooltip from.
9174     *
9175     * This call removes any tooltip set on @p item. The callback
9176     * provided as @c del_cb to
9177     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9178     * notify it is not used anymore (and have resources cleaned, if
9179     * need be).
9180     *
9181     * @see elm_gengrid_item_tooltip_content_cb_set()
9182     *
9183     * @ingroup Gengrid
9184     */
9185    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9186
9187    /**
9188     * Set a different @b style for a given gengrid item's tooltip.
9189     *
9190     * @param item gengrid item with tooltip set
9191     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9192     * "default", @c "transparent", etc)
9193     *
9194     * Tooltips can have <b>alternate styles</b> to be displayed on,
9195     * which are defined by the theme set on Elementary. This function
9196     * works analogously as elm_object_tooltip_style_set(), but here
9197     * applied only to gengrid item objects. The default style for
9198     * tooltips is @c "default".
9199     *
9200     * @note before you set a style you should define a tooltip with
9201     *       elm_gengrid_item_tooltip_content_cb_set() or
9202     *       elm_gengrid_item_tooltip_text_set()
9203     *
9204     * @see elm_gengrid_item_tooltip_style_get()
9205     *
9206     * @ingroup Gengrid
9207     */
9208    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9209
9210    /**
9211     * Get the style set a given gengrid item's tooltip.
9212     *
9213     * @param item gengrid item with tooltip already set on.
9214     * @return style the theme style in use, which defaults to
9215     *         "default". If the object does not have a tooltip set,
9216     *         then @c NULL is returned.
9217     *
9218     * @see elm_gengrid_item_tooltip_style_set() for more details
9219     *
9220     * @ingroup Gengrid
9221     */
9222    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9223    /**
9224     * Set the type of mouse pointer/cursor decoration to be shown,
9225     * when the mouse pointer is over the given gengrid widget item
9226     *
9227     * @param item gengrid item to customize cursor on
9228     * @param cursor the cursor type's name
9229     *
9230     * This function works analogously as elm_object_cursor_set(), but
9231     * here the cursor's changing area is restricted to the item's
9232     * area, and not the whole widget's. Note that that item cursors
9233     * have precedence over widget cursors, so that a mouse over @p
9234     * item will always show cursor @p type.
9235     *
9236     * If this function is called twice for an object, a previously set
9237     * cursor will be unset on the second call.
9238     *
9239     * @see elm_object_cursor_set()
9240     * @see elm_gengrid_item_cursor_get()
9241     * @see elm_gengrid_item_cursor_unset()
9242     *
9243     * @ingroup Gengrid
9244     */
9245    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9246
9247    /**
9248     * Get the type of mouse pointer/cursor decoration set to be shown,
9249     * when the mouse pointer is over the given gengrid widget item
9250     *
9251     * @param item gengrid item with custom cursor set
9252     * @return the cursor type's name or @c NULL, if no custom cursors
9253     * were set to @p item (and on errors)
9254     *
9255     * @see elm_object_cursor_get()
9256     * @see elm_gengrid_item_cursor_set() for more details
9257     * @see elm_gengrid_item_cursor_unset()
9258     *
9259     * @ingroup Gengrid
9260     */
9261    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9262
9263    /**
9264     * Unset any custom mouse pointer/cursor decoration set to be
9265     * shown, when the mouse pointer is over the given gengrid widget
9266     * item, thus making it show the @b default cursor again.
9267     *
9268     * @param item a gengrid item
9269     *
9270     * Use this call to undo any custom settings on this item's cursor
9271     * decoration, bringing it back to defaults (no custom style set).
9272     *
9273     * @see elm_object_cursor_unset()
9274     * @see elm_gengrid_item_cursor_set() for more details
9275     *
9276     * @ingroup Gengrid
9277     */
9278    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9279
9280    /**
9281     * Set a different @b style for a given custom cursor set for a
9282     * gengrid item.
9283     *
9284     * @param item gengrid item with custom cursor set
9285     * @param style the <b>theme style</b> to use (e.g. @c "default",
9286     * @c "transparent", etc)
9287     *
9288     * This function only makes sense when one is using custom mouse
9289     * cursor decorations <b>defined in a theme file</b> , which can
9290     * have, given a cursor name/type, <b>alternate styles</b> on
9291     * it. It works analogously as elm_object_cursor_style_set(), but
9292     * here applied only to gengrid item objects.
9293     *
9294     * @warning Before you set a cursor style you should have defined a
9295     *       custom cursor previously on the item, with
9296     *       elm_gengrid_item_cursor_set()
9297     *
9298     * @see elm_gengrid_item_cursor_engine_only_set()
9299     * @see elm_gengrid_item_cursor_style_get()
9300     *
9301     * @ingroup Gengrid
9302     */
9303    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9304
9305    /**
9306     * Get the current @b style set for a given gengrid item's custom
9307     * cursor
9308     *
9309     * @param item gengrid item with custom cursor set.
9310     * @return style the cursor style in use. If the object does not
9311     *         have a cursor set, then @c NULL is returned.
9312     *
9313     * @see elm_gengrid_item_cursor_style_set() for more details
9314     *
9315     * @ingroup Gengrid
9316     */
9317    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9318
9319    /**
9320     * Set if the (custom) cursor for a given gengrid item should be
9321     * searched in its theme, also, or should only rely on the
9322     * rendering engine.
9323     *
9324     * @param item item with custom (custom) cursor already set on
9325     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9326     * only on those provided by the rendering engine, @c EINA_FALSE to
9327     * have them searched on the widget's theme, as well.
9328     *
9329     * @note This call is of use only if you've set a custom cursor
9330     * for gengrid items, with elm_gengrid_item_cursor_set().
9331     *
9332     * @note By default, cursors will only be looked for between those
9333     * provided by the rendering engine.
9334     *
9335     * @ingroup Gengrid
9336     */
9337    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9338
9339    /**
9340     * Get if the (custom) cursor for a given gengrid item is being
9341     * searched in its theme, also, or is only relying on the rendering
9342     * engine.
9343     *
9344     * @param item a gengrid item
9345     * @return @c EINA_TRUE, if cursors are being looked for only on
9346     * those provided by the rendering engine, @c EINA_FALSE if they
9347     * are being searched on the widget's theme, as well.
9348     *
9349     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9350     *
9351     * @ingroup Gengrid
9352     */
9353    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9354
9355    /**
9356     * Remove all items from a given gengrid widget
9357     *
9358     * @param obj The gengrid object.
9359     *
9360     * This removes (and deletes) all items in @p obj, leaving it
9361     * empty.
9362     *
9363     * @see elm_gengrid_item_del(), to remove just one item.
9364     *
9365     * @ingroup Gengrid
9366     */
9367    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9368
9369    /**
9370     * Get the selected item in a given gengrid widget
9371     *
9372     * @param obj The gengrid object.
9373     * @return The selected item's handleor @c NULL, if none is
9374     * selected at the moment (and on errors)
9375     *
9376     * This returns the selected item in @p obj. If multi selection is
9377     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9378     * the first item in the list is selected, which might not be very
9379     * useful. For that case, see elm_gengrid_selected_items_get().
9380     *
9381     * @ingroup Gengrid
9382     */
9383    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9384
9385    /**
9386     * Get <b>a list</b> of selected items in a given gengrid
9387     *
9388     * @param obj The gengrid object.
9389     * @return The list of selected items or @c NULL, if none is
9390     * selected at the moment (and on errors)
9391     *
9392     * This returns a list of the selected items, in the order that
9393     * they appear in the grid. This list is only valid as long as no
9394     * more items are selected or unselected (or unselected implictly
9395     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9396     * data, naturally.
9397     *
9398     * @see elm_gengrid_selected_item_get()
9399     *
9400     * @ingroup Gengrid
9401     */
9402    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9403
9404    /**
9405     * @}
9406     */
9407
9408    /**
9409     * @defgroup Clock Clock
9410     *
9411     * @image html img/widget/clock/preview-00.png
9412     * @image latex img/widget/clock/preview-00.eps
9413     *
9414     * This is a @b digital clock widget. In its default theme, it has a
9415     * vintage "flipping numbers clock" appearance, which will animate
9416     * sheets of individual algarisms individually as time goes by.
9417     *
9418     * A newly created clock will fetch system's time (already
9419     * considering local time adjustments) to start with, and will tick
9420     * accondingly. It may or may not show seconds.
9421     *
9422     * Clocks have an @b edition mode. When in it, the sheets will
9423     * display extra arrow indications on the top and bottom and the
9424     * user may click on them to raise or lower the time values. After
9425     * it's told to exit edition mode, it will keep ticking with that
9426     * new time set (it keeps the difference from local time).
9427     *
9428     * Also, when under edition mode, user clicks on the cited arrows
9429     * which are @b held for some time will make the clock to flip the
9430     * sheet, thus editing the time, continuosly and automatically for
9431     * the user. The interval between sheet flips will keep growing in
9432     * time, so that it helps the user to reach a time which is distant
9433     * from the one set.
9434     *
9435     * The time display is, by default, in military mode (24h), but an
9436     * am/pm indicator may be optionally shown, too, when it will
9437     * switch to 12h.
9438     *
9439     * Smart callbacks one can register to:
9440     * - "changed" - the clock's user changed the time
9441     *
9442     * Here is an example on its usage:
9443     * @li @ref clock_example
9444     */
9445
9446    /**
9447     * @addtogroup Clock
9448     * @{
9449     */
9450
9451    /**
9452     * Identifiers for which clock digits should be editable, when a
9453     * clock widget is in edition mode. Values may be ORed together to
9454     * make a mask, naturally.
9455     *
9456     * @see elm_clock_edit_set()
9457     * @see elm_clock_digit_edit_set()
9458     */
9459    typedef enum _Elm_Clock_Digedit
9460      {
9461         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9462         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9463         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9464         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9465         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9466         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9467         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9468         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9469      } Elm_Clock_Digedit;
9470
9471    /**
9472     * Add a new clock widget to the given parent Elementary
9473     * (container) object
9474     *
9475     * @param parent The parent object
9476     * @return a new clock widget handle or @c NULL, on errors
9477     *
9478     * This function inserts a new clock widget on the canvas.
9479     *
9480     * @ingroup Clock
9481     */
9482    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9483
9484    /**
9485     * Set a clock widget's time, programmatically
9486     *
9487     * @param obj The clock widget object
9488     * @param hrs The hours to set
9489     * @param min The minutes to set
9490     * @param sec The secondes to set
9491     *
9492     * This function updates the time that is showed by the clock
9493     * widget.
9494     *
9495     *  Values @b must be set within the following ranges:
9496     * - 0 - 23, for hours
9497     * - 0 - 59, for minutes
9498     * - 0 - 59, for seconds,
9499     *
9500     * even if the clock is not in "military" mode.
9501     *
9502     * @warning The behavior for values set out of those ranges is @b
9503     * undefined.
9504     *
9505     * @ingroup Clock
9506     */
9507    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9508
9509    /**
9510     * Get a clock widget's time values
9511     *
9512     * @param obj The clock object
9513     * @param[out] hrs Pointer to the variable to get the hours value
9514     * @param[out] min Pointer to the variable to get the minutes value
9515     * @param[out] sec Pointer to the variable to get the seconds value
9516     *
9517     * This function gets the time set for @p obj, returning
9518     * it on the variables passed as the arguments to function
9519     *
9520     * @note Use @c NULL pointers on the time values you're not
9521     * interested in: they'll be ignored by the function.
9522     *
9523     * @ingroup Clock
9524     */
9525    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9526
9527    /**
9528     * Set whether a given clock widget is under <b>edition mode</b> or
9529     * under (default) displaying-only mode.
9530     *
9531     * @param obj The clock object
9532     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9533     * put it back to "displaying only" mode
9534     *
9535     * This function makes a clock's time to be editable or not <b>by
9536     * user interaction</b>. When in edition mode, clocks @b stop
9537     * ticking, until one brings them back to canonical mode. The
9538     * elm_clock_digit_edit_set() function will influence which digits
9539     * of the clock will be editable. By default, all of them will be
9540     * (#ELM_CLOCK_NONE).
9541     *
9542     * @note am/pm sheets, if being shown, will @b always be editable
9543     * under edition mode.
9544     *
9545     * @see elm_clock_edit_get()
9546     *
9547     * @ingroup Clock
9548     */
9549    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9550
9551    /**
9552     * Retrieve whether a given clock widget is under <b>edition
9553     * mode</b> or under (default) displaying-only mode.
9554     *
9555     * @param obj The clock object
9556     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9557     * otherwise
9558     *
9559     * This function retrieves whether the clock's time can be edited
9560     * or not by user interaction.
9561     *
9562     * @see elm_clock_edit_set() for more details
9563     *
9564     * @ingroup Clock
9565     */
9566    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9567
9568    /**
9569     * Set what digits of the given clock widget should be editable
9570     * when in edition mode.
9571     *
9572     * @param obj The clock object
9573     * @param digedit Bit mask indicating the digits to be editable
9574     * (values in #Elm_Clock_Digedit).
9575     *
9576     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9577     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9578     * EINA_FALSE).
9579     *
9580     * @see elm_clock_digit_edit_get()
9581     *
9582     * @ingroup Clock
9583     */
9584    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9585
9586    /**
9587     * Retrieve what digits of the given clock widget should be
9588     * editable when in edition mode.
9589     *
9590     * @param obj The clock object
9591     * @return Bit mask indicating the digits to be editable
9592     * (values in #Elm_Clock_Digedit).
9593     *
9594     * @see elm_clock_digit_edit_set() for more details
9595     *
9596     * @ingroup Clock
9597     */
9598    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9599
9600    /**
9601     * Set if the given clock widget must show hours in military or
9602     * am/pm mode
9603     *
9604     * @param obj The clock object
9605     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9606     * to military mode
9607     *
9608     * This function sets if the clock must show hours in military or
9609     * am/pm mode. In some countries like Brazil the military mode
9610     * (00-24h-format) is used, in opposition to the USA, where the
9611     * am/pm mode is more commonly used.
9612     *
9613     * @see elm_clock_show_am_pm_get()
9614     *
9615     * @ingroup Clock
9616     */
9617    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9618
9619    /**
9620     * Get if the given clock widget shows hours in military or am/pm
9621     * mode
9622     *
9623     * @param obj The clock object
9624     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9625     * military
9626     *
9627     * This function gets if the clock shows hours in military or am/pm
9628     * mode.
9629     *
9630     * @see elm_clock_show_am_pm_set() for more details
9631     *
9632     * @ingroup Clock
9633     */
9634    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9635
9636    /**
9637     * Set if the given clock widget must show time with seconds or not
9638     *
9639     * @param obj The clock object
9640     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9641     *
9642     * This function sets if the given clock must show or not elapsed
9643     * seconds. By default, they are @b not shown.
9644     *
9645     * @see elm_clock_show_seconds_get()
9646     *
9647     * @ingroup Clock
9648     */
9649    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9650
9651    /**
9652     * Get whether the given clock widget is showing time with seconds
9653     * or not
9654     *
9655     * @param obj The clock object
9656     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9657     *
9658     * This function gets whether @p obj is showing or not the elapsed
9659     * seconds.
9660     *
9661     * @see elm_clock_show_seconds_set()
9662     *
9663     * @ingroup Clock
9664     */
9665    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9666
9667    /**
9668     * Set the interval on time updates for an user mouse button hold
9669     * on clock widgets' time edition.
9670     *
9671     * @param obj The clock object
9672     * @param interval The (first) interval value in seconds
9673     *
9674     * This interval value is @b decreased while the user holds the
9675     * mouse pointer either incrementing or decrementing a given the
9676     * clock digit's value.
9677     *
9678     * This helps the user to get to a given time distant from the
9679     * current one easier/faster, as it will start to flip quicker and
9680     * quicker on mouse button holds.
9681     *
9682     * The calculation for the next flip interval value, starting from
9683     * the one set with this call, is the previous interval divided by
9684     * 1.05, so it decreases a little bit.
9685     *
9686     * The default starting interval value for automatic flips is
9687     * @b 0.85 seconds.
9688     *
9689     * @see elm_clock_interval_get()
9690     *
9691     * @ingroup Clock
9692     */
9693    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9694
9695    /**
9696     * Get the interval on time updates for an user mouse button hold
9697     * on clock widgets' time edition.
9698     *
9699     * @param obj The clock object
9700     * @return The (first) interval value, in seconds, set on it
9701     *
9702     * @see elm_clock_interval_set() for more details
9703     *
9704     * @ingroup Clock
9705     */
9706    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9707
9708    /**
9709     * @}
9710     */
9711
9712    /**
9713     * @defgroup Layout Layout
9714     *
9715     * @image html img/widget/layout/preview-00.png
9716     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9717     *
9718     * @image html img/layout-predefined.png
9719     * @image latex img/layout-predefined.eps width=\textwidth
9720     *
9721     * This is a container widget that takes a standard Edje design file and
9722     * wraps it very thinly in a widget.
9723     *
9724     * An Edje design (theme) file has a very wide range of possibilities to
9725     * describe the behavior of elements added to the Layout. Check out the Edje
9726     * documentation and the EDC reference to get more information about what can
9727     * be done with Edje.
9728     *
9729     * Just like @ref List, @ref Box, and other container widgets, any
9730     * object added to the Layout will become its child, meaning that it will be
9731     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9732     *
9733     * The Layout widget can contain as many Contents, Boxes or Tables as
9734     * described in its theme file. For instance, objects can be added to
9735     * different Tables by specifying the respective Table part names. The same
9736     * is valid for Content and Box.
9737     *
9738     * The objects added as child of the Layout will behave as described in the
9739     * part description where they were added. There are 3 possible types of
9740     * parts where a child can be added:
9741     *
9742     * @section secContent Content (SWALLOW part)
9743     *
9744     * Only one object can be added to the @c SWALLOW part (but you still can
9745     * have many @c SWALLOW parts and one object on each of them). Use the @c
9746     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9747     * objects as content of the @c SWALLOW. After being set to this part, the 
9748     * object size, position, visibility, clipping and other description 
9749     * properties will be totally controled by the description of the given part 
9750     * (inside the Edje theme file).
9751     *
9752     * One can use @c evas_object_size_hint_* functions on the child to have some
9753     * kind of control over its behavior, but the resulting behavior will still
9754     * depend heavily on the @c SWALLOW part description.
9755     *
9756     * The Edje theme also can change the part description, based on signals or
9757     * scripts running inside the theme. This change can also be animated. All of
9758     * this will affect the child object set as content accordingly. The object
9759     * size will be changed if the part size is changed, it will animate move if
9760     * the part is moving, and so on.
9761     *
9762     * The following picture demonstrates a Layout widget with a child object
9763     * added to its @c SWALLOW:
9764     *
9765     * @image html layout_swallow.png
9766     * @image latex layout_swallow.eps width=\textwidth
9767     *
9768     * @section secBox Box (BOX part)
9769     *
9770     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9771     * allows one to add objects to the box and have them distributed along its
9772     * area, accordingly to the specified @a layout property (now by @a layout we
9773     * mean the chosen layouting design of the Box, not the Layout widget
9774     * itself).
9775     *
9776     * A similar effect for having a box with its position, size and other things
9777     * controled by the Layout theme would be to create an Elementary @ref Box
9778     * widget and add it as a Content in the @c SWALLOW part.
9779     *
9780     * The main difference of using the Layout Box is that its behavior, the box
9781     * properties like layouting format, padding, align, etc. will be all
9782     * controled by the theme. This means, for example, that a signal could be
9783     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9784     * handled the signal by changing the box padding, or align, or both. Using
9785     * the Elementary @ref Box widget is not necessarily harder or easier, it
9786     * just depends on the circunstances and requirements.
9787     *
9788     * The Layout Box can be used through the @c elm_layout_box_* set of
9789     * functions.
9790     *
9791     * The following picture demonstrates a Layout widget with many child objects
9792     * added to its @c BOX part:
9793     *
9794     * @image html layout_box.png
9795     * @image latex layout_box.eps width=\textwidth
9796     *
9797     * @section secTable Table (TABLE part)
9798     *
9799     * Just like the @ref secBox, the Layout Table is very similar to the
9800     * Elementary @ref Table widget. It allows one to add objects to the Table
9801     * specifying the row and column where the object should be added, and any
9802     * column or row span if necessary.
9803     *
9804     * Again, we could have this design by adding a @ref Table widget to the @c
9805     * SWALLOW part using elm_object_content_part_set(). The same difference happens
9806     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9807     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9808     *
9809     * The Layout Table can be used through the @c elm_layout_table_* set of
9810     * functions.
9811     *
9812     * The following picture demonstrates a Layout widget with many child objects
9813     * added to its @c TABLE part:
9814     *
9815     * @image html layout_table.png
9816     * @image latex layout_table.eps width=\textwidth
9817     *
9818     * @section secPredef Predefined Layouts
9819     *
9820     * Another interesting thing about the Layout widget is that it offers some
9821     * predefined themes that come with the default Elementary theme. These
9822     * themes can be set by the call elm_layout_theme_set(), and provide some
9823     * basic functionality depending on the theme used.
9824     *
9825     * Most of them already send some signals, some already provide a toolbar or
9826     * back and next buttons.
9827     *
9828     * These are available predefined theme layouts. All of them have class = @c
9829     * layout, group = @c application, and style = one of the following options:
9830     *
9831     * @li @c toolbar-content - application with toolbar and main content area
9832     * @li @c toolbar-content-back - application with toolbar and main content
9833     * area with a back button and title area
9834     * @li @c toolbar-content-back-next - application with toolbar and main
9835     * content area with a back and next buttons and title area
9836     * @li @c content-back - application with a main content area with a back
9837     * button and title area
9838     * @li @c content-back-next - application with a main content area with a
9839     * back and next buttons and title area
9840     * @li @c toolbar-vbox - application with toolbar and main content area as a
9841     * vertical box
9842     * @li @c toolbar-table - application with toolbar and main content area as a
9843     * table
9844     *
9845     * @section secExamples Examples
9846     *
9847     * Some examples of the Layout widget can be found here:
9848     * @li @ref layout_example_01
9849     * @li @ref layout_example_02
9850     * @li @ref layout_example_03
9851     * @li @ref layout_example_edc
9852     *
9853     */
9854
9855    /**
9856     * Add a new layout to the parent
9857     *
9858     * @param parent The parent object
9859     * @return The new object or NULL if it cannot be created
9860     *
9861     * @see elm_layout_file_set()
9862     * @see elm_layout_theme_set()
9863     *
9864     * @ingroup Layout
9865     */
9866    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9867    /**
9868     * Set the file that will be used as layout
9869     *
9870     * @param obj The layout object
9871     * @param file The path to file (edj) that will be used as layout
9872     * @param group The group that the layout belongs in edje file
9873     *
9874     * @return (1 = success, 0 = error)
9875     *
9876     * @ingroup Layout
9877     */
9878    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9879    /**
9880     * Set the edje group from the elementary theme that will be used as layout
9881     *
9882     * @param obj The layout object
9883     * @param clas the clas of the group
9884     * @param group the group
9885     * @param style the style to used
9886     *
9887     * @return (1 = success, 0 = error)
9888     *
9889     * @ingroup Layout
9890     */
9891    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9892    /**
9893     * Set the layout content.
9894     *
9895     * @param obj The layout object
9896     * @param swallow The swallow part name in the edje file
9897     * @param content The child that will be added in this layout object
9898     *
9899     * Once the content object is set, a previously set one will be deleted.
9900     * If you want to keep that old content object, use the
9901     * elm_object_content_part_unset() function.
9902     *
9903     * @note In an Edje theme, the part used as a content container is called @c
9904     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9905     * expected to be a part name just like the second parameter of
9906     * elm_layout_box_append().
9907     *
9908     * @see elm_layout_box_append()
9909     * @see elm_object_content_part_get()
9910     * @see elm_object_content_part_unset()
9911     * @see @ref secBox
9912     *
9913     * @ingroup Layout
9914     */
9915    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9916    /**
9917     * Get the child object in the given content part.
9918     *
9919     * @param obj The layout object
9920     * @param swallow The SWALLOW part to get its content
9921     *
9922     * @return The swallowed object or NULL if none or an error occurred
9923     *
9924     * @see elm_object_content_part_set()
9925     *
9926     * @ingroup Layout
9927     */
9928    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9929    /**
9930     * Unset the layout content.
9931     *
9932     * @param obj The layout object
9933     * @param swallow The swallow part name in the edje file
9934     * @return The content that was being used
9935     *
9936     * Unparent and return the content object which was set for this part.
9937     *
9938     * @see elm_object_content_part_set()
9939     *
9940     * @ingroup Layout
9941     */
9942    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9943    /**
9944     * Set the text of the given part
9945     *
9946     * @param obj The layout object
9947     * @param part The TEXT part where to set the text
9948     * @param text The text to set
9949     *
9950     * @ingroup Layout
9951     * @deprecated use elm_object_text_part_set() instead.
9952     */
9953    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9954    /**
9955     * Get the text set in the given part
9956     *
9957     * @param obj The layout object
9958     * @param part The TEXT part to retrieve the text off
9959     *
9960     * @return The text set in @p part
9961     *
9962     * @ingroup Layout
9963     * @deprecated use elm_object_text_part_get() instead.
9964     */
9965    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9966    /**
9967     * Append child to layout box part.
9968     *
9969     * @param obj the layout object
9970     * @param part the box part to which the object will be appended.
9971     * @param child the child object to append to box.
9972     *
9973     * Once the object is appended, it will become child of the layout. Its
9974     * lifetime will be bound to the layout, whenever the layout dies the child
9975     * will be deleted automatically. One should use elm_layout_box_remove() to
9976     * make this layout forget about the object.
9977     *
9978     * @see elm_layout_box_prepend()
9979     * @see elm_layout_box_insert_before()
9980     * @see elm_layout_box_insert_at()
9981     * @see elm_layout_box_remove()
9982     *
9983     * @ingroup Layout
9984     */
9985    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9986    /**
9987     * Prepend child to layout box part.
9988     *
9989     * @param obj the layout object
9990     * @param part the box part to prepend.
9991     * @param child the child object to prepend to box.
9992     *
9993     * Once the object is prepended, it will become child of the layout. Its
9994     * lifetime will be bound to the layout, whenever the layout dies the child
9995     * will be deleted automatically. One should use elm_layout_box_remove() to
9996     * make this layout forget about the object.
9997     *
9998     * @see elm_layout_box_append()
9999     * @see elm_layout_box_insert_before()
10000     * @see elm_layout_box_insert_at()
10001     * @see elm_layout_box_remove()
10002     *
10003     * @ingroup Layout
10004     */
10005    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10006    /**
10007     * Insert child to layout box part before a reference object.
10008     *
10009     * @param obj the layout object
10010     * @param part the box part to insert.
10011     * @param child the child object to insert into box.
10012     * @param reference another reference object to insert before in box.
10013     *
10014     * Once the object is inserted, it will become child of the layout. Its
10015     * lifetime will be bound to the layout, whenever the layout dies the child
10016     * will be deleted automatically. One should use elm_layout_box_remove() to
10017     * make this layout forget about the object.
10018     *
10019     * @see elm_layout_box_append()
10020     * @see elm_layout_box_prepend()
10021     * @see elm_layout_box_insert_before()
10022     * @see elm_layout_box_remove()
10023     *
10024     * @ingroup Layout
10025     */
10026    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10027    /**
10028     * Insert child to layout box part at a given position.
10029     *
10030     * @param obj the layout object
10031     * @param part the box part to insert.
10032     * @param child the child object to insert into box.
10033     * @param pos the numeric position >=0 to insert the child.
10034     *
10035     * Once the object is inserted, it will become child of the layout. Its
10036     * lifetime will be bound to the layout, whenever the layout dies the child
10037     * will be deleted automatically. One should use elm_layout_box_remove() to
10038     * make this layout forget about the object.
10039     *
10040     * @see elm_layout_box_append()
10041     * @see elm_layout_box_prepend()
10042     * @see elm_layout_box_insert_before()
10043     * @see elm_layout_box_remove()
10044     *
10045     * @ingroup Layout
10046     */
10047    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10048    /**
10049     * Remove a child of the given part box.
10050     *
10051     * @param obj The layout object
10052     * @param part The box part name to remove child.
10053     * @param child The object to remove from box.
10054     * @return The object that was being used, or NULL if not found.
10055     *
10056     * The object will be removed from the box part and its lifetime will
10057     * not be handled by the layout anymore. This is equivalent to
10058     * elm_object_content_part_unset() for box.
10059     *
10060     * @see elm_layout_box_append()
10061     * @see elm_layout_box_remove_all()
10062     *
10063     * @ingroup Layout
10064     */
10065    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10066    /**
10067     * Remove all child of the given part box.
10068     *
10069     * @param obj The layout object
10070     * @param part The box part name to remove child.
10071     * @param clear If EINA_TRUE, then all objects will be deleted as
10072     *        well, otherwise they will just be removed and will be
10073     *        dangling on the canvas.
10074     *
10075     * The objects will be removed from the box part and their lifetime will
10076     * not be handled by the layout anymore. This is equivalent to
10077     * elm_layout_box_remove() for all box children.
10078     *
10079     * @see elm_layout_box_append()
10080     * @see elm_layout_box_remove()
10081     *
10082     * @ingroup Layout
10083     */
10084    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10085    /**
10086     * Insert child to layout table part.
10087     *
10088     * @param obj the layout object
10089     * @param part the box part to pack child.
10090     * @param child_obj the child object to pack into table.
10091     * @param col the column to which the child should be added. (>= 0)
10092     * @param row the row to which the child should be added. (>= 0)
10093     * @param colspan how many columns should be used to store this object. (>=
10094     *        1)
10095     * @param rowspan how many rows should be used to store this object. (>= 1)
10096     *
10097     * Once the object is inserted, it will become child of the table. Its
10098     * lifetime will be bound to the layout, and whenever the layout dies the
10099     * child will be deleted automatically. One should use
10100     * elm_layout_table_remove() to make this layout forget about the object.
10101     *
10102     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10103     * more space than a single cell. For instance, the following code:
10104     * @code
10105     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10106     * @endcode
10107     *
10108     * Would result in an object being added like the following picture:
10109     *
10110     * @image html layout_colspan.png
10111     * @image latex layout_colspan.eps width=\textwidth
10112     *
10113     * @see elm_layout_table_unpack()
10114     * @see elm_layout_table_clear()
10115     *
10116     * @ingroup Layout
10117     */
10118    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);
10119    /**
10120     * Unpack (remove) a child of the given part table.
10121     *
10122     * @param obj The layout object
10123     * @param part The table part name to remove child.
10124     * @param child_obj The object to remove from table.
10125     * @return The object that was being used, or NULL if not found.
10126     *
10127     * The object will be unpacked from the table part and its lifetime
10128     * will not be handled by the layout anymore. This is equivalent to
10129     * elm_object_content_part_unset() for table.
10130     *
10131     * @see elm_layout_table_pack()
10132     * @see elm_layout_table_clear()
10133     *
10134     * @ingroup Layout
10135     */
10136    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10137    /**
10138     * Remove all child of the given part table.
10139     *
10140     * @param obj The layout object
10141     * @param part The table part name to remove child.
10142     * @param clear If EINA_TRUE, then all objects will be deleted as
10143     *        well, otherwise they will just be removed and will be
10144     *        dangling on the canvas.
10145     *
10146     * The objects will be removed from the table part and their lifetime will
10147     * not be handled by the layout anymore. This is equivalent to
10148     * elm_layout_table_unpack() for all table children.
10149     *
10150     * @see elm_layout_table_pack()
10151     * @see elm_layout_table_unpack()
10152     *
10153     * @ingroup Layout
10154     */
10155    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10156    /**
10157     * Get the edje layout
10158     *
10159     * @param obj The layout object
10160     *
10161     * @return A Evas_Object with the edje layout settings loaded
10162     * with function elm_layout_file_set
10163     *
10164     * This returns the edje object. It is not expected to be used to then
10165     * swallow objects via edje_object_part_swallow() for example. Use
10166     * elm_object_content_part_set() instead so child object handling and sizing is
10167     * done properly.
10168     *
10169     * @note This function should only be used if you really need to call some
10170     * low level Edje function on this edje object. All the common stuff (setting
10171     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10172     * with proper elementary functions.
10173     *
10174     * @see elm_object_signal_callback_add()
10175     * @see elm_object_signal_emit()
10176     * @see elm_object_text_part_set()
10177     * @see elm_object_content_part_set()
10178     * @see elm_layout_box_append()
10179     * @see elm_layout_table_pack()
10180     * @see elm_layout_data_get()
10181     *
10182     * @ingroup Layout
10183     */
10184    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10185    /**
10186     * Get the edje data from the given layout
10187     *
10188     * @param obj The layout object
10189     * @param key The data key
10190     *
10191     * @return The edje data string
10192     *
10193     * This function fetches data specified inside the edje theme of this layout.
10194     * This function return NULL if data is not found.
10195     *
10196     * In EDC this comes from a data block within the group block that @p
10197     * obj was loaded from. E.g.
10198     *
10199     * @code
10200     * collections {
10201     *   group {
10202     *     name: "a_group";
10203     *     data {
10204     *       item: "key1" "value1";
10205     *       item: "key2" "value2";
10206     *     }
10207     *   }
10208     * }
10209     * @endcode
10210     *
10211     * @ingroup Layout
10212     */
10213    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10214    /**
10215     * Eval sizing
10216     *
10217     * @param obj The layout object
10218     *
10219     * Manually forces a sizing re-evaluation. This is useful when the minimum
10220     * size required by the edje theme of this layout has changed. The change on
10221     * the minimum size required by the edje theme is not immediately reported to
10222     * the elementary layout, so one needs to call this function in order to tell
10223     * the widget (layout) that it needs to reevaluate its own size.
10224     *
10225     * The minimum size of the theme is calculated based on minimum size of
10226     * parts, the size of elements inside containers like box and table, etc. All
10227     * of this can change due to state changes, and that's when this function
10228     * should be called.
10229     *
10230     * Also note that a standard signal of "size,eval" "elm" emitted from the
10231     * edje object will cause this to happen too.
10232     *
10233     * @ingroup Layout
10234     */
10235    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10236
10237    /**
10238     * Sets a specific cursor for an edje part.
10239     *
10240     * @param obj The layout object.
10241     * @param part_name a part from loaded edje group.
10242     * @param cursor cursor name to use, see Elementary_Cursor.h
10243     *
10244     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10245     *         part not exists or it has "mouse_events: 0".
10246     *
10247     * @ingroup Layout
10248     */
10249    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10250
10251    /**
10252     * Get the cursor to be shown when mouse is over an edje part
10253     *
10254     * @param obj The layout object.
10255     * @param part_name a part from loaded edje group.
10256     * @return the cursor name.
10257     *
10258     * @ingroup Layout
10259     */
10260    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10261
10262    /**
10263     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10264     *
10265     * @param obj The layout object.
10266     * @param part_name a part from loaded edje group, that had a cursor set
10267     *        with elm_layout_part_cursor_set().
10268     *
10269     * @ingroup Layout
10270     */
10271    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10272
10273    /**
10274     * Sets a specific cursor style for an edje part.
10275     *
10276     * @param obj The layout object.
10277     * @param part_name a part from loaded edje group.
10278     * @param style the theme style to use (default, transparent, ...)
10279     *
10280     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10281     *         part not exists or it did not had a cursor set.
10282     *
10283     * @ingroup Layout
10284     */
10285    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10286
10287    /**
10288     * Gets a specific cursor style for an edje part.
10289     *
10290     * @param obj The layout object.
10291     * @param part_name a part from loaded edje group.
10292     *
10293     * @return the theme style in use, defaults to "default". If the
10294     *         object does not have a cursor set, then NULL is returned.
10295     *
10296     * @ingroup Layout
10297     */
10298    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10299
10300    /**
10301     * Sets if the cursor set should be searched on the theme or should use
10302     * the provided by the engine, only.
10303     *
10304     * @note before you set if should look on theme you should define a
10305     * cursor with elm_layout_part_cursor_set(). By default it will only
10306     * look for cursors provided by the engine.
10307     *
10308     * @param obj The layout object.
10309     * @param part_name a part from loaded edje group.
10310     * @param engine_only if cursors should be just provided by the engine
10311     *        or should also search on widget's theme as well
10312     *
10313     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10314     *         part not exists or it did not had a cursor set.
10315     *
10316     * @ingroup Layout
10317     */
10318    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);
10319
10320    /**
10321     * Gets a specific cursor engine_only for an edje part.
10322     *
10323     * @param obj The layout object.
10324     * @param part_name a part from loaded edje group.
10325     *
10326     * @return whenever the cursor is just provided by engine or also from theme.
10327     *
10328     * @ingroup Layout
10329     */
10330    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10331
10332 /**
10333  * @def elm_layout_icon_set
10334  * Convienience macro to set the icon object in a layout that follows the
10335  * Elementary naming convention for its parts.
10336  *
10337  * @ingroup Layout
10338  */
10339 #define elm_layout_icon_set(_ly, _obj) \
10340   do { \
10341     const char *sig; \
10342     elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10343     if ((_obj)) sig = "elm,state,icon,visible"; \
10344     else sig = "elm,state,icon,hidden"; \
10345     elm_object_signal_emit((_ly), sig, "elm"); \
10346   } while (0)
10347
10348 /**
10349  * @def elm_layout_icon_get
10350  * Convienience macro to get the icon object from a layout that follows the
10351  * Elementary naming convention for its parts.
10352  *
10353  * @ingroup Layout
10354  */
10355 #define elm_layout_icon_get(_ly) \
10356   elm_object_content_part_get((_ly), "elm.swallow.icon")
10357
10358 /**
10359  * @def elm_layout_end_set
10360  * Convienience macro to set the end object in a layout that follows the
10361  * Elementary naming convention for its parts.
10362  *
10363  * @ingroup Layout
10364  */
10365 #define elm_layout_end_set(_ly, _obj) \
10366   do { \
10367     const char *sig; \
10368     elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10369     if ((_obj)) sig = "elm,state,end,visible"; \
10370     else sig = "elm,state,end,hidden"; \
10371     elm_object_signal_emit((_ly), sig, "elm"); \
10372   } while (0)
10373
10374 /**
10375  * @def elm_layout_end_get
10376  * Convienience macro to get the end object in a layout that follows the
10377  * Elementary naming convention for its parts.
10378  *
10379  * @ingroup Layout
10380  */
10381 #define elm_layout_end_get(_ly) \
10382   elm_object_content_part_get((_ly), "elm.swallow.end")
10383
10384 /**
10385  * @def elm_layout_label_set
10386  * Convienience macro to set the label in a layout that follows the
10387  * Elementary naming convention for its parts.
10388  *
10389  * @ingroup Layout
10390  * @deprecated use elm_object_text_set() instead.
10391  */
10392 #define elm_layout_label_set(_ly, _txt) \
10393   elm_layout_text_set((_ly), "elm.text", (_txt))
10394
10395 /**
10396  * @def elm_layout_label_get
10397  * Convenience macro to get the label in a layout that follows the
10398  * Elementary naming convention for its parts.
10399  *
10400  * @ingroup Layout
10401  * @deprecated use elm_object_text_set() instead.
10402  */
10403 #define elm_layout_label_get(_ly) \
10404   elm_layout_text_get((_ly), "elm.text")
10405
10406    /* smart callbacks called:
10407     * "theme,changed" - when elm theme is changed.
10408     */
10409
10410    /**
10411     * @defgroup Notify Notify
10412     *
10413     * @image html img/widget/notify/preview-00.png
10414     * @image latex img/widget/notify/preview-00.eps
10415     *
10416     * Display a container in a particular region of the parent(top, bottom,
10417     * etc).  A timeout can be set to automatically hide the notify. This is so
10418     * that, after an evas_object_show() on a notify object, if a timeout was set
10419     * on it, it will @b automatically get hidden after that time.
10420     *
10421     * Signals that you can add callbacks for are:
10422     * @li "timeout" - when timeout happens on notify and it's hidden
10423     * @li "block,clicked" - when a click outside of the notify happens
10424     *
10425     * Default contents parts of the notify widget that you can use for are:
10426     * @li "elm.swallow.content" - A content of the notify
10427     *
10428     * @ref tutorial_notify show usage of the API.
10429     *
10430     * @{
10431     */
10432    /**
10433     * @brief Possible orient values for notify.
10434     *
10435     * This values should be used in conjunction to elm_notify_orient_set() to
10436     * set the position in which the notify should appear(relative to its parent)
10437     * and in conjunction with elm_notify_orient_get() to know where the notify
10438     * is appearing.
10439     */
10440    typedef enum _Elm_Notify_Orient
10441      {
10442         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10443         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10444         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10445         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10446         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10447         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10448         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10449         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10450         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10451         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10452      } Elm_Notify_Orient;
10453    /**
10454     * @brief Add a new notify to the parent
10455     *
10456     * @param parent The parent object
10457     * @return The new object or NULL if it cannot be created
10458     */
10459    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10460    /**
10461     * @brief Set the content of the notify widget
10462     *
10463     * @param obj The notify object
10464     * @param content The content will be filled in this notify object
10465     *
10466     * Once the content object is set, a previously set one will be deleted. If
10467     * you want to keep that old content object, use the
10468     * elm_notify_content_unset() function.
10469     */
10470    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10471    /**
10472     * @brief Unset the content of the notify widget
10473     *
10474     * @param obj The notify object
10475     * @return The content that was being used
10476     *
10477     * Unparent and return the content object which was set for this widget
10478     *
10479     * @see elm_notify_content_set()
10480     */
10481    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10482    /**
10483     * @brief Return the content of the notify widget
10484     *
10485     * @param obj The notify object
10486     * @return The content that is being used
10487     *
10488     * @see elm_notify_content_set()
10489     */
10490    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10491    /**
10492     * @brief Set the notify parent
10493     *
10494     * @param obj The notify object
10495     * @param content The new parent
10496     *
10497     * Once the parent object is set, a previously set one will be disconnected
10498     * and replaced.
10499     */
10500    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10501    /**
10502     * @brief Get the notify parent
10503     *
10504     * @param obj The notify object
10505     * @return The parent
10506     *
10507     * @see elm_notify_parent_set()
10508     */
10509    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10510    /**
10511     * @brief Set the orientation
10512     *
10513     * @param obj The notify object
10514     * @param orient The new orientation
10515     *
10516     * Sets the position in which the notify will appear in its parent.
10517     *
10518     * @see @ref Elm_Notify_Orient for possible values.
10519     */
10520    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10521    /**
10522     * @brief Return the orientation
10523     * @param obj The notify object
10524     * @return The orientation of the notification
10525     *
10526     * @see elm_notify_orient_set()
10527     * @see Elm_Notify_Orient
10528     */
10529    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10530    /**
10531     * @brief Set the time interval after which the notify window is going to be
10532     * hidden.
10533     *
10534     * @param obj The notify object
10535     * @param time The timeout in seconds
10536     *
10537     * This function sets a timeout and starts the timer controlling when the
10538     * notify is hidden. Since calling evas_object_show() on a notify restarts
10539     * the timer controlling when the notify is hidden, setting this before the
10540     * notify is shown will in effect mean starting the timer when the notify is
10541     * shown.
10542     *
10543     * @note Set a value <= 0.0 to disable a running timer.
10544     *
10545     * @note If the value > 0.0 and the notify is previously visible, the
10546     * timer will be started with this value, canceling any running timer.
10547     */
10548    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10549    /**
10550     * @brief Return the timeout value (in seconds)
10551     * @param obj the notify object
10552     *
10553     * @see elm_notify_timeout_set()
10554     */
10555    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10556    /**
10557     * @brief Sets whether events should be passed to by a click outside
10558     * its area.
10559     *
10560     * @param obj The notify object
10561     * @param repeats EINA_TRUE Events are repeats, else no
10562     *
10563     * When true if the user clicks outside the window the events will be caught
10564     * by the others widgets, else the events are blocked.
10565     *
10566     * @note The default value is EINA_TRUE.
10567     */
10568    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10569    /**
10570     * @brief Return true if events are repeat below the notify object
10571     * @param obj the notify object
10572     *
10573     * @see elm_notify_repeat_events_set()
10574     */
10575    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10576    /**
10577     * @}
10578     */
10579
10580    /**
10581     * @defgroup Hover Hover
10582     *
10583     * @image html img/widget/hover/preview-00.png
10584     * @image latex img/widget/hover/preview-00.eps
10585     *
10586     * A Hover object will hover over its @p parent object at the @p target
10587     * location. Anything in the background will be given a darker coloring to
10588     * indicate that the hover object is on top (at the default theme). When the
10589     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10590     * clicked that @b doesn't cause the hover to be dismissed.
10591     *
10592     * A Hover object has two parents. One parent that owns it during creation
10593     * and the other parent being the one over which the hover object spans.
10594     *
10595     *
10596     * @note The hover object will take up the entire space of @p target
10597     * object.
10598     *
10599     * Elementary has the following styles for the hover widget:
10600     * @li default
10601     * @li popout
10602     * @li menu
10603     * @li hoversel_vertical
10604     *
10605     * The following are the available position for content:
10606     * @li left
10607     * @li top-left
10608     * @li top
10609     * @li top-right
10610     * @li right
10611     * @li bottom-right
10612     * @li bottom
10613     * @li bottom-left
10614     * @li middle
10615     * @li smart
10616     *
10617     * Signals that you can add callbacks for are:
10618     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10619     * @li "smart,changed" - a content object placed under the "smart"
10620     *                   policy was replaced to a new slot direction.
10621     *
10622     * See @ref tutorial_hover for more information.
10623     *
10624     * @{
10625     */
10626    typedef enum _Elm_Hover_Axis
10627      {
10628         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10629         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10630         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10631         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10632      } Elm_Hover_Axis;
10633    /**
10634     * @brief Adds a hover object to @p parent
10635     *
10636     * @param parent The parent object
10637     * @return The hover object or NULL if one could not be created
10638     */
10639    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10640    /**
10641     * @brief Sets the target object for the hover.
10642     *
10643     * @param obj The hover object
10644     * @param target The object to center the hover onto. The hover
10645     *
10646     * This function will cause the hover to be centered on the target object.
10647     */
10648    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10649    /**
10650     * @brief Gets the target object for the hover.
10651     *
10652     * @param obj The hover object
10653     * @param parent The object to locate the hover over.
10654     *
10655     * @see elm_hover_target_set()
10656     */
10657    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10658    /**
10659     * @brief Sets the parent object for the hover.
10660     *
10661     * @param obj The hover object
10662     * @param parent The object to locate the hover over.
10663     *
10664     * This function will cause the hover to take up the entire space that the
10665     * parent object fills.
10666     */
10667    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10668    /**
10669     * @brief Gets the parent object for the hover.
10670     *
10671     * @param obj The hover object
10672     * @return The parent object to locate the hover over.
10673     *
10674     * @see elm_hover_parent_set()
10675     */
10676    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10677    /**
10678     * @brief Sets the content of the hover object and the direction in which it
10679     * will pop out.
10680     *
10681     * @param obj The hover object
10682     * @param swallow The direction that the object will be displayed
10683     * at. Accepted values are "left", "top-left", "top", "top-right",
10684     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10685     * "smart".
10686     * @param content The content to place at @p swallow
10687     *
10688     * Once the content object is set for a given direction, a previously
10689     * set one (on the same direction) will be deleted. If you want to
10690     * keep that old content object, use the elm_hover_content_unset()
10691     * function.
10692     *
10693     * All directions may have contents at the same time, except for
10694     * "smart". This is a special placement hint and its use case
10695     * independs of the calculations coming from
10696     * elm_hover_best_content_location_get(). Its use is for cases when
10697     * one desires only one hover content, but with a dinamic special
10698     * placement within the hover area. The content's geometry, whenever
10699     * it changes, will be used to decide on a best location not
10700     * extrapolating the hover's parent object view to show it in (still
10701     * being the hover's target determinant of its medium part -- move and
10702     * resize it to simulate finger sizes, for example). If one of the
10703     * directions other than "smart" are used, a previously content set
10704     * using it will be deleted, and vice-versa.
10705     */
10706    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10707    /**
10708     * @brief Get the content of the hover object, in a given direction.
10709     *
10710     * Return the content object which was set for this widget in the
10711     * @p swallow direction.
10712     *
10713     * @param obj The hover object
10714     * @param swallow The direction that the object was display at.
10715     * @return The content that was being used
10716     *
10717     * @see elm_hover_content_set()
10718     */
10719    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10720    /**
10721     * @brief Unset the content of the hover object, in a given direction.
10722     *
10723     * Unparent and return the content object set at @p swallow direction.
10724     *
10725     * @param obj The hover object
10726     * @param swallow The direction that the object was display at.
10727     * @return The content that was being used.
10728     *
10729     * @see elm_hover_content_set()
10730     */
10731    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10732    /**
10733     * @brief Returns the best swallow location for content in the hover.
10734     *
10735     * @param obj The hover object
10736     * @param pref_axis The preferred orientation axis for the hover object to use
10737     * @return The edje location to place content into the hover or @c
10738     *         NULL, on errors.
10739     *
10740     * Best is defined here as the location at which there is the most available
10741     * space.
10742     *
10743     * @p pref_axis may be one of
10744     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10745     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10746     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10747     * - @c ELM_HOVER_AXIS_BOTH -- both
10748     *
10749     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10750     * nescessarily be along the horizontal axis("left" or "right"). If
10751     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10752     * be along the vertical axis("top" or "bottom"). Chossing
10753     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10754     * returned position may be in either axis.
10755     *
10756     * @see elm_hover_content_set()
10757     */
10758    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10759    /**
10760     * @}
10761     */
10762
10763    /* entry */
10764    /**
10765     * @defgroup Entry Entry
10766     *
10767     * @image html img/widget/entry/preview-00.png
10768     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10769     * @image html img/widget/entry/preview-01.png
10770     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10771     * @image html img/widget/entry/preview-02.png
10772     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10773     * @image html img/widget/entry/preview-03.png
10774     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10775     *
10776     * An entry is a convenience widget which shows a box that the user can
10777     * enter text into. Entries by default don't scroll, so they grow to
10778     * accomodate the entire text, resizing the parent window as needed. This
10779     * can be changed with the elm_entry_scrollable_set() function.
10780     *
10781     * They can also be single line or multi line (the default) and when set
10782     * to multi line mode they support text wrapping in any of the modes
10783     * indicated by #Elm_Wrap_Type.
10784     *
10785     * Other features include password mode, filtering of inserted text with
10786     * elm_entry_text_filter_append() and related functions, inline "items" and
10787     * formatted markup text.
10788     *
10789     * @section entry-markup Formatted text
10790     *
10791     * The markup tags supported by the Entry are defined by the theme, but
10792     * even when writing new themes or extensions it's a good idea to stick to
10793     * a sane default, to maintain coherency and avoid application breakages.
10794     * Currently defined by the default theme are the following tags:
10795     * @li \<br\>: Inserts a line break.
10796     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10797     * breaks.
10798     * @li \<tab\>: Inserts a tab.
10799     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10800     * enclosed text.
10801     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10802     * @li \<link\>...\</link\>: Underlines the enclosed text.
10803     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10804     *
10805     * @section entry-special Special markups
10806     *
10807     * Besides those used to format text, entries support two special markup
10808     * tags used to insert clickable portions of text or items inlined within
10809     * the text.
10810     *
10811     * @subsection entry-anchors Anchors
10812     *
10813     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10814     * \</a\> tags and an event will be generated when this text is clicked,
10815     * like this:
10816     *
10817     * @code
10818     * This text is outside <a href=anc-01>but this one is an anchor</a>
10819     * @endcode
10820     *
10821     * The @c href attribute in the opening tag gives the name that will be
10822     * used to identify the anchor and it can be any valid utf8 string.
10823     *
10824     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10825     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10826     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10827     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10828     * an anchor.
10829     *
10830     * @subsection entry-items Items
10831     *
10832     * Inlined in the text, any other @c Evas_Object can be inserted by using
10833     * \<item\> tags this way:
10834     *
10835     * @code
10836     * <item size=16x16 vsize=full href=emoticon/haha></item>
10837     * @endcode
10838     *
10839     * Just like with anchors, the @c href identifies each item, but these need,
10840     * in addition, to indicate their size, which is done using any one of
10841     * @c size, @c absize or @c relsize attributes. These attributes take their
10842     * value in the WxH format, where W is the width and H the height of the
10843     * item.
10844     *
10845     * @li absize: Absolute pixel size for the item. Whatever value is set will
10846     * be the item's size regardless of any scale value the object may have
10847     * been set to. The final line height will be adjusted to fit larger items.
10848     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10849     * for the object.
10850     * @li relsize: Size is adjusted for the item to fit within the current
10851     * line height.
10852     *
10853     * Besides their size, items are specificed a @c vsize value that affects
10854     * how their final size and position are calculated. The possible values
10855     * are:
10856     * @li ascent: Item will be placed within the line's baseline and its
10857     * ascent. That is, the height between the line where all characters are
10858     * positioned and the highest point in the line. For @c size and @c absize
10859     * items, the descent value will be added to the total line height to make
10860     * them fit. @c relsize items will be adjusted to fit within this space.
10861     * @li full: Items will be placed between the descent and ascent, or the
10862     * lowest point in the line and its highest.
10863     *
10864     * The next image shows different configurations of items and how they
10865     * are the previously mentioned options affect their sizes. In all cases,
10866     * the green line indicates the ascent, blue for the baseline and red for
10867     * the descent.
10868     *
10869     * @image html entry_item.png
10870     * @image latex entry_item.eps width=\textwidth
10871     *
10872     * And another one to show how size differs from absize. In the first one,
10873     * the scale value is set to 1.0, while the second one is using one of 2.0.
10874     *
10875     * @image html entry_item_scale.png
10876     * @image latex entry_item_scale.eps width=\textwidth
10877     *
10878     * After the size for an item is calculated, the entry will request an
10879     * object to place in its space. For this, the functions set with
10880     * elm_entry_item_provider_append() and related functions will be called
10881     * in order until one of them returns a @c non-NULL value. If no providers
10882     * are available, or all of them return @c NULL, then the entry falls back
10883     * to one of the internal defaults, provided the name matches with one of
10884     * them.
10885     *
10886     * All of the following are currently supported:
10887     *
10888     * - emoticon/angry
10889     * - emoticon/angry-shout
10890     * - emoticon/crazy-laugh
10891     * - emoticon/evil-laugh
10892     * - emoticon/evil
10893     * - emoticon/goggle-smile
10894     * - emoticon/grumpy
10895     * - emoticon/grumpy-smile
10896     * - emoticon/guilty
10897     * - emoticon/guilty-smile
10898     * - emoticon/haha
10899     * - emoticon/half-smile
10900     * - emoticon/happy-panting
10901     * - emoticon/happy
10902     * - emoticon/indifferent
10903     * - emoticon/kiss
10904     * - emoticon/knowing-grin
10905     * - emoticon/laugh
10906     * - emoticon/little-bit-sorry
10907     * - emoticon/love-lots
10908     * - emoticon/love
10909     * - emoticon/minimal-smile
10910     * - emoticon/not-happy
10911     * - emoticon/not-impressed
10912     * - emoticon/omg
10913     * - emoticon/opensmile
10914     * - emoticon/smile
10915     * - emoticon/sorry
10916     * - emoticon/squint-laugh
10917     * - emoticon/surprised
10918     * - emoticon/suspicious
10919     * - emoticon/tongue-dangling
10920     * - emoticon/tongue-poke
10921     * - emoticon/uh
10922     * - emoticon/unhappy
10923     * - emoticon/very-sorry
10924     * - emoticon/what
10925     * - emoticon/wink
10926     * - emoticon/worried
10927     * - emoticon/wtf
10928     *
10929     * Alternatively, an item may reference an image by its path, using
10930     * the URI form @c file:///path/to/an/image.png and the entry will then
10931     * use that image for the item.
10932     *
10933     * @section entry-files Loading and saving files
10934     *
10935     * Entries have convinience functions to load text from a file and save
10936     * changes back to it after a short delay. The automatic saving is enabled
10937     * by default, but can be disabled with elm_entry_autosave_set() and files
10938     * can be loaded directly as plain text or have any markup in them
10939     * recognized. See elm_entry_file_set() for more details.
10940     *
10941     * @section entry-signals Emitted signals
10942     *
10943     * This widget emits the following signals:
10944     *
10945     * @li "changed": The text within the entry was changed.
10946     * @li "changed,user": The text within the entry was changed because of user interaction.
10947     * @li "activated": The enter key was pressed on a single line entry.
10948     * @li "press": A mouse button has been pressed on the entry.
10949     * @li "longpressed": A mouse button has been pressed and held for a couple
10950     * seconds.
10951     * @li "clicked": The entry has been clicked (mouse press and release).
10952     * @li "clicked,double": The entry has been double clicked.
10953     * @li "clicked,triple": The entry has been triple clicked.
10954     * @li "focused": The entry has received focus.
10955     * @li "unfocused": The entry has lost focus.
10956     * @li "selection,paste": A paste of the clipboard contents was requested.
10957     * @li "selection,copy": A copy of the selected text into the clipboard was
10958     * requested.
10959     * @li "selection,cut": A cut of the selected text into the clipboard was
10960     * requested.
10961     * @li "selection,start": A selection has begun and no previous selection
10962     * existed.
10963     * @li "selection,changed": The current selection has changed.
10964     * @li "selection,cleared": The current selection has been cleared.
10965     * @li "cursor,changed": The cursor has changed position.
10966     * @li "anchor,clicked": An anchor has been clicked. The event_info
10967     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10968     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10969     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10970     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10971     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10972     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10973     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10974     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10975     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10976     * @li "preedit,changed": The preedit string has changed.
10977     * @li "language,changed": Program language changed.
10978     *
10979     * @section entry-examples
10980     *
10981     * An overview of the Entry API can be seen in @ref entry_example_01
10982     *
10983     * @{
10984     */
10985    /**
10986     * @typedef Elm_Entry_Anchor_Info
10987     *
10988     * The info sent in the callback for the "anchor,clicked" signals emitted
10989     * by entries.
10990     */
10991    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10992    /**
10993     * @struct _Elm_Entry_Anchor_Info
10994     *
10995     * The info sent in the callback for the "anchor,clicked" signals emitted
10996     * by entries.
10997     */
10998    struct _Elm_Entry_Anchor_Info
10999      {
11000         const char *name; /**< The name of the anchor, as stated in its href */
11001         int         button; /**< The mouse button used to click on it */
11002         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11003                     y, /**< Anchor geometry, relative to canvas */
11004                     w, /**< Anchor geometry, relative to canvas */
11005                     h; /**< Anchor geometry, relative to canvas */
11006      };
11007    /**
11008     * @typedef Elm_Entry_Filter_Cb
11009     * This callback type is used by entry filters to modify text.
11010     * @param data The data specified as the last param when adding the filter
11011     * @param entry The entry object
11012     * @param text A pointer to the location of the text being filtered. This data can be modified,
11013     * but any additional allocations must be managed by the user.
11014     * @see elm_entry_text_filter_append
11015     * @see elm_entry_text_filter_prepend
11016     */
11017    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11018
11019    /**
11020     * This adds an entry to @p parent object.
11021     *
11022     * By default, entries are:
11023     * @li not scrolled
11024     * @li multi-line
11025     * @li word wrapped
11026     * @li autosave is enabled
11027     *
11028     * @param parent The parent object
11029     * @return The new object or NULL if it cannot be created
11030     */
11031    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11032    /**
11033     * Sets the entry to single line mode.
11034     *
11035     * In single line mode, entries don't ever wrap when the text reaches the
11036     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11037     * key will generate an @c "activate" event instead of adding a new line.
11038     *
11039     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11040     * and pressing enter will break the text into a different line
11041     * without generating any events.
11042     *
11043     * @param obj The entry object
11044     * @param single_line If true, the text in the entry
11045     * will be on a single line.
11046     */
11047    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11048    /**
11049     * Gets whether the entry is set to be single line.
11050     *
11051     * @param obj The entry object
11052     * @return single_line If true, the text in the entry is set to display
11053     * on a single line.
11054     *
11055     * @see elm_entry_single_line_set()
11056     */
11057    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11058    /**
11059     * Sets the entry to password mode.
11060     *
11061     * In password mode, entries are implicitly single line and the display of
11062     * any text in them is replaced with asterisks (*).
11063     *
11064     * @param obj The entry object
11065     * @param password If true, password mode is enabled.
11066     */
11067    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11068    /**
11069     * Gets whether the entry is set to password mode.
11070     *
11071     * @param obj The entry object
11072     * @return If true, the entry is set to display all characters
11073     * as asterisks (*).
11074     *
11075     * @see elm_entry_password_set()
11076     */
11077    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11078    /**
11079     * This sets the text displayed within the entry to @p entry.
11080     *
11081     * @param obj The entry object
11082     * @param entry The text to be displayed
11083     *
11084     * @deprecated Use elm_object_text_set() instead.
11085     * @note Using this function bypasses text filters
11086     */
11087    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11088    /**
11089     * This returns the text currently shown in object @p entry.
11090     * See also elm_entry_entry_set().
11091     *
11092     * @param obj The entry object
11093     * @return The currently displayed text or NULL on failure
11094     *
11095     * @deprecated Use elm_object_text_get() instead.
11096     */
11097    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11098    /**
11099     * Appends @p entry to the text of the entry.
11100     *
11101     * Adds the text in @p entry to the end of any text already present in the
11102     * widget.
11103     *
11104     * The appended text is subject to any filters set for the widget.
11105     *
11106     * @param obj The entry object
11107     * @param entry The text to be displayed
11108     *
11109     * @see elm_entry_text_filter_append()
11110     */
11111    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11112    /**
11113     * Gets whether the entry is empty.
11114     *
11115     * Empty means no text at all. If there are any markup tags, like an item
11116     * tag for which no provider finds anything, and no text is displayed, this
11117     * function still returns EINA_FALSE.
11118     *
11119     * @param obj The entry object
11120     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11121     */
11122    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11123    /**
11124     * Gets any selected text within the entry.
11125     *
11126     * If there's any selected text in the entry, this function returns it as
11127     * a string in markup format. NULL is returned if no selection exists or
11128     * if an error occurred.
11129     *
11130     * The returned value points to an internal string and should not be freed
11131     * or modified in any way. If the @p entry object is deleted or its
11132     * contents are changed, the returned pointer should be considered invalid.
11133     *
11134     * @param obj The entry object
11135     * @return The selected text within the entry or NULL on failure
11136     */
11137    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11138    /**
11139     * Inserts the given text into the entry at the current cursor position.
11140     *
11141     * This inserts text at the cursor position as if it was typed
11142     * by the user (note that this also allows markup which a user
11143     * can't just "type" as it would be converted to escaped text, so this
11144     * call can be used to insert things like emoticon items or bold push/pop
11145     * tags, other font and color change tags etc.)
11146     *
11147     * If any selection exists, it will be replaced by the inserted text.
11148     *
11149     * The inserted text is subject to any filters set for the widget.
11150     *
11151     * @param obj The entry object
11152     * @param entry The text to insert
11153     *
11154     * @see elm_entry_text_filter_append()
11155     */
11156    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11157    /**
11158     * Set the line wrap type to use on multi-line entries.
11159     *
11160     * Sets the wrap type used by the entry to any of the specified in
11161     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11162     * line (without inserting a line break or paragraph separator) when it
11163     * reaches the far edge of the widget.
11164     *
11165     * Note that this only makes sense for multi-line entries. A widget set
11166     * to be single line will never wrap.
11167     *
11168     * @param obj The entry object
11169     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11170     */
11171    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11172    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11173    /**
11174     * Gets the wrap mode the entry was set to use.
11175     *
11176     * @param obj The entry object
11177     * @return Wrap type
11178     *
11179     * @see also elm_entry_line_wrap_set()
11180     */
11181    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11182    /**
11183     * Sets if the entry is to be editable or not.
11184     *
11185     * By default, entries are editable and when focused, any text input by the
11186     * user will be inserted at the current cursor position. But calling this
11187     * function with @p editable as EINA_FALSE will prevent the user from
11188     * inputting text into the entry.
11189     *
11190     * The only way to change the text of a non-editable entry is to use
11191     * elm_object_text_set(), elm_entry_entry_insert() and other related
11192     * functions.
11193     *
11194     * @param obj The entry object
11195     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11196     * if not, the entry is read-only and no user input is allowed.
11197     */
11198    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11199    /**
11200     * Gets whether the entry is editable or not.
11201     *
11202     * @param obj The entry object
11203     * @return If true, the entry is editable by the user.
11204     * If false, it is not editable by the user
11205     *
11206     * @see elm_entry_editable_set()
11207     */
11208    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11209    /**
11210     * This drops any existing text selection within the entry.
11211     *
11212     * @param obj The entry object
11213     */
11214    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11215    /**
11216     * This selects all text within the entry.
11217     *
11218     * @param obj The entry object
11219     */
11220    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11221    /**
11222     * This moves the cursor one place to the right within the entry.
11223     *
11224     * @param obj The entry object
11225     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11226     */
11227    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11228    /**
11229     * This moves the cursor one place to the left within the entry.
11230     *
11231     * @param obj The entry object
11232     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11233     */
11234    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11235    /**
11236     * This moves the cursor one line up within the entry.
11237     *
11238     * @param obj The entry object
11239     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11240     */
11241    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11242    /**
11243     * This moves the cursor one line down within the entry.
11244     *
11245     * @param obj The entry object
11246     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11247     */
11248    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11249    /**
11250     * This moves the cursor to the beginning of the entry.
11251     *
11252     * @param obj The entry object
11253     */
11254    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11255    /**
11256     * This moves the cursor to the end of the entry.
11257     *
11258     * @param obj The entry object
11259     */
11260    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11261    /**
11262     * This moves the cursor to the beginning of the current line.
11263     *
11264     * @param obj The entry object
11265     */
11266    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11267    /**
11268     * This moves the cursor to the end of the current line.
11269     *
11270     * @param obj The entry object
11271     */
11272    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11273    /**
11274     * This begins a selection within the entry as though
11275     * the user were holding down the mouse button to make a selection.
11276     *
11277     * @param obj The entry object
11278     */
11279    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11280    /**
11281     * This ends a selection within the entry as though
11282     * the user had just released the mouse button while making a selection.
11283     *
11284     * @param obj The entry object
11285     */
11286    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11287    /**
11288     * Gets whether a format node exists at the current cursor position.
11289     *
11290     * A format node is anything that defines how the text is rendered. It can
11291     * be a visible format node, such as a line break or a paragraph separator,
11292     * or an invisible one, such as bold begin or end tag.
11293     * This function returns whether any format node exists at the current
11294     * cursor position.
11295     *
11296     * @param obj The entry object
11297     * @return EINA_TRUE if the current cursor position contains a format node,
11298     * EINA_FALSE otherwise.
11299     *
11300     * @see elm_entry_cursor_is_visible_format_get()
11301     */
11302    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11303    /**
11304     * Gets if the current cursor position holds a visible format node.
11305     *
11306     * @param obj The entry object
11307     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11308     * if it's an invisible one or no format exists.
11309     *
11310     * @see elm_entry_cursor_is_format_get()
11311     */
11312    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11313    /**
11314     * Gets the character pointed by the cursor at its current position.
11315     *
11316     * This function returns a string with the utf8 character stored at the
11317     * current cursor position.
11318     * Only the text is returned, any format that may exist will not be part
11319     * of the return value.
11320     *
11321     * @param obj The entry object
11322     * @return The text pointed by the cursors.
11323     */
11324    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11325    /**
11326     * This function returns the geometry of the cursor.
11327     *
11328     * It's useful if you want to draw something on the cursor (or where it is),
11329     * or for example in the case of scrolled entry where you want to show the
11330     * cursor.
11331     *
11332     * @param obj The entry object
11333     * @param x returned geometry
11334     * @param y returned geometry
11335     * @param w returned geometry
11336     * @param h returned geometry
11337     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11338     */
11339    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);
11340    /**
11341     * Sets the cursor position in the entry to the given value
11342     *
11343     * The value in @p pos is the index of the character position within the
11344     * contents of the string as returned by elm_entry_cursor_pos_get().
11345     *
11346     * @param obj The entry object
11347     * @param pos The position of the cursor
11348     */
11349    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11350    /**
11351     * Retrieves the current position of the cursor in the entry
11352     *
11353     * @param obj The entry object
11354     * @return The cursor position
11355     */
11356    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11357    /**
11358     * This executes a "cut" action on the selected text in the entry.
11359     *
11360     * @param obj The entry object
11361     */
11362    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11363    /**
11364     * This executes a "copy" action on the selected text in the entry.
11365     *
11366     * @param obj The entry object
11367     */
11368    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11369    /**
11370     * This executes a "paste" action in the entry.
11371     *
11372     * @param obj The entry object
11373     */
11374    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11375    /**
11376     * This clears and frees the items in a entry's contextual (longpress)
11377     * menu.
11378     *
11379     * @param obj The entry object
11380     *
11381     * @see elm_entry_context_menu_item_add()
11382     */
11383    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11384    /**
11385     * This adds an item to the entry's contextual menu.
11386     *
11387     * A longpress on an entry will make the contextual menu show up, if this
11388     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11389     * By default, this menu provides a few options like enabling selection mode,
11390     * which is useful on embedded devices that need to be explicit about it,
11391     * and when a selection exists it also shows the copy and cut actions.
11392     *
11393     * With this function, developers can add other options to this menu to
11394     * perform any action they deem necessary.
11395     *
11396     * @param obj The entry object
11397     * @param label The item's text label
11398     * @param icon_file The item's icon file
11399     * @param icon_type The item's icon type
11400     * @param func The callback to execute when the item is clicked
11401     * @param data The data to associate with the item for related functions
11402     */
11403    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);
11404    /**
11405     * This disables the entry's contextual (longpress) menu.
11406     *
11407     * @param obj The entry object
11408     * @param disabled If true, the menu is disabled
11409     */
11410    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11411    /**
11412     * This returns whether the entry's contextual (longpress) menu is
11413     * disabled.
11414     *
11415     * @param obj The entry object
11416     * @return If true, the menu is disabled
11417     */
11418    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11419    /**
11420     * This appends a custom item provider to the list for that entry
11421     *
11422     * This appends the given callback. The list is walked from beginning to end
11423     * with each function called given the item href string in the text. If the
11424     * function returns an object handle other than NULL (it should create an
11425     * object to do this), then this object is used to replace that item. If
11426     * not the next provider is called until one provides an item object, or the
11427     * default provider in entry does.
11428     *
11429     * @param obj The entry object
11430     * @param func The function called to provide the item object
11431     * @param data The data passed to @p func
11432     *
11433     * @see @ref entry-items
11434     */
11435    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);
11436    /**
11437     * This prepends a custom item provider to the list for that entry
11438     *
11439     * This prepends the given callback. See elm_entry_item_provider_append() for
11440     * more information
11441     *
11442     * @param obj The entry object
11443     * @param func The function called to provide the item object
11444     * @param data The data passed to @p func
11445     */
11446    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);
11447    /**
11448     * This removes a custom item provider to the list for that entry
11449     *
11450     * This removes the given callback. See elm_entry_item_provider_append() for
11451     * more information
11452     *
11453     * @param obj The entry object
11454     * @param func The function called to provide the item object
11455     * @param data The data passed to @p func
11456     */
11457    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);
11458    /**
11459     * Append a filter function for text inserted in the entry
11460     *
11461     * Append the given callback to the list. This functions will be called
11462     * whenever any text is inserted into the entry, with the text to be inserted
11463     * as a parameter. The callback function is free to alter the text in any way
11464     * it wants, but it must remember to free the given pointer and update it.
11465     * If the new text is to be discarded, the function can free it and set its
11466     * text parameter to NULL. This will also prevent any following filters from
11467     * being called.
11468     *
11469     * @param obj The entry object
11470     * @param func The function to use as text filter
11471     * @param data User data to pass to @p func
11472     */
11473    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11474    /**
11475     * Prepend a filter function for text insdrted in the entry
11476     *
11477     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11478     * for more information
11479     *
11480     * @param obj The entry object
11481     * @param func The function to use as text filter
11482     * @param data User data to pass to @p func
11483     */
11484    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11485    /**
11486     * Remove a filter from the list
11487     *
11488     * Removes the given callback from the filter list. See
11489     * elm_entry_text_filter_append() for more information.
11490     *
11491     * @param obj The entry object
11492     * @param func The filter function to remove
11493     * @param data The user data passed when adding the function
11494     */
11495    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11496    /**
11497     * This converts a markup (HTML-like) string into UTF-8.
11498     *
11499     * The returned string is a malloc'ed buffer and it should be freed when
11500     * not needed anymore.
11501     *
11502     * @param s The string (in markup) to be converted
11503     * @return The converted string (in UTF-8). It should be freed.
11504     */
11505    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11506    /**
11507     * This converts a UTF-8 string into markup (HTML-like).
11508     *
11509     * The returned string is a malloc'ed buffer and it should be freed when
11510     * not needed anymore.
11511     *
11512     * @param s The string (in UTF-8) to be converted
11513     * @return The converted string (in markup). It should be freed.
11514     */
11515    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11516    /**
11517     * This sets the file (and implicitly loads it) for the text to display and
11518     * then edit. All changes are written back to the file after a short delay if
11519     * the entry object is set to autosave (which is the default).
11520     *
11521     * If the entry had any other file set previously, any changes made to it
11522     * will be saved if the autosave feature is enabled, otherwise, the file
11523     * will be silently discarded and any non-saved changes will be lost.
11524     *
11525     * @param obj The entry object
11526     * @param file The path to the file to load and save
11527     * @param format The file format
11528     */
11529    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11530    /**
11531     * Gets the file being edited by the entry.
11532     *
11533     * This function can be used to retrieve any file set on the entry for
11534     * edition, along with the format used to load and save it.
11535     *
11536     * @param obj The entry object
11537     * @param file The path to the file to load and save
11538     * @param format The file format
11539     */
11540    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11541    /**
11542     * This function writes any changes made to the file set with
11543     * elm_entry_file_set()
11544     *
11545     * @param obj The entry object
11546     */
11547    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11548    /**
11549     * This sets the entry object to 'autosave' the loaded text file or not.
11550     *
11551     * @param obj The entry object
11552     * @param autosave Autosave the loaded file or not
11553     *
11554     * @see elm_entry_file_set()
11555     */
11556    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11557    /**
11558     * This gets the entry object's 'autosave' status.
11559     *
11560     * @param obj The entry object
11561     * @return Autosave the loaded file or not
11562     *
11563     * @see elm_entry_file_set()
11564     */
11565    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11566    /**
11567     * Control pasting of text and images for the widget.
11568     *
11569     * Normally the entry allows both text and images to be pasted.  By setting
11570     * textonly to be true, this prevents images from being pasted.
11571     *
11572     * Note this only changes the behaviour of text.
11573     *
11574     * @param obj The entry object
11575     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11576     * text+image+other.
11577     */
11578    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11579    /**
11580     * Getting elm_entry text paste/drop mode.
11581     *
11582     * In textonly mode, only text may be pasted or dropped into the widget.
11583     *
11584     * @param obj The entry object
11585     * @return If the widget only accepts text from pastes.
11586     */
11587    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11588    /**
11589     * Enable or disable scrolling in entry
11590     *
11591     * Normally the entry is not scrollable unless you enable it with this call.
11592     *
11593     * @param obj The entry object
11594     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11595     */
11596    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11597    /**
11598     * Get the scrollable state of the entry
11599     *
11600     * Normally the entry is not scrollable. This gets the scrollable state
11601     * of the entry. See elm_entry_scrollable_set() for more information.
11602     *
11603     * @param obj The entry object
11604     * @return The scrollable state
11605     */
11606    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11607    /**
11608     * This sets a widget to be displayed to the left of a scrolled entry.
11609     *
11610     * @param obj The scrolled entry object
11611     * @param icon The widget to display on the left side of the scrolled
11612     * entry.
11613     *
11614     * @note A previously set widget will be destroyed.
11615     * @note If the object being set does not have minimum size hints set,
11616     * it won't get properly displayed.
11617     *
11618     * @see elm_entry_end_set()
11619     */
11620    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11621    /**
11622     * Gets the leftmost widget of the scrolled entry. This object is
11623     * owned by the scrolled entry and should not be modified.
11624     *
11625     * @param obj The scrolled entry object
11626     * @return the left widget inside the scroller
11627     */
11628    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11629    /**
11630     * Unset the leftmost widget of the scrolled entry, unparenting and
11631     * returning it.
11632     *
11633     * @param obj The scrolled entry object
11634     * @return the previously set icon sub-object of this entry, on
11635     * success.
11636     *
11637     * @see elm_entry_icon_set()
11638     */
11639    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11640    /**
11641     * Sets the visibility of the left-side widget of the scrolled entry,
11642     * set by elm_entry_icon_set().
11643     *
11644     * @param obj The scrolled entry object
11645     * @param setting EINA_TRUE if the object should be displayed,
11646     * EINA_FALSE if not.
11647     */
11648    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11649    /**
11650     * This sets a widget to be displayed to the end of a scrolled entry.
11651     *
11652     * @param obj The scrolled entry object
11653     * @param end The widget to display on the right side of the scrolled
11654     * entry.
11655     *
11656     * @note A previously set widget will be destroyed.
11657     * @note If the object being set does not have minimum size hints set,
11658     * it won't get properly displayed.
11659     *
11660     * @see elm_entry_icon_set
11661     */
11662    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11663    /**
11664     * Gets the endmost widget of the scrolled entry. This object is owned
11665     * by the scrolled entry and should not be modified.
11666     *
11667     * @param obj The scrolled entry object
11668     * @return the right widget inside the scroller
11669     */
11670    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11671    /**
11672     * Unset the endmost widget of the scrolled entry, unparenting and
11673     * returning it.
11674     *
11675     * @param obj The scrolled entry object
11676     * @return the previously set icon sub-object of this entry, on
11677     * success.
11678     *
11679     * @see elm_entry_icon_set()
11680     */
11681    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11682    /**
11683     * Sets the visibility of the end widget of the scrolled entry, set by
11684     * elm_entry_end_set().
11685     *
11686     * @param obj The scrolled entry object
11687     * @param setting EINA_TRUE if the object should be displayed,
11688     * EINA_FALSE if not.
11689     */
11690    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11691    /**
11692     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11693     * them).
11694     *
11695     * Setting an entry to single-line mode with elm_entry_single_line_set()
11696     * will automatically disable the display of scrollbars when the entry
11697     * moves inside its scroller.
11698     *
11699     * @param obj The scrolled entry object
11700     * @param h The horizontal scrollbar policy to apply
11701     * @param v The vertical scrollbar policy to apply
11702     */
11703    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11704    /**
11705     * This enables/disables bouncing within the entry.
11706     *
11707     * This function sets whether the entry will bounce when scrolling reaches
11708     * the end of the contained entry.
11709     *
11710     * @param obj The scrolled entry object
11711     * @param h The horizontal bounce state
11712     * @param v The vertical bounce state
11713     */
11714    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11715    /**
11716     * Get the bounce mode
11717     *
11718     * @param obj The Entry object
11719     * @param h_bounce Allow bounce horizontally
11720     * @param v_bounce Allow bounce vertically
11721     */
11722    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11723
11724    /* pre-made filters for entries */
11725    /**
11726     * @typedef Elm_Entry_Filter_Limit_Size
11727     *
11728     * Data for the elm_entry_filter_limit_size() entry filter.
11729     */
11730    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11731    /**
11732     * @struct _Elm_Entry_Filter_Limit_Size
11733     *
11734     * Data for the elm_entry_filter_limit_size() entry filter.
11735     */
11736    struct _Elm_Entry_Filter_Limit_Size
11737      {
11738         int max_char_count; /**< The maximum number of characters allowed. */
11739         int max_byte_count; /**< The maximum number of bytes allowed*/
11740      };
11741    /**
11742     * Filter inserted text based on user defined character and byte limits
11743     *
11744     * Add this filter to an entry to limit the characters that it will accept
11745     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11746     * The funtion works on the UTF-8 representation of the string, converting
11747     * it from the set markup, thus not accounting for any format in it.
11748     *
11749     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11750     * it as data when setting the filter. In it, it's possible to set limits
11751     * by character count or bytes (any of them is disabled if 0), and both can
11752     * be set at the same time. In that case, it first checks for characters,
11753     * then bytes.
11754     *
11755     * The function will cut the inserted text in order to allow only the first
11756     * number of characters that are still allowed. The cut is made in
11757     * characters, even when limiting by bytes, in order to always contain
11758     * valid ones and avoid half unicode characters making it in.
11759     *
11760     * This filter, like any others, does not apply when setting the entry text
11761     * directly with elm_object_text_set() (or the deprecated
11762     * elm_entry_entry_set()).
11763     */
11764    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11765    /**
11766     * @typedef Elm_Entry_Filter_Accept_Set
11767     *
11768     * Data for the elm_entry_filter_accept_set() entry filter.
11769     */
11770    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11771    /**
11772     * @struct _Elm_Entry_Filter_Accept_Set
11773     *
11774     * Data for the elm_entry_filter_accept_set() entry filter.
11775     */
11776    struct _Elm_Entry_Filter_Accept_Set
11777      {
11778         const char *accepted; /**< Set of characters accepted in the entry. */
11779         const char *rejected; /**< Set of characters rejected from the entry. */
11780      };
11781    /**
11782     * Filter inserted text based on accepted or rejected sets of characters
11783     *
11784     * Add this filter to an entry to restrict the set of accepted characters
11785     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11786     * This structure contains both accepted and rejected sets, but they are
11787     * mutually exclusive.
11788     *
11789     * The @c accepted set takes preference, so if it is set, the filter will
11790     * only work based on the accepted characters, ignoring anything in the
11791     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11792     *
11793     * In both cases, the function filters by matching utf8 characters to the
11794     * raw markup text, so it can be used to remove formatting tags.
11795     *
11796     * This filter, like any others, does not apply when setting the entry text
11797     * directly with elm_object_text_set() (or the deprecated
11798     * elm_entry_entry_set()).
11799     */
11800    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11801    /**
11802     * Set the input panel layout of the entry
11803     *
11804     * @param obj The entry object
11805     * @param layout layout type
11806     */
11807    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11808    /**
11809     * Get the input panel layout of the entry
11810     *
11811     * @param obj The entry object
11812     * @return layout type
11813     *
11814     * @see elm_entry_input_panel_layout_set
11815     */
11816    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11817    /**
11818     * Set the autocapitalization type on the immodule.
11819     *
11820     * @param obj The entry object
11821     * @param autocapital_type The type of autocapitalization
11822     */
11823    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11824    /**
11825     * Retrieve the autocapitalization type on the immodule.
11826     *
11827     * @param obj The entry object
11828     * @return autocapitalization type
11829     */
11830    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11831    /**
11832     * Sets the attribute to show the input panel automatically.
11833     *
11834     * @param obj The entry object
11835     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11836     */
11837    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11838    /**
11839     * Retrieve the attribute to show the input panel automatically.
11840     *
11841     * @param obj The entry object
11842     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11843     */
11844    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11845
11846    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11847    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11848    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11849    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11850    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11851    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11852    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11853
11854    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11855    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
11856    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11857    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11858    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11859
11860    /**
11861     * @}
11862     */
11863
11864    /* composite widgets - these basically put together basic widgets above
11865     * in convenient packages that do more than basic stuff */
11866
11867    /* anchorview */
11868    /**
11869     * @defgroup Anchorview Anchorview
11870     *
11871     * @image html img/widget/anchorview/preview-00.png
11872     * @image latex img/widget/anchorview/preview-00.eps
11873     *
11874     * Anchorview is for displaying text that contains markup with anchors
11875     * like <c>\<a href=1234\>something\</\></c> in it.
11876     *
11877     * Besides being styled differently, the anchorview widget provides the
11878     * necessary functionality so that clicking on these anchors brings up a
11879     * popup with user defined content such as "call", "add to contacts" or
11880     * "open web page". This popup is provided using the @ref Hover widget.
11881     *
11882     * This widget is very similar to @ref Anchorblock, so refer to that
11883     * widget for an example. The only difference Anchorview has is that the
11884     * widget is already provided with scrolling functionality, so if the
11885     * text set to it is too large to fit in the given space, it will scroll,
11886     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11887     * text can be displayed.
11888     *
11889     * This widget emits the following signals:
11890     * @li "anchor,clicked": will be called when an anchor is clicked. The
11891     * @p event_info parameter on the callback will be a pointer of type
11892     * ::Elm_Entry_Anchorview_Info.
11893     *
11894     * See @ref Anchorblock for an example on how to use both of them.
11895     *
11896     * @see Anchorblock
11897     * @see Entry
11898     * @see Hover
11899     *
11900     * @{
11901     */
11902    /**
11903     * @typedef Elm_Entry_Anchorview_Info
11904     *
11905     * The info sent in the callback for "anchor,clicked" signals emitted by
11906     * the Anchorview widget.
11907     */
11908    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11909    /**
11910     * @struct _Elm_Entry_Anchorview_Info
11911     *
11912     * The info sent in the callback for "anchor,clicked" signals emitted by
11913     * the Anchorview widget.
11914     */
11915    struct _Elm_Entry_Anchorview_Info
11916      {
11917         const char     *name; /**< Name of the anchor, as indicated in its href
11918                                    attribute */
11919         int             button; /**< The mouse button used to click on it */
11920         Evas_Object    *hover; /**< The hover object to use for the popup */
11921         struct {
11922              Evas_Coord    x, y, w, h;
11923         } anchor, /**< Geometry selection of text used as anchor */
11924           hover_parent; /**< Geometry of the object used as parent by the
11925                              hover */
11926         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11927                                              for content on the left side of
11928                                              the hover. Before calling the
11929                                              callback, the widget will make the
11930                                              necessary calculations to check
11931                                              which sides are fit to be set with
11932                                              content, based on the position the
11933                                              hover is activated and its distance
11934                                              to the edges of its parent object
11935                                              */
11936         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11937                                               the right side of the hover.
11938                                               See @ref hover_left */
11939         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11940                                             of the hover. See @ref hover_left */
11941         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11942                                                below the hover. See @ref
11943                                                hover_left */
11944      };
11945    /**
11946     * Add a new Anchorview object
11947     *
11948     * @param parent The parent object
11949     * @return The new object or NULL if it cannot be created
11950     */
11951    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11952    /**
11953     * Set the text to show in the anchorview
11954     *
11955     * Sets the text of the anchorview to @p text. This text can include markup
11956     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11957     * text that will be specially styled and react to click events, ended with
11958     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11959     * "anchor,clicked" signal that you can attach a callback to with
11960     * evas_object_smart_callback_add(). The name of the anchor given in the
11961     * event info struct will be the one set in the href attribute, in this
11962     * case, anchorname.
11963     *
11964     * Other markup can be used to style the text in different ways, but it's
11965     * up to the style defined in the theme which tags do what.
11966     * @deprecated use elm_object_text_set() instead.
11967     */
11968    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11969    /**
11970     * Get the markup text set for the anchorview
11971     *
11972     * Retrieves the text set on the anchorview, with markup tags included.
11973     *
11974     * @param obj The anchorview object
11975     * @return The markup text set or @c NULL if nothing was set or an error
11976     * occurred
11977     * @deprecated use elm_object_text_set() instead.
11978     */
11979    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11980    /**
11981     * Set the parent of the hover popup
11982     *
11983     * Sets the parent object to use by the hover created by the anchorview
11984     * when an anchor is clicked. See @ref Hover for more details on this.
11985     * If no parent is set, the same anchorview object will be used.
11986     *
11987     * @param obj The anchorview object
11988     * @param parent The object to use as parent for the hover
11989     */
11990    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11991    /**
11992     * Get the parent of the hover popup
11993     *
11994     * Get the object used as parent for the hover created by the anchorview
11995     * widget. See @ref Hover for more details on this.
11996     *
11997     * @param obj The anchorview object
11998     * @return The object used as parent for the hover, NULL if none is set.
11999     */
12000    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12001    /**
12002     * Set the style that the hover should use
12003     *
12004     * When creating the popup hover, anchorview will request that it's
12005     * themed according to @p style.
12006     *
12007     * @param obj The anchorview object
12008     * @param style The style to use for the underlying hover
12009     *
12010     * @see elm_object_style_set()
12011     */
12012    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12013    /**
12014     * Get the style that the hover should use
12015     *
12016     * Get the style the hover created by anchorview will use.
12017     *
12018     * @param obj The anchorview object
12019     * @return The style to use by the hover. NULL means the default is used.
12020     *
12021     * @see elm_object_style_set()
12022     */
12023    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12024    /**
12025     * Ends the hover popup in the anchorview
12026     *
12027     * When an anchor is clicked, the anchorview widget will create a hover
12028     * object to use as a popup with user provided content. This function
12029     * terminates this popup, returning the anchorview to its normal state.
12030     *
12031     * @param obj The anchorview object
12032     */
12033    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12034    /**
12035     * Set bouncing behaviour when the scrolled content reaches an edge
12036     *
12037     * Tell the internal scroller object whether it should bounce or not
12038     * when it reaches the respective edges for each axis.
12039     *
12040     * @param obj The anchorview object
12041     * @param h_bounce Whether to bounce or not in the horizontal axis
12042     * @param v_bounce Whether to bounce or not in the vertical axis
12043     *
12044     * @see elm_scroller_bounce_set()
12045     */
12046    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12047    /**
12048     * Get the set bouncing behaviour of the internal scroller
12049     *
12050     * Get whether the internal scroller should bounce when the edge of each
12051     * axis is reached scrolling.
12052     *
12053     * @param obj The anchorview object
12054     * @param h_bounce Pointer where to store the bounce state of the horizontal
12055     *                 axis
12056     * @param v_bounce Pointer where to store the bounce state of the vertical
12057     *                 axis
12058     *
12059     * @see elm_scroller_bounce_get()
12060     */
12061    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12062    /**
12063     * Appends a custom item provider to the given anchorview
12064     *
12065     * Appends the given function to the list of items providers. This list is
12066     * called, one function at a time, with the given @p data pointer, the
12067     * anchorview object and, in the @p item parameter, the item name as
12068     * referenced in its href string. Following functions in the list will be
12069     * called in order until one of them returns something different to NULL,
12070     * which should be an Evas_Object which will be used in place of the item
12071     * element.
12072     *
12073     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12074     * href=item/name\>\</item\>
12075     *
12076     * @param obj The anchorview object
12077     * @param func The function to add to the list of providers
12078     * @param data User data that will be passed to the callback function
12079     *
12080     * @see elm_entry_item_provider_append()
12081     */
12082    EAPI void         elm_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);
12083    /**
12084     * Prepend a custom item provider to the given anchorview
12085     *
12086     * Like elm_anchorview_item_provider_append(), but it adds the function
12087     * @p func to the beginning of the list, instead of the end.
12088     *
12089     * @param obj The anchorview object
12090     * @param func The function to add to the list of providers
12091     * @param data User data that will be passed to the callback function
12092     */
12093    EAPI void         elm_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);
12094    /**
12095     * Remove a custom item provider from the list of the given anchorview
12096     *
12097     * Removes the function and data pairing that matches @p func and @p data.
12098     * That is, unless the same function and same user data are given, the
12099     * function will not be removed from the list. This allows us to add the
12100     * same callback several times, with different @p data pointers and be
12101     * able to remove them later without conflicts.
12102     *
12103     * @param obj The anchorview object
12104     * @param func The function to remove from the list
12105     * @param data The data matching the function to remove from the list
12106     */
12107    EAPI void         elm_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);
12108    /**
12109     * @}
12110     */
12111
12112    /* anchorblock */
12113    /**
12114     * @defgroup Anchorblock Anchorblock
12115     *
12116     * @image html img/widget/anchorblock/preview-00.png
12117     * @image latex img/widget/anchorblock/preview-00.eps
12118     *
12119     * Anchorblock is for displaying text that contains markup with anchors
12120     * like <c>\<a href=1234\>something\</\></c> in it.
12121     *
12122     * Besides being styled differently, the anchorblock widget provides the
12123     * necessary functionality so that clicking on these anchors brings up a
12124     * popup with user defined content such as "call", "add to contacts" or
12125     * "open web page". This popup is provided using the @ref Hover widget.
12126     *
12127     * This widget emits the following signals:
12128     * @li "anchor,clicked": will be called when an anchor is clicked. The
12129     * @p event_info parameter on the callback will be a pointer of type
12130     * ::Elm_Entry_Anchorblock_Info.
12131     *
12132     * @see Anchorview
12133     * @see Entry
12134     * @see Hover
12135     *
12136     * Since examples are usually better than plain words, we might as well
12137     * try @ref tutorial_anchorblock_example "one".
12138     */
12139    /**
12140     * @addtogroup Anchorblock
12141     * @{
12142     */
12143    /**
12144     * @typedef Elm_Entry_Anchorblock_Info
12145     *
12146     * The info sent in the callback for "anchor,clicked" signals emitted by
12147     * the Anchorblock widget.
12148     */
12149    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12150    /**
12151     * @struct _Elm_Entry_Anchorblock_Info
12152     *
12153     * The info sent in the callback for "anchor,clicked" signals emitted by
12154     * the Anchorblock widget.
12155     */
12156    struct _Elm_Entry_Anchorblock_Info
12157      {
12158         const char     *name; /**< Name of the anchor, as indicated in its href
12159                                    attribute */
12160         int             button; /**< The mouse button used to click on it */
12161         Evas_Object    *hover; /**< The hover object to use for the popup */
12162         struct {
12163              Evas_Coord    x, y, w, h;
12164         } anchor, /**< Geometry selection of text used as anchor */
12165           hover_parent; /**< Geometry of the object used as parent by the
12166                              hover */
12167         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12168                                              for content on the left side of
12169                                              the hover. Before calling the
12170                                              callback, the widget will make the
12171                                              necessary calculations to check
12172                                              which sides are fit to be set with
12173                                              content, based on the position the
12174                                              hover is activated and its distance
12175                                              to the edges of its parent object
12176                                              */
12177         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12178                                               the right side of the hover.
12179                                               See @ref hover_left */
12180         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12181                                             of the hover. See @ref hover_left */
12182         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12183                                                below the hover. See @ref
12184                                                hover_left */
12185      };
12186    /**
12187     * Add a new Anchorblock object
12188     *
12189     * @param parent The parent object
12190     * @return The new object or NULL if it cannot be created
12191     */
12192    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12193    /**
12194     * Set the text to show in the anchorblock
12195     *
12196     * Sets the text of the anchorblock to @p text. This text can include markup
12197     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12198     * of text that will be specially styled and react to click events, ended
12199     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12200     * "anchor,clicked" signal that you can attach a callback to with
12201     * evas_object_smart_callback_add(). The name of the anchor given in the
12202     * event info struct will be the one set in the href attribute, in this
12203     * case, anchorname.
12204     *
12205     * Other markup can be used to style the text in different ways, but it's
12206     * up to the style defined in the theme which tags do what.
12207     * @deprecated use elm_object_text_set() instead.
12208     */
12209    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12210    /**
12211     * Get the markup text set for the anchorblock
12212     *
12213     * Retrieves the text set on the anchorblock, with markup tags included.
12214     *
12215     * @param obj The anchorblock object
12216     * @return The markup text set or @c NULL if nothing was set or an error
12217     * occurred
12218     * @deprecated use elm_object_text_set() instead.
12219     */
12220    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12221    /**
12222     * Set the parent of the hover popup
12223     *
12224     * Sets the parent object to use by the hover created by the anchorblock
12225     * when an anchor is clicked. See @ref Hover for more details on this.
12226     *
12227     * @param obj The anchorblock object
12228     * @param parent The object to use as parent for the hover
12229     */
12230    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12231    /**
12232     * Get the parent of the hover popup
12233     *
12234     * Get the object used as parent for the hover created by the anchorblock
12235     * widget. See @ref Hover for more details on this.
12236     * If no parent is set, the same anchorblock object will be used.
12237     *
12238     * @param obj The anchorblock object
12239     * @return The object used as parent for the hover, NULL if none is set.
12240     */
12241    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12242    /**
12243     * Set the style that the hover should use
12244     *
12245     * When creating the popup hover, anchorblock will request that it's
12246     * themed according to @p style.
12247     *
12248     * @param obj The anchorblock object
12249     * @param style The style to use for the underlying hover
12250     *
12251     * @see elm_object_style_set()
12252     */
12253    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12254    /**
12255     * Get the style that the hover should use
12256     *
12257     * Get the style, the hover created by anchorblock will use.
12258     *
12259     * @param obj The anchorblock object
12260     * @return The style to use by the hover. NULL means the default is used.
12261     *
12262     * @see elm_object_style_set()
12263     */
12264    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12265    /**
12266     * Ends the hover popup in the anchorblock
12267     *
12268     * When an anchor is clicked, the anchorblock widget will create a hover
12269     * object to use as a popup with user provided content. This function
12270     * terminates this popup, returning the anchorblock to its normal state.
12271     *
12272     * @param obj The anchorblock object
12273     */
12274    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12275    /**
12276     * Appends a custom item provider to the given anchorblock
12277     *
12278     * Appends the given function to the list of items providers. This list is
12279     * called, one function at a time, with the given @p data pointer, the
12280     * anchorblock object and, in the @p item parameter, the item name as
12281     * referenced in its href string. Following functions in the list will be
12282     * called in order until one of them returns something different to NULL,
12283     * which should be an Evas_Object which will be used in place of the item
12284     * element.
12285     *
12286     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12287     * href=item/name\>\</item\>
12288     *
12289     * @param obj The anchorblock object
12290     * @param func The function to add to the list of providers
12291     * @param data User data that will be passed to the callback function
12292     *
12293     * @see elm_entry_item_provider_append()
12294     */
12295    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);
12296    /**
12297     * Prepend a custom item provider to the given anchorblock
12298     *
12299     * Like elm_anchorblock_item_provider_append(), but it adds the function
12300     * @p func to the beginning of the list, instead of the end.
12301     *
12302     * @param obj The anchorblock object
12303     * @param func The function to add to the list of providers
12304     * @param data User data that will be passed to the callback function
12305     */
12306    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);
12307    /**
12308     * Remove a custom item provider from the list of the given anchorblock
12309     *
12310     * Removes the function and data pairing that matches @p func and @p data.
12311     * That is, unless the same function and same user data are given, the
12312     * function will not be removed from the list. This allows us to add the
12313     * same callback several times, with different @p data pointers and be
12314     * able to remove them later without conflicts.
12315     *
12316     * @param obj The anchorblock object
12317     * @param func The function to remove from the list
12318     * @param data The data matching the function to remove from the list
12319     */
12320    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);
12321    /**
12322     * @}
12323     */
12324
12325    /**
12326     * @defgroup Bubble Bubble
12327     *
12328     * @image html img/widget/bubble/preview-00.png
12329     * @image latex img/widget/bubble/preview-00.eps
12330     * @image html img/widget/bubble/preview-01.png
12331     * @image latex img/widget/bubble/preview-01.eps
12332     * @image html img/widget/bubble/preview-02.png
12333     * @image latex img/widget/bubble/preview-02.eps
12334     *
12335     * @brief The Bubble is a widget to show text similar to how speech is
12336     * represented in comics.
12337     *
12338     * The bubble widget contains 5 important visual elements:
12339     * @li The frame is a rectangle with rounded edjes and an "arrow".
12340     * @li The @p icon is an image to which the frame's arrow points to.
12341     * @li The @p label is a text which appears to the right of the icon if the
12342     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12343     * otherwise.
12344     * @li The @p info is a text which appears to the right of the label. Info's
12345     * font is of a ligther color than label.
12346     * @li The @p content is an evas object that is shown inside the frame.
12347     *
12348     * The position of the arrow, icon, label and info depends on which corner is
12349     * selected. The four available corners are:
12350     * @li "top_left" - Default
12351     * @li "top_right"
12352     * @li "bottom_left"
12353     * @li "bottom_right"
12354     *
12355     * Signals that you can add callbacks for are:
12356     * @li "clicked" - This is called when a user has clicked the bubble.
12357     *
12358     * For an example of using a buble see @ref bubble_01_example_page "this".
12359     *
12360     * @{
12361     */
12362
12363 #define ELM_BUBBLE_CONTENT_ICON "elm.swallow.icon"
12364
12365    /**
12366     * Add a new bubble to the parent
12367     *
12368     * @param parent The parent object
12369     * @return The new object or NULL if it cannot be created
12370     *
12371     * This function adds a text bubble to the given parent evas object.
12372     */
12373    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12374    /**
12375     * Set the label of the bubble
12376     *
12377     * @param obj The bubble object
12378     * @param label The string to set in the label
12379     *
12380     * This function sets the title of the bubble. Where this appears depends on
12381     * the selected corner.
12382     * @deprecated use elm_object_text_set() instead.
12383     */
12384    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12385    /**
12386     * Get the label of the bubble
12387     *
12388     * @param obj The bubble object
12389     * @return The string of set in the label
12390     *
12391     * This function gets the title of the bubble.
12392     * @deprecated use elm_object_text_get() instead.
12393     */
12394    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12395    /**
12396     * Set the info of the bubble
12397     *
12398     * @param obj The bubble object
12399     * @param info The given info about the bubble
12400     *
12401     * This function sets the info of the bubble. Where this appears depends on
12402     * the selected corner.
12403     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12404     */
12405    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12406    /**
12407     * Get the info of the bubble
12408     *
12409     * @param obj The bubble object
12410     *
12411     * @return The "info" string of the bubble
12412     *
12413     * This function gets the info text.
12414     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12415     */
12416    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12417    /**
12418     * Set the content to be shown in the bubble
12419     *
12420     * Once the content object is set, a previously set one will be deleted.
12421     * If you want to keep the old content object, use the
12422     * elm_bubble_content_unset() function.
12423     *
12424     * @param obj The bubble object
12425     * @param content The given content of the bubble
12426     *
12427     * This function sets the content shown on the middle of the bubble.
12428     */
12429    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12430    /**
12431     * Get the content shown in the bubble
12432     *
12433     * Return the content object which is set for this widget.
12434     *
12435     * @param obj The bubble object
12436     * @return The content that is being used
12437     */
12438    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12439    /**
12440     * Unset the content shown in the bubble
12441     *
12442     * Unparent and return the content object which was set for this widget.
12443     *
12444     * @param obj The bubble object
12445     * @return The content that was being used
12446     */
12447    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12448    /**
12449     * Set the icon of the bubble
12450     *
12451     * Once the icon object is set, a previously set one will be deleted.
12452     * If you want to keep the old content object, use the
12453     * elm_icon_content_unset() function.
12454     *
12455     * @param obj The bubble object
12456     * @param icon The given icon for the bubble
12457     *
12458     * @deprecated use elm_object_content_part_set() instead
12459     *
12460     */
12461    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12462    /**
12463     * Get the icon of the bubble
12464     *
12465     * @param obj The bubble object
12466     * @return The icon for the bubble
12467     *
12468     * This function gets the icon shown on the top left of bubble.
12469     *
12470     * @deprecated use elm_object_content_part_get() instead
12471     *
12472     */
12473    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12474    /**
12475     * Unset the icon of the bubble
12476     *
12477     * Unparent and return the icon object which was set for this widget.
12478     *
12479     * @param obj The bubble object
12480     * @return The icon that was being used
12481     *
12482     * @deprecated use elm_object_content_part_unset() instead
12483     *
12484     */
12485    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12486    /**
12487     * Set the corner of the bubble
12488     *
12489     * @param obj The bubble object.
12490     * @param corner The given corner for the bubble.
12491     *
12492     * This function sets the corner of the bubble. The corner will be used to
12493     * determine where the arrow in the frame points to and where label, icon and
12494     * info are shown.
12495     *
12496     * Possible values for corner are:
12497     * @li "top_left" - Default
12498     * @li "top_right"
12499     * @li "bottom_left"
12500     * @li "bottom_right"
12501     */
12502    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12503    /**
12504     * Get the corner of the bubble
12505     *
12506     * @param obj The bubble object.
12507     * @return The given corner for the bubble.
12508     *
12509     * This function gets the selected corner of the bubble.
12510     */
12511    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12512
12513    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12514    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12515
12516    /**
12517     * @}
12518     */
12519
12520    /**
12521     * @defgroup Photo Photo
12522     *
12523     * For displaying the photo of a person (contact). Simple, yet
12524     * with a very specific purpose.
12525     *
12526     * Signals that you can add callbacks for are:
12527     *
12528     * "clicked" - This is called when a user has clicked the photo
12529     * "drag,start" - Someone started dragging the image out of the object
12530     * "drag,end" - Dragged item was dropped (somewhere)
12531     *
12532     * @{
12533     */
12534
12535    /**
12536     * Add a new photo to the parent
12537     *
12538     * @param parent The parent object
12539     * @return The new object or NULL if it cannot be created
12540     *
12541     * @ingroup Photo
12542     */
12543    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12544
12545    /**
12546     * Set the file that will be used as photo
12547     *
12548     * @param obj The photo object
12549     * @param file The path to file that will be used as photo
12550     *
12551     * @return (1 = success, 0 = error)
12552     *
12553     * @ingroup Photo
12554     */
12555    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12556
12557     /**
12558     * Set the file that will be used as thumbnail in the photo.
12559     *
12560     * @param obj The photo object.
12561     * @param file The path to file that will be used as thumb.
12562     * @param group The key used in case of an EET file.
12563     *
12564     * @ingroup Photo
12565     */
12566    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12567
12568    /**
12569     * Set the size that will be used on the photo
12570     *
12571     * @param obj The photo object
12572     * @param size The size that the photo will be
12573     *
12574     * @ingroup Photo
12575     */
12576    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12577
12578    /**
12579     * Set if the photo should be completely visible or not.
12580     *
12581     * @param obj The photo object
12582     * @param fill if true the photo will be completely visible
12583     *
12584     * @ingroup Photo
12585     */
12586    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12587
12588    /**
12589     * Set editability of the photo.
12590     *
12591     * An editable photo can be dragged to or from, and can be cut or
12592     * pasted too.  Note that pasting an image or dropping an item on
12593     * the image will delete the existing content.
12594     *
12595     * @param obj The photo object.
12596     * @param set To set of clear editablity.
12597     */
12598    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12599
12600    /**
12601     * @}
12602     */
12603
12604    /* gesture layer */
12605    /**
12606     * @defgroup Elm_Gesture_Layer Gesture Layer
12607     * Gesture Layer Usage:
12608     *
12609     * Use Gesture Layer to detect gestures.
12610     * The advantage is that you don't have to implement
12611     * gesture detection, just set callbacks of gesture state.
12612     * By using gesture layer we make standard interface.
12613     *
12614     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12615     * with a parent object parameter.
12616     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12617     * call. Usually with same object as target (2nd parameter).
12618     *
12619     * Now you need to tell gesture layer what gestures you follow.
12620     * This is done with @ref elm_gesture_layer_cb_set call.
12621     * By setting the callback you actually saying to gesture layer:
12622     * I would like to know when the gesture @ref Elm_Gesture_Types
12623     * switches to state @ref Elm_Gesture_State.
12624     *
12625     * Next, you need to implement the actual action that follows the input
12626     * in your callback.
12627     *
12628     * Note that if you like to stop being reported about a gesture, just set
12629     * all callbacks referring this gesture to NULL.
12630     * (again with @ref elm_gesture_layer_cb_set)
12631     *
12632     * The information reported by gesture layer to your callback is depending
12633     * on @ref Elm_Gesture_Types:
12634     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12635     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12636     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12637     *
12638     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12639     * @ref ELM_GESTURE_MOMENTUM.
12640     *
12641     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12642     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12643     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12644     * Note that we consider a flick as a line-gesture that should be completed
12645     * in flick-time-limit as defined in @ref Config.
12646     *
12647     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12648     *
12649     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12650     *
12651     *
12652     * Gesture Layer Tweaks:
12653     *
12654     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12655     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12656     *
12657     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12658     * so gesture starts when user touches (a *DOWN event) touch-surface
12659     * and ends when no fingers touches surface (a *UP event).
12660     */
12661
12662    /**
12663     * @enum _Elm_Gesture_Types
12664     * Enum of supported gesture types.
12665     * @ingroup Elm_Gesture_Layer
12666     */
12667    enum _Elm_Gesture_Types
12668      {
12669         ELM_GESTURE_FIRST = 0,
12670
12671         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12672         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12673         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12674         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12675
12676         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12677
12678         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12679         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12680
12681         ELM_GESTURE_ZOOM, /**< Zoom */
12682         ELM_GESTURE_ROTATE, /**< Rotate */
12683
12684         ELM_GESTURE_LAST
12685      };
12686
12687    /**
12688     * @typedef Elm_Gesture_Types
12689     * gesture types enum
12690     * @ingroup Elm_Gesture_Layer
12691     */
12692    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12693
12694    /**
12695     * @enum _Elm_Gesture_State
12696     * Enum of gesture states.
12697     * @ingroup Elm_Gesture_Layer
12698     */
12699    enum _Elm_Gesture_State
12700      {
12701         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12702         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12703         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12704         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12705         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12706      };
12707
12708    /**
12709     * @typedef Elm_Gesture_State
12710     * gesture states enum
12711     * @ingroup Elm_Gesture_Layer
12712     */
12713    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12714
12715    /**
12716     * @struct _Elm_Gesture_Taps_Info
12717     * Struct holds taps info for user
12718     * @ingroup Elm_Gesture_Layer
12719     */
12720    struct _Elm_Gesture_Taps_Info
12721      {
12722         Evas_Coord x, y;         /**< Holds center point between fingers */
12723         unsigned int n;          /**< Number of fingers tapped           */
12724         unsigned int timestamp;  /**< event timestamp       */
12725      };
12726
12727    /**
12728     * @typedef Elm_Gesture_Taps_Info
12729     * holds taps info for user
12730     * @ingroup Elm_Gesture_Layer
12731     */
12732    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12733
12734    /**
12735     * @struct _Elm_Gesture_Momentum_Info
12736     * Struct holds momentum info for user
12737     * x1 and y1 are not necessarily in sync
12738     * x1 holds x value of x direction starting point
12739     * and same holds for y1.
12740     * This is noticeable when doing V-shape movement
12741     * @ingroup Elm_Gesture_Layer
12742     */
12743    struct _Elm_Gesture_Momentum_Info
12744      {  /* Report line ends, timestamps, and momentum computed        */
12745         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12746         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12747         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12748         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12749
12750         unsigned int tx; /**< Timestamp of start of final x-swipe */
12751         unsigned int ty; /**< Timestamp of start of final y-swipe */
12752
12753         Evas_Coord mx; /**< Momentum on X */
12754         Evas_Coord my; /**< Momentum on Y */
12755
12756         unsigned int n;  /**< Number of fingers */
12757      };
12758
12759    /**
12760     * @typedef Elm_Gesture_Momentum_Info
12761     * holds momentum info for user
12762     * @ingroup Elm_Gesture_Layer
12763     */
12764     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12765
12766    /**
12767     * @struct _Elm_Gesture_Line_Info
12768     * Struct holds line info for user
12769     * @ingroup Elm_Gesture_Layer
12770     */
12771    struct _Elm_Gesture_Line_Info
12772      {  /* Report line ends, timestamps, and momentum computed      */
12773         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12774         double angle;              /**< Angle (direction) of lines  */
12775      };
12776
12777    /**
12778     * @typedef Elm_Gesture_Line_Info
12779     * Holds line info for user
12780     * @ingroup Elm_Gesture_Layer
12781     */
12782     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12783
12784    /**
12785     * @struct _Elm_Gesture_Zoom_Info
12786     * Struct holds zoom info for user
12787     * @ingroup Elm_Gesture_Layer
12788     */
12789    struct _Elm_Gesture_Zoom_Info
12790      {
12791         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12792         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12793         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12794         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12795      };
12796
12797    /**
12798     * @typedef Elm_Gesture_Zoom_Info
12799     * Holds zoom info for user
12800     * @ingroup Elm_Gesture_Layer
12801     */
12802    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12803
12804    /**
12805     * @struct _Elm_Gesture_Rotate_Info
12806     * Struct holds rotation info for user
12807     * @ingroup Elm_Gesture_Layer
12808     */
12809    struct _Elm_Gesture_Rotate_Info
12810      {
12811         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12812         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12813         double base_angle; /**< Holds start-angle */
12814         double angle;      /**< Rotation value: 0.0 means no rotation         */
12815         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12816      };
12817
12818    /**
12819     * @typedef Elm_Gesture_Rotate_Info
12820     * Holds rotation info for user
12821     * @ingroup Elm_Gesture_Layer
12822     */
12823    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12824
12825    /**
12826     * @typedef Elm_Gesture_Event_Cb
12827     * User callback used to stream gesture info from gesture layer
12828     * @param data user data
12829     * @param event_info gesture report info
12830     * Returns a flag field to be applied on the causing event.
12831     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12832     * upon the event, in an irreversible way.
12833     *
12834     * @ingroup Elm_Gesture_Layer
12835     */
12836    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12837
12838    /**
12839     * Use function to set callbacks to be notified about
12840     * change of state of gesture.
12841     * When a user registers a callback with this function
12842     * this means this gesture has to be tested.
12843     *
12844     * When ALL callbacks for a gesture are set to NULL
12845     * it means user isn't interested in gesture-state
12846     * and it will not be tested.
12847     *
12848     * @param obj Pointer to gesture-layer.
12849     * @param idx The gesture you would like to track its state.
12850     * @param cb callback function pointer.
12851     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12852     * @param data user info to be sent to callback (usually, Smart Data)
12853     *
12854     * @ingroup Elm_Gesture_Layer
12855     */
12856    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);
12857
12858    /**
12859     * Call this function to get repeat-events settings.
12860     *
12861     * @param obj Pointer to gesture-layer.
12862     *
12863     * @return repeat events settings.
12864     * @see elm_gesture_layer_hold_events_set()
12865     * @ingroup Elm_Gesture_Layer
12866     */
12867    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12868
12869    /**
12870     * This function called in order to make gesture-layer repeat events.
12871     * Set this of you like to get the raw events only if gestures were not detected.
12872     * Clear this if you like gesture layer to fwd events as testing gestures.
12873     *
12874     * @param obj Pointer to gesture-layer.
12875     * @param r Repeat: TRUE/FALSE
12876     *
12877     * @ingroup Elm_Gesture_Layer
12878     */
12879    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12880
12881    /**
12882     * This function sets step-value for zoom action.
12883     * Set step to any positive value.
12884     * Cancel step setting by setting to 0.0
12885     *
12886     * @param obj Pointer to gesture-layer.
12887     * @param s new zoom step value.
12888     *
12889     * @ingroup Elm_Gesture_Layer
12890     */
12891    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12892
12893    /**
12894     * This function sets step-value for rotate action.
12895     * Set step to any positive value.
12896     * Cancel step setting by setting to 0.0
12897     *
12898     * @param obj Pointer to gesture-layer.
12899     * @param s new roatate step value.
12900     *
12901     * @ingroup Elm_Gesture_Layer
12902     */
12903    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12904
12905    /**
12906     * This function called to attach gesture-layer to an Evas_Object.
12907     * @param obj Pointer to gesture-layer.
12908     * @param t Pointer to underlying object (AKA Target)
12909     *
12910     * @return TRUE, FALSE on success, failure.
12911     *
12912     * @ingroup Elm_Gesture_Layer
12913     */
12914    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12915
12916    /**
12917     * Call this function to construct a new gesture-layer object.
12918     * This does not activate the gesture layer. You have to
12919     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12920     *
12921     * @param parent the parent object.
12922     *
12923     * @return Pointer to new gesture-layer object.
12924     *
12925     * @ingroup Elm_Gesture_Layer
12926     */
12927    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12928
12929    /**
12930     * @defgroup Thumb Thumb
12931     *
12932     * @image html img/widget/thumb/preview-00.png
12933     * @image latex img/widget/thumb/preview-00.eps
12934     *
12935     * A thumb object is used for displaying the thumbnail of an image or video.
12936     * You must have compiled Elementary with Ethumb_Client support and the DBus
12937     * service must be present and auto-activated in order to have thumbnails to
12938     * be generated.
12939     *
12940     * Once the thumbnail object becomes visible, it will check if there is a
12941     * previously generated thumbnail image for the file set on it. If not, it
12942     * will start generating this thumbnail.
12943     *
12944     * Different config settings will cause different thumbnails to be generated
12945     * even on the same file.
12946     *
12947     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12948     * Ethumb documentation to change this path, and to see other configuration
12949     * options.
12950     *
12951     * Signals that you can add callbacks for are:
12952     *
12953     * - "clicked" - This is called when a user has clicked the thumb without dragging
12954     *             around.
12955     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12956     * - "press" - This is called when a user has pressed down the thumb.
12957     * - "generate,start" - The thumbnail generation started.
12958     * - "generate,stop" - The generation process stopped.
12959     * - "generate,error" - The generation failed.
12960     * - "load,error" - The thumbnail image loading failed.
12961     *
12962     * available styles:
12963     * - default
12964     * - noframe
12965     *
12966     * An example of use of thumbnail:
12967     *
12968     * - @ref thumb_example_01
12969     */
12970
12971    /**
12972     * @addtogroup Thumb
12973     * @{
12974     */
12975
12976    /**
12977     * @enum _Elm_Thumb_Animation_Setting
12978     * @typedef Elm_Thumb_Animation_Setting
12979     *
12980     * Used to set if a video thumbnail is animating or not.
12981     *
12982     * @ingroup Thumb
12983     */
12984    typedef enum _Elm_Thumb_Animation_Setting
12985      {
12986         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12987         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12988         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12989         ELM_THUMB_ANIMATION_LAST
12990      } Elm_Thumb_Animation_Setting;
12991
12992    /**
12993     * Add a new thumb object to the parent.
12994     *
12995     * @param parent The parent object.
12996     * @return The new object or NULL if it cannot be created.
12997     *
12998     * @see elm_thumb_file_set()
12999     * @see elm_thumb_ethumb_client_get()
13000     *
13001     * @ingroup Thumb
13002     */
13003    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13004    /**
13005     * Reload thumbnail if it was generated before.
13006     *
13007     * @param obj The thumb object to reload
13008     *
13009     * This is useful if the ethumb client configuration changed, like its
13010     * size, aspect or any other property one set in the handle returned
13011     * by elm_thumb_ethumb_client_get().
13012     *
13013     * If the options didn't change, the thumbnail won't be generated again, but
13014     * the old one will still be used.
13015     *
13016     * @see elm_thumb_file_set()
13017     *
13018     * @ingroup Thumb
13019     */
13020    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13021    /**
13022     * Set the file that will be used as thumbnail.
13023     *
13024     * @param obj The thumb object.
13025     * @param file The path to file that will be used as thumb.
13026     * @param key The key used in case of an EET file.
13027     *
13028     * The file can be an image or a video (in that case, acceptable extensions are:
13029     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13030     * function elm_thumb_animate().
13031     *
13032     * @see elm_thumb_file_get()
13033     * @see elm_thumb_reload()
13034     * @see elm_thumb_animate()
13035     *
13036     * @ingroup Thumb
13037     */
13038    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13039    /**
13040     * Get the image or video path and key used to generate the thumbnail.
13041     *
13042     * @param obj The thumb object.
13043     * @param file Pointer to filename.
13044     * @param key Pointer to key.
13045     *
13046     * @see elm_thumb_file_set()
13047     * @see elm_thumb_path_get()
13048     *
13049     * @ingroup Thumb
13050     */
13051    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13052    /**
13053     * Get the path and key to the image or video generated by ethumb.
13054     *
13055     * One just need to make sure that the thumbnail was generated before getting
13056     * its path; otherwise, the path will be NULL. One way to do that is by asking
13057     * for the path when/after the "generate,stop" smart callback is called.
13058     *
13059     * @param obj The thumb object.
13060     * @param file Pointer to thumb path.
13061     * @param key Pointer to thumb key.
13062     *
13063     * @see elm_thumb_file_get()
13064     *
13065     * @ingroup Thumb
13066     */
13067    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13068    /**
13069     * Set the animation state for the thumb object. If its content is an animated
13070     * video, you may start/stop the animation or tell it to play continuously and
13071     * looping.
13072     *
13073     * @param obj The thumb object.
13074     * @param setting The animation setting.
13075     *
13076     * @see elm_thumb_file_set()
13077     *
13078     * @ingroup Thumb
13079     */
13080    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13081    /**
13082     * Get the animation state for the thumb object.
13083     *
13084     * @param obj The thumb object.
13085     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13086     * on errors.
13087     *
13088     * @see elm_thumb_animate_set()
13089     *
13090     * @ingroup Thumb
13091     */
13092    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13093    /**
13094     * Get the ethumb_client handle so custom configuration can be made.
13095     *
13096     * @return Ethumb_Client instance or NULL.
13097     *
13098     * This must be called before the objects are created to be sure no object is
13099     * visible and no generation started.
13100     *
13101     * Example of usage:
13102     *
13103     * @code
13104     * #include <Elementary.h>
13105     * #ifndef ELM_LIB_QUICKLAUNCH
13106     * EAPI_MAIN int
13107     * elm_main(int argc, char **argv)
13108     * {
13109     *    Ethumb_Client *client;
13110     *
13111     *    elm_need_ethumb();
13112     *
13113     *    // ... your code
13114     *
13115     *    client = elm_thumb_ethumb_client_get();
13116     *    if (!client)
13117     *      {
13118     *         ERR("could not get ethumb_client");
13119     *         return 1;
13120     *      }
13121     *    ethumb_client_size_set(client, 100, 100);
13122     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13123     *    // ... your code
13124     *
13125     *    // Create elm_thumb objects here
13126     *
13127     *    elm_run();
13128     *    elm_shutdown();
13129     *    return 0;
13130     * }
13131     * #endif
13132     * ELM_MAIN()
13133     * @endcode
13134     *
13135     * @note There's only one client handle for Ethumb, so once a configuration
13136     * change is done to it, any other request for thumbnails (for any thumbnail
13137     * object) will use that configuration. Thus, this configuration is global.
13138     *
13139     * @ingroup Thumb
13140     */
13141    EAPI void                        *elm_thumb_ethumb_client_get(void);
13142    /**
13143     * Get the ethumb_client connection state.
13144     *
13145     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13146     * otherwise.
13147     */
13148    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13149    /**
13150     * Make the thumbnail 'editable'.
13151     *
13152     * @param obj Thumb object.
13153     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13154     *
13155     * This means the thumbnail is a valid drag target for drag and drop, and can be
13156     * cut or pasted too.
13157     *
13158     * @see elm_thumb_editable_get()
13159     *
13160     * @ingroup Thumb
13161     */
13162    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13163    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13164    /**
13165     * Make the thumbnail 'editable'.
13166     *
13167     * @param obj Thumb object.
13168     * @return Editability.
13169     *
13170     * This means the thumbnail is a valid drag target for drag and drop, and can be
13171     * cut or pasted too.
13172     *
13173     * @see elm_thumb_editable_set()
13174     *
13175     * @ingroup Thumb
13176     */
13177    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13178
13179    /**
13180     * @}
13181     */
13182
13183    /**
13184     * @defgroup Web Web
13185     *
13186     * @image html img/widget/web/preview-00.png
13187     * @image latex img/widget/web/preview-00.eps
13188     *
13189     * A web object is used for displaying web pages (HTML/CSS/JS)
13190     * using WebKit-EFL. You must have compiled Elementary with
13191     * ewebkit support.
13192     *
13193     * Signals that you can add callbacks for are:
13194     * @li "download,request": A file download has been requested. Event info is
13195     * a pointer to a Elm_Web_Download
13196     * @li "editorclient,contents,changed": Editor client's contents changed
13197     * @li "editorclient,selection,changed": Editor client's selection changed
13198     * @li "frame,created": A new frame was created. Event info is an
13199     * Evas_Object which can be handled with WebKit's ewk_frame API
13200     * @li "icon,received": An icon was received by the main frame
13201     * @li "inputmethod,changed": Input method changed. Event info is an
13202     * Eina_Bool indicating whether it's enabled or not
13203     * @li "js,windowobject,clear": JS window object has been cleared
13204     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13205     * is a char *link[2], where the first string contains the URL the link
13206     * points to, and the second one the title of the link
13207     * @li "link,hover,out": Mouse cursor left the link
13208     * @li "load,document,finished": Loading of a document finished. Event info
13209     * is the frame that finished loading
13210     * @li "load,error": Load failed. Event info is a pointer to
13211     * Elm_Web_Frame_Load_Error
13212     * @li "load,finished": Load finished. Event info is NULL on success, on
13213     * error it's a pointer to Elm_Web_Frame_Load_Error
13214     * @li "load,newwindow,show": A new window was created and is ready to be
13215     * shown
13216     * @li "load,progress": Overall load progress. Event info is a pointer to
13217     * a double containing a value between 0.0 and 1.0
13218     * @li "load,provisional": Started provisional load
13219     * @li "load,started": Loading of a document started
13220     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13221     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13222     * the menubar is visible, or EINA_FALSE in case it's not
13223     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13224     * an Eina_Bool indicating the visibility
13225     * @li "popup,created": A dropdown widget was activated, requesting its
13226     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13227     * @li "popup,willdelete": The web object is ready to destroy the popup
13228     * object created. Event info is a pointer to Elm_Web_Menu
13229     * @li "ready": Page is fully loaded
13230     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13231     * info is a pointer to Eina_Bool where the visibility state should be set
13232     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13233     * is an Eina_Bool with the visibility state set
13234     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13235     * a string with the new text
13236     * @li "statusbar,visible,get": Queries visibility of the status bar.
13237     * Event info is a pointer to Eina_Bool where the visibility state should be
13238     * set.
13239     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13240     * an Eina_Bool with the visibility value
13241     * @li "title,changed": Title of the main frame changed. Event info is a
13242     * string with the new title
13243     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13244     * is a pointer to Eina_Bool where the visibility state should be set
13245     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13246     * info is an Eina_Bool with the visibility state
13247     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13248     * a string with the text to show
13249     * @li "uri,changed": URI of the main frame changed. Event info is a string
13250     * with the new URI
13251     * @li "view,resized": The web object internal's view changed sized
13252     * @li "windows,close,request": A JavaScript request to close the current
13253     * window was requested
13254     * @li "zoom,animated,end": Animated zoom finished
13255     *
13256     * available styles:
13257     * - default
13258     *
13259     * An example of use of web:
13260     *
13261     * - @ref web_example_01 TBD
13262     */
13263
13264    /**
13265     * @addtogroup Web
13266     * @{
13267     */
13268
13269    /**
13270     * Structure used to report load errors.
13271     *
13272     * Load errors are reported as signal by elm_web. All the strings are
13273     * temporary references and should @b not be used after the signal
13274     * callback returns. If it's required, make copies with strdup() or
13275     * eina_stringshare_add() (they are not even guaranteed to be
13276     * stringshared, so must use eina_stringshare_add() and not
13277     * eina_stringshare_ref()).
13278     */
13279    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13280    /**
13281     * Structure used to report load errors.
13282     *
13283     * Load errors are reported as signal by elm_web. All the strings are
13284     * temporary references and should @b not be used after the signal
13285     * callback returns. If it's required, make copies with strdup() or
13286     * eina_stringshare_add() (they are not even guaranteed to be
13287     * stringshared, so must use eina_stringshare_add() and not
13288     * eina_stringshare_ref()).
13289     */
13290    struct _Elm_Web_Frame_Load_Error
13291      {
13292         int code; /**< Numeric error code */
13293         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13294         const char *domain; /**< Error domain name */
13295         const char *description; /**< Error description (already localized) */
13296         const char *failing_url; /**< The URL that failed to load */
13297         Evas_Object *frame; /**< Frame object that produced the error */
13298      };
13299
13300    /**
13301     * The possibles types that the items in a menu can be
13302     */
13303    typedef enum _Elm_Web_Menu_Item_Type
13304      {
13305         ELM_WEB_MENU_SEPARATOR,
13306         ELM_WEB_MENU_GROUP,
13307         ELM_WEB_MENU_OPTION
13308      } Elm_Web_Menu_Item_Type;
13309
13310    /**
13311     * Structure describing the items in a menu
13312     */
13313    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13314    /**
13315     * Structure describing the items in a menu
13316     */
13317    struct _Elm_Web_Menu_Item
13318      {
13319         const char *text; /**< The text for the item */
13320         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13321      };
13322
13323    /**
13324     * Structure describing the menu of a popup
13325     *
13326     * This structure will be passed as the @c event_info for the "popup,create"
13327     * signal, which is emitted when a dropdown menu is opened. Users wanting
13328     * to handle these popups by themselves should listen to this signal and
13329     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13330     * property as @c EINA_FALSE means that the user will not handle the popup
13331     * and the default implementation will be used.
13332     *
13333     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13334     * will be emitted to notify the user that it can destroy any objects and
13335     * free all data related to it.
13336     *
13337     * @see elm_web_popup_selected_set()
13338     * @see elm_web_popup_destroy()
13339     */
13340    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13341    /**
13342     * Structure describing the menu of a popup
13343     *
13344     * This structure will be passed as the @c event_info for the "popup,create"
13345     * signal, which is emitted when a dropdown menu is opened. Users wanting
13346     * to handle these popups by themselves should listen to this signal and
13347     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13348     * property as @c EINA_FALSE means that the user will not handle the popup
13349     * and the default implementation will be used.
13350     *
13351     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13352     * will be emitted to notify the user that it can destroy any objects and
13353     * free all data related to it.
13354     *
13355     * @see elm_web_popup_selected_set()
13356     * @see elm_web_popup_destroy()
13357     */
13358    struct _Elm_Web_Menu
13359      {
13360         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13361         int x; /**< The X position of the popup, relative to the elm_web object */
13362         int y; /**< The Y position of the popup, relative to the elm_web object */
13363         int width; /**< Width of the popup menu */
13364         int height; /**< Height of the popup menu */
13365
13366         Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13367      };
13368
13369    typedef struct _Elm_Web_Download Elm_Web_Download;
13370    struct _Elm_Web_Download
13371      {
13372         const char *url;
13373      };
13374
13375    /**
13376     * Types of zoom available.
13377     */
13378    typedef enum _Elm_Web_Zoom_Mode
13379      {
13380         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13381         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13382         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13383         ELM_WEB_ZOOM_MODE_LAST
13384      } Elm_Web_Zoom_Mode;
13385    /**
13386     * Opaque handler containing the features (such as statusbar, menubar, etc)
13387     * that are to be set on a newly requested window.
13388     */
13389    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13390    /**
13391     * Callback type for the create_window hook.
13392     *
13393     * The function parameters are:
13394     * @li @p data User data pointer set when setting the hook function
13395     * @li @p obj The elm_web object requesting the new window
13396     * @li @p js Set to @c EINA_TRUE if the request was originated from
13397     * JavaScript. @c EINA_FALSE otherwise.
13398     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13399     * the features requested for the new window.
13400     *
13401     * The returned value of the function should be the @c elm_web widget where
13402     * the request will be loaded. That is, if a new window or tab is created,
13403     * the elm_web widget in it should be returned, and @b NOT the window
13404     * object.
13405     * Returning @c NULL should cancel the request.
13406     *
13407     * @see elm_web_window_create_hook_set()
13408     */
13409    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13410    /**
13411     * Callback type for the JS alert hook.
13412     *
13413     * The function parameters are:
13414     * @li @p data User data pointer set when setting the hook function
13415     * @li @p obj The elm_web object requesting the new window
13416     * @li @p message The message to show in the alert dialog
13417     *
13418     * The function should return the object representing the alert dialog.
13419     * Elm_Web will run a second main loop to handle the dialog and normal
13420     * flow of the application will be restored when the object is deleted, so
13421     * the user should handle the popup properly in order to delete the object
13422     * when the action is finished.
13423     * If the function returns @c NULL the popup will be ignored.
13424     *
13425     * @see elm_web_dialog_alert_hook_set()
13426     */
13427    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13428    /**
13429     * Callback type for the JS confirm hook.
13430     *
13431     * The function parameters are:
13432     * @li @p data User data pointer set when setting the hook function
13433     * @li @p obj The elm_web object requesting the new window
13434     * @li @p message The message to show in the confirm dialog
13435     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13436     * the user selected @c Ok, @c EINA_FALSE otherwise.
13437     *
13438     * The function should return the object representing the confirm dialog.
13439     * Elm_Web will run a second main loop to handle the dialog and normal
13440     * flow of the application will be restored when the object is deleted, so
13441     * the user should handle the popup properly in order to delete the object
13442     * when the action is finished.
13443     * If the function returns @c NULL the popup will be ignored.
13444     *
13445     * @see elm_web_dialog_confirm_hook_set()
13446     */
13447    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13448    /**
13449     * Callback type for the JS prompt hook.
13450     *
13451     * The function parameters are:
13452     * @li @p data User data pointer set when setting the hook function
13453     * @li @p obj The elm_web object requesting the new window
13454     * @li @p message The message to show in the prompt dialog
13455     * @li @p def_value The default value to present the user in the entry
13456     * @li @p value Pointer where to store the value given by the user. Must
13457     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13458     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13459     * the user selected @c Ok, @c EINA_FALSE otherwise.
13460     *
13461     * The function should return the object representing the prompt dialog.
13462     * Elm_Web will run a second main loop to handle the dialog and normal
13463     * flow of the application will be restored when the object is deleted, so
13464     * the user should handle the popup properly in order to delete the object
13465     * when the action is finished.
13466     * If the function returns @c NULL the popup will be ignored.
13467     *
13468     * @see elm_web_dialog_prompt_hook_set()
13469     */
13470    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13471    /**
13472     * Callback type for the JS file selector hook.
13473     *
13474     * The function parameters are:
13475     * @li @p data User data pointer set when setting the hook function
13476     * @li @p obj The elm_web object requesting the new window
13477     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13478     * @li @p accept_types Mime types accepted
13479     * @li @p selected Pointer where to store the list of malloc'ed strings
13480     * containing the path to each file selected. Must be @c NULL if the file
13481     * dialog is cancelled
13482     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13483     * the user selected @c Ok, @c EINA_FALSE otherwise.
13484     *
13485     * The function should return the object representing the file selector
13486     * dialog.
13487     * Elm_Web will run a second main loop to handle the dialog and normal
13488     * flow of the application will be restored when the object is deleted, so
13489     * the user should handle the popup properly in order to delete the object
13490     * when the action is finished.
13491     * If the function returns @c NULL the popup will be ignored.
13492     *
13493     * @see elm_web_dialog_file selector_hook_set()
13494     */
13495    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13496    /**
13497     * Callback type for the JS console message hook.
13498     *
13499     * When a console message is added from JavaScript, any set function to the
13500     * console message hook will be called for the user to handle. There is no
13501     * default implementation of this hook.
13502     *
13503     * The function parameters are:
13504     * @li @p data User data pointer set when setting the hook function
13505     * @li @p obj The elm_web object that originated the message
13506     * @li @p message The message sent
13507     * @li @p line_number The line number
13508     * @li @p source_id Source id
13509     *
13510     * @see elm_web_console_message_hook_set()
13511     */
13512    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13513    /**
13514     * Add a new web object to the parent.
13515     *
13516     * @param parent The parent object.
13517     * @return The new object or NULL if it cannot be created.
13518     *
13519     * @see elm_web_uri_set()
13520     * @see elm_web_webkit_view_get()
13521     */
13522    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13523
13524    /**
13525     * Get internal ewk_view object from web object.
13526     *
13527     * Elementary may not provide some low level features of EWebKit,
13528     * instead of cluttering the API with proxy methods we opted to
13529     * return the internal reference. Be careful using it as it may
13530     * interfere with elm_web behavior.
13531     *
13532     * @param obj The web object.
13533     * @return The internal ewk_view object or NULL if it does not
13534     *         exist. (Failure to create or Elementary compiled without
13535     *         ewebkit)
13536     *
13537     * @see elm_web_add()
13538     */
13539    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13540
13541    /**
13542     * Sets the function to call when a new window is requested
13543     *
13544     * This hook will be called when a request to create a new window is
13545     * issued from the web page loaded.
13546     * There is no default implementation for this feature, so leaving this
13547     * unset or passing @c NULL in @p func will prevent new windows from
13548     * opening.
13549     *
13550     * @param obj The web object where to set the hook function
13551     * @param func The hook function to be called when a window is requested
13552     * @param data User data
13553     */
13554    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13555    /**
13556     * Sets the function to call when an alert dialog
13557     *
13558     * This hook will be called when a JavaScript alert dialog is requested.
13559     * If no function is set or @c NULL is passed in @p func, the default
13560     * implementation will take place.
13561     *
13562     * @param obj The web object where to set the hook function
13563     * @param func The callback function to be used
13564     * @param data User data
13565     *
13566     * @see elm_web_inwin_mode_set()
13567     */
13568    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13569    /**
13570     * Sets the function to call when an confirm dialog
13571     *
13572     * This hook will be called when a JavaScript confirm dialog is requested.
13573     * If no function is set or @c NULL is passed in @p func, the default
13574     * implementation will take place.
13575     *
13576     * @param obj The web object where to set the hook function
13577     * @param func The callback function to be used
13578     * @param data User data
13579     *
13580     * @see elm_web_inwin_mode_set()
13581     */
13582    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13583    /**
13584     * Sets the function to call when an prompt dialog
13585     *
13586     * This hook will be called when a JavaScript prompt dialog is requested.
13587     * If no function is set or @c NULL is passed in @p func, the default
13588     * implementation will take place.
13589     *
13590     * @param obj The web object where to set the hook function
13591     * @param func The callback function to be used
13592     * @param data User data
13593     *
13594     * @see elm_web_inwin_mode_set()
13595     */
13596    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13597    /**
13598     * Sets the function to call when an file selector dialog
13599     *
13600     * This hook will be called when a JavaScript file selector dialog is
13601     * requested.
13602     * If no function is set or @c NULL is passed in @p func, the default
13603     * implementation will take place.
13604     *
13605     * @param obj The web object where to set the hook function
13606     * @param func The callback function to be used
13607     * @param data User data
13608     *
13609     * @see elm_web_inwin_mode_set()
13610     */
13611    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13612    /**
13613     * Sets the function to call when a console message is emitted from JS
13614     *
13615     * This hook will be called when a console message is emitted from
13616     * JavaScript. There is no default implementation for this feature.
13617     *
13618     * @param obj The web object where to set the hook function
13619     * @param func The callback function to be used
13620     * @param data User data
13621     */
13622    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13623    /**
13624     * Gets the status of the tab propagation
13625     *
13626     * @param obj The web object to query
13627     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13628     *
13629     * @see elm_web_tab_propagate_set()
13630     */
13631    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13632    /**
13633     * Sets whether to use tab propagation
13634     *
13635     * If tab propagation is enabled, whenever the user presses the Tab key,
13636     * Elementary will handle it and switch focus to the next widget.
13637     * The default value is disabled, where WebKit will handle the Tab key to
13638     * cycle focus though its internal objects, jumping to the next widget
13639     * only when that cycle ends.
13640     *
13641     * @param obj The web object
13642     * @param propagate Whether to propagate Tab keys to Elementary or not
13643     */
13644    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13645    /**
13646     * Sets the URI for the web object
13647     *
13648     * It must be a full URI, with resource included, in the form
13649     * http://www.enlightenment.org or file:///tmp/something.html
13650     *
13651     * @param obj The web object
13652     * @param uri The URI to set
13653     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13654     */
13655    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13656    /**
13657     * Gets the current URI for the object
13658     *
13659     * The returned string must not be freed and is guaranteed to be
13660     * stringshared.
13661     *
13662     * @param obj The web object
13663     * @return A stringshared internal string with the current URI, or NULL on
13664     * failure
13665     */
13666    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13667    /**
13668     * Gets the current title
13669     *
13670     * The returned string must not be freed and is guaranteed to be
13671     * stringshared.
13672     *
13673     * @param obj The web object
13674     * @return A stringshared internal string with the current title, or NULL on
13675     * failure
13676     */
13677    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13678    /**
13679     * Sets the background color to be used by the web object
13680     *
13681     * This is the color that will be used by default when the loaded page
13682     * does not set it's own. Color values are pre-multiplied.
13683     *
13684     * @param obj The web object
13685     * @param r Red component
13686     * @param g Green component
13687     * @param b Blue component
13688     * @param a Alpha component
13689     */
13690    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13691    /**
13692     * Gets the background color to be used by the web object
13693     *
13694     * This is the color that will be used by default when the loaded page
13695     * does not set it's own. Color values are pre-multiplied.
13696     *
13697     * @param obj The web object
13698     * @param r Red component
13699     * @param g Green component
13700     * @param b Blue component
13701     * @param a Alpha component
13702     */
13703    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13704    /**
13705     * Gets a copy of the currently selected text
13706     *
13707     * The string returned must be freed by the user when it's done with it.
13708     *
13709     * @param obj The web object
13710     * @return A newly allocated string, or NULL if nothing is selected or an
13711     * error occurred
13712     */
13713    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13714    /**
13715     * Tells the web object which index in the currently open popup was selected
13716     *
13717     * When the user handles the popup creation from the "popup,created" signal,
13718     * it needs to tell the web object which item was selected by calling this
13719     * function with the index corresponding to the item.
13720     *
13721     * @param obj The web object
13722     * @param index The index selected
13723     *
13724     * @see elm_web_popup_destroy()
13725     */
13726    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13727    /**
13728     * Dismisses an open dropdown popup
13729     *
13730     * When the popup from a dropdown widget is to be dismissed, either after
13731     * selecting an option or to cancel it, this function must be called, which
13732     * will later emit an "popup,willdelete" signal to notify the user that
13733     * any memory and objects related to this popup can be freed.
13734     *
13735     * @param obj The web object
13736     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13737     * if there was no menu to destroy
13738     */
13739    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13740    /**
13741     * Searches the given string in a document.
13742     *
13743     * @param obj The web object where to search the text
13744     * @param string String to search
13745     * @param case_sensitive If search should be case sensitive or not
13746     * @param forward If search is from cursor and on or backwards
13747     * @param wrap If search should wrap at the end
13748     *
13749     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13750     * or failure
13751     */
13752    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13753    /**
13754     * Marks matches of the given string in a document.
13755     *
13756     * @param obj The web object where to search text
13757     * @param string String to match
13758     * @param case_sensitive If match should be case sensitive or not
13759     * @param highlight If matches should be highlighted
13760     * @param limit Maximum amount of matches, or zero to unlimited
13761     *
13762     * @return number of matched @a string
13763     */
13764    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13765    /**
13766     * Clears all marked matches in the document
13767     *
13768     * @param obj The web object
13769     *
13770     * @return EINA_TRUE on success, EINA_FALSE otherwise
13771     */
13772    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13773    /**
13774     * Sets whether to highlight the matched marks
13775     *
13776     * If enabled, marks set with elm_web_text_matches_mark() will be
13777     * highlighted.
13778     *
13779     * @param obj The web object
13780     * @param highlight Whether to highlight the marks or not
13781     *
13782     * @return EINA_TRUE on success, EINA_FALSE otherwise
13783     */
13784    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13785    /**
13786     * Gets whether highlighting marks is enabled
13787     *
13788     * @param The web object
13789     *
13790     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13791     * otherwise
13792     */
13793    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13794    /**
13795     * Gets the overall loading progress of the page
13796     *
13797     * Returns the estimated loading progress of the page, with a value between
13798     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13799     * included in the page.
13800     *
13801     * @param The web object
13802     *
13803     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13804     * failure
13805     */
13806    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13807    /**
13808     * Stops loading the current page
13809     *
13810     * Cancels the loading of the current page in the web object. This will
13811     * cause a "load,error" signal to be emitted, with the is_cancellation
13812     * flag set to EINA_TRUE.
13813     *
13814     * @param obj The web object
13815     *
13816     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13817     */
13818    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13819    /**
13820     * Requests a reload of the current document in the object
13821     *
13822     * @param obj The web object
13823     *
13824     * @return EINA_TRUE on success, EINA_FALSE otherwise
13825     */
13826    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13827    /**
13828     * Requests a reload of the current document, avoiding any existing caches
13829     *
13830     * @param obj The web object
13831     *
13832     * @return EINA_TRUE on success, EINA_FALSE otherwise
13833     */
13834    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13835    /**
13836     * Goes back one step in the browsing history
13837     *
13838     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13839     *
13840     * @param obj The web object
13841     *
13842     * @return EINA_TRUE on success, EINA_FALSE otherwise
13843     *
13844     * @see elm_web_history_enable_set()
13845     * @see elm_web_back_possible()
13846     * @see elm_web_forward()
13847     * @see elm_web_navigate()
13848     */
13849    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13850    /**
13851     * Goes forward one step in the browsing history
13852     *
13853     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13854     *
13855     * @param obj The web object
13856     *
13857     * @return EINA_TRUE on success, EINA_FALSE otherwise
13858     *
13859     * @see elm_web_history_enable_set()
13860     * @see elm_web_forward_possible()
13861     * @see elm_web_back()
13862     * @see elm_web_navigate()
13863     */
13864    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13865    /**
13866     * Jumps the given number of steps in the browsing history
13867     *
13868     * The @p steps value can be a negative integer to back in history, or a
13869     * positive to move forward.
13870     *
13871     * @param obj The web object
13872     * @param steps The number of steps to jump
13873     *
13874     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13875     * history exists to jump the given number of steps
13876     *
13877     * @see elm_web_history_enable_set()
13878     * @see elm_web_navigate_possible()
13879     * @see elm_web_back()
13880     * @see elm_web_forward()
13881     */
13882    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13883    /**
13884     * Queries whether it's possible to go back in history
13885     *
13886     * @param obj The web object
13887     *
13888     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13889     * otherwise
13890     */
13891    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13892    /**
13893     * Queries whether it's possible to go forward in history
13894     *
13895     * @param obj The web object
13896     *
13897     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13898     * otherwise
13899     */
13900    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13901    /**
13902     * Queries whether it's possible to jump the given number of steps
13903     *
13904     * The @p steps value can be a negative integer to back in history, or a
13905     * positive to move forward.
13906     *
13907     * @param obj The web object
13908     * @param steps The number of steps to check for
13909     *
13910     * @return EINA_TRUE if enough history exists to perform the given jump,
13911     * EINA_FALSE otherwise
13912     */
13913    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13914    /**
13915     * Gets whether browsing history is enabled for the given object
13916     *
13917     * @param obj The web object
13918     *
13919     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13920     */
13921    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13922    /**
13923     * Enables or disables the browsing history
13924     *
13925     * @param obj The web object
13926     * @param enable Whether to enable or disable the browsing history
13927     */
13928    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13929    /**
13930     * Sets the zoom level of the web object
13931     *
13932     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13933     * values meaning zoom in and lower meaning zoom out. This function will
13934     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13935     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13936     *
13937     * @param obj The web object
13938     * @param zoom The zoom level to set
13939     */
13940    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13941    /**
13942     * Gets the current zoom level set on the web object
13943     *
13944     * Note that this is the zoom level set on the web object and not that
13945     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13946     * the two zoom levels should match, but for the other two modes the
13947     * Webkit zoom is calculated internally to match the chosen mode without
13948     * changing the zoom level set for the web object.
13949     *
13950     * @param obj The web object
13951     *
13952     * @return The zoom level set on the object
13953     */
13954    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13955    /**
13956     * Sets the zoom mode to use
13957     *
13958     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13959     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13960     *
13961     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13962     * with the elm_web_zoom_set() function.
13963     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13964     * make sure the entirety of the web object's contents are shown.
13965     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13966     * fit the contents in the web object's size, without leaving any space
13967     * unused.
13968     *
13969     * @param obj The web object
13970     * @param mode The mode to set
13971     */
13972    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13973    /**
13974     * Gets the currently set zoom mode
13975     *
13976     * @param obj The web object
13977     *
13978     * @return The current zoom mode set for the object, or
13979     * ::ELM_WEB_ZOOM_MODE_LAST on error
13980     */
13981    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13982    /**
13983     * Shows the given region in the web object
13984     *
13985     * @param obj The web object
13986     * @param x The x coordinate of the region to show
13987     * @param y The y coordinate of the region to show
13988     * @param w The width of the region to show
13989     * @param h The height of the region to show
13990     */
13991    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13992    /**
13993     * Brings in the region to the visible area
13994     *
13995     * Like elm_web_region_show(), but it animates the scrolling of the object
13996     * to show the area
13997     *
13998     * @param obj The web object
13999     * @param x The x coordinate of the region to show
14000     * @param y The y coordinate of the region to show
14001     * @param w The width of the region to show
14002     * @param h The height of the region to show
14003     */
14004    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14005    /**
14006     * Sets the default dialogs to use an Inwin instead of a normal window
14007     *
14008     * If set, then the default implementation for the JavaScript dialogs and
14009     * file selector will be opened in an Inwin. Otherwise they will use a
14010     * normal separated window.
14011     *
14012     * @param obj The web object
14013     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14014     */
14015    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14016    /**
14017     * Gets whether Inwin mode is set for the current object
14018     *
14019     * @param obj The web object
14020     *
14021     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14022     */
14023    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14024
14025    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14026    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14027    EAPI void                         elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
14028    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14029
14030    /**
14031     * @}
14032     */
14033
14034    /**
14035     * @defgroup Hoversel Hoversel
14036     *
14037     * @image html img/widget/hoversel/preview-00.png
14038     * @image latex img/widget/hoversel/preview-00.eps
14039     *
14040     * A hoversel is a button that pops up a list of items (automatically
14041     * choosing the direction to display) that have a label and, optionally, an
14042     * icon to select from. It is a convenience widget to avoid the need to do
14043     * all the piecing together yourself. It is intended for a small number of
14044     * items in the hoversel menu (no more than 8), though is capable of many
14045     * more.
14046     *
14047     * Signals that you can add callbacks for are:
14048     * "clicked" - the user clicked the hoversel button and popped up the sel
14049     * "selected" - an item in the hoversel list is selected. event_info is the item
14050     * "dismissed" - the hover is dismissed
14051     *
14052     * See @ref tutorial_hoversel for an example.
14053     * @{
14054     */
14055    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14056    /**
14057     * @brief Add a new Hoversel object
14058     *
14059     * @param parent The parent object
14060     * @return The new object or NULL if it cannot be created
14061     */
14062    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14063    /**
14064     * @brief This sets the hoversel to expand horizontally.
14065     *
14066     * @param obj The hoversel object
14067     * @param horizontal If true, the hover will expand horizontally to the
14068     * right.
14069     *
14070     * @note The initial button will display horizontally regardless of this
14071     * setting.
14072     */
14073    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14074    /**
14075     * @brief This returns whether the hoversel is set to expand horizontally.
14076     *
14077     * @param obj The hoversel object
14078     * @return If true, the hover will expand horizontally to the right.
14079     *
14080     * @see elm_hoversel_horizontal_set()
14081     */
14082    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14083    /**
14084     * @brief Set the Hover parent
14085     *
14086     * @param obj The hoversel object
14087     * @param parent The parent to use
14088     *
14089     * Sets the hover parent object, the area that will be darkened when the
14090     * hoversel is clicked. Should probably be the window that the hoversel is
14091     * in. See @ref Hover objects for more information.
14092     */
14093    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14094    /**
14095     * @brief Get the Hover parent
14096     *
14097     * @param obj The hoversel object
14098     * @return The used parent
14099     *
14100     * Gets the hover parent object.
14101     *
14102     * @see elm_hoversel_hover_parent_set()
14103     */
14104    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14105    /**
14106     * @brief Set the hoversel button label
14107     *
14108     * @param obj The hoversel object
14109     * @param label The label text.
14110     *
14111     * This sets the label of the button that is always visible (before it is
14112     * clicked and expanded).
14113     *
14114     * @deprecated elm_object_text_set()
14115     */
14116    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14117    /**
14118     * @brief Get the hoversel button label
14119     *
14120     * @param obj The hoversel object
14121     * @return The label text.
14122     *
14123     * @deprecated elm_object_text_get()
14124     */
14125    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14126    /**
14127     * @brief Set the icon of the hoversel button
14128     *
14129     * @param obj The hoversel object
14130     * @param icon The icon object
14131     *
14132     * Sets the icon of the button that is always visible (before it is clicked
14133     * and expanded).  Once the icon object is set, a previously set one will be
14134     * deleted, if you want to keep that old content object, use the
14135     * elm_hoversel_icon_unset() function.
14136     *
14137     * @see elm_object_content_set() for the button widget
14138     */
14139    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14140    /**
14141     * @brief Get the icon of the hoversel button
14142     *
14143     * @param obj The hoversel object
14144     * @return The icon object
14145     *
14146     * Get the icon of the button that is always visible (before it is clicked
14147     * and expanded). Also see elm_object_content_get() for the button widget.
14148     *
14149     * @see elm_hoversel_icon_set()
14150     */
14151    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14152    /**
14153     * @brief Get and unparent the icon of the hoversel button
14154     *
14155     * @param obj The hoversel object
14156     * @return The icon object that was being used
14157     *
14158     * Unparent and return the icon of the button that is always visible
14159     * (before it is clicked and expanded).
14160     *
14161     * @see elm_hoversel_icon_set()
14162     * @see elm_object_content_unset() for the button widget
14163     */
14164    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14165    /**
14166     * @brief This triggers the hoversel popup from code, the same as if the user
14167     * had clicked the button.
14168     *
14169     * @param obj The hoversel object
14170     */
14171    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14172    /**
14173     * @brief This dismisses the hoversel popup as if the user had clicked
14174     * outside the hover.
14175     *
14176     * @param obj The hoversel object
14177     */
14178    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14179    /**
14180     * @brief Returns whether the hoversel is expanded.
14181     *
14182     * @param obj The hoversel object
14183     * @return  This will return EINA_TRUE if the hoversel is expanded or
14184     * EINA_FALSE if it is not expanded.
14185     */
14186    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14187    /**
14188     * @brief This will remove all the children items from the hoversel.
14189     *
14190     * @param obj The hoversel object
14191     *
14192     * @warning Should @b not be called while the hoversel is active; use
14193     * elm_hoversel_expanded_get() to check first.
14194     *
14195     * @see elm_hoversel_item_del_cb_set()
14196     * @see elm_hoversel_item_del()
14197     */
14198    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14199    /**
14200     * @brief Get the list of items within the given hoversel.
14201     *
14202     * @param obj The hoversel object
14203     * @return Returns a list of Elm_Hoversel_Item*
14204     *
14205     * @see elm_hoversel_item_add()
14206     */
14207    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14208    /**
14209     * @brief Add an item to the hoversel button
14210     *
14211     * @param obj The hoversel object
14212     * @param label The text label to use for the item (NULL if not desired)
14213     * @param icon_file An image file path on disk to use for the icon or standard
14214     * icon name (NULL if not desired)
14215     * @param icon_type The icon type if relevant
14216     * @param func Convenience function to call when this item is selected
14217     * @param data Data to pass to item-related functions
14218     * @return A handle to the item added.
14219     *
14220     * This adds an item to the hoversel to show when it is clicked. Note: if you
14221     * need to use an icon from an edje file then use
14222     * elm_hoversel_item_icon_set() right after the this function, and set
14223     * icon_file to NULL here.
14224     *
14225     * For more information on what @p icon_file and @p icon_type are see the
14226     * @ref Icon "icon documentation".
14227     */
14228    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);
14229    /**
14230     * @brief Delete an item from the hoversel
14231     *
14232     * @param item The item to delete
14233     *
14234     * This deletes the item from the hoversel (should not be called while the
14235     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14236     *
14237     * @see elm_hoversel_item_add()
14238     * @see elm_hoversel_item_del_cb_set()
14239     */
14240    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14241    /**
14242     * @brief Set the function to be called when an item from the hoversel is
14243     * freed.
14244     *
14245     * @param item The item to set the callback on
14246     * @param func The function called
14247     *
14248     * That function will receive these parameters:
14249     * @li void *item_data
14250     * @li Evas_Object *the_item_object
14251     * @li Elm_Hoversel_Item *the_object_struct
14252     *
14253     * @see elm_hoversel_item_add()
14254     */
14255    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14256    /**
14257     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14258     * that will be passed to associated function callbacks.
14259     *
14260     * @param item The item to get the data from
14261     * @return The data pointer set with elm_hoversel_item_add()
14262     *
14263     * @see elm_hoversel_item_add()
14264     */
14265    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14266    /**
14267     * @brief This returns the label text of the given hoversel item.
14268     *
14269     * @param item The item to get the label
14270     * @return The label text of the hoversel item
14271     *
14272     * @see elm_hoversel_item_add()
14273     */
14274    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14275    /**
14276     * @brief This sets the icon for the given hoversel item.
14277     *
14278     * @param item The item to set the icon
14279     * @param icon_file An image file path on disk to use for the icon or standard
14280     * icon name
14281     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14282     * to NULL if the icon is not an edje file
14283     * @param icon_type The icon type
14284     *
14285     * The icon can be loaded from the standard set, from an image file, or from
14286     * an edje file.
14287     *
14288     * @see elm_hoversel_item_add()
14289     */
14290    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);
14291    /**
14292     * @brief Get the icon object of the hoversel item
14293     *
14294     * @param item The item to get the icon from
14295     * @param icon_file The image file path on disk used for the icon or standard
14296     * icon name
14297     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14298     * if the icon is not an edje file
14299     * @param icon_type The icon type
14300     *
14301     * @see elm_hoversel_item_icon_set()
14302     * @see elm_hoversel_item_add()
14303     */
14304    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);
14305    /**
14306     * @}
14307     */
14308
14309    /**
14310     * @defgroup Toolbar Toolbar
14311     * @ingroup Elementary
14312     *
14313     * @image html img/widget/toolbar/preview-00.png
14314     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14315     *
14316     * @image html img/toolbar.png
14317     * @image latex img/toolbar.eps width=\textwidth
14318     *
14319     * A toolbar is a widget that displays a list of items inside
14320     * a box. It can be scrollable, show a menu with items that don't fit
14321     * to toolbar size or even crop them.
14322     *
14323     * Only one item can be selected at a time.
14324     *
14325     * Items can have multiple states, or show menus when selected by the user.
14326     *
14327     * Smart callbacks one can listen to:
14328     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14329     * - "language,changed" - when the program language changes
14330     *
14331     * Available styles for it:
14332     * - @c "default"
14333     * - @c "transparent" - no background or shadow, just show the content
14334     *
14335     * List of examples:
14336     * @li @ref toolbar_example_01
14337     * @li @ref toolbar_example_02
14338     * @li @ref toolbar_example_03
14339     */
14340
14341    /**
14342     * @addtogroup Toolbar
14343     * @{
14344     */
14345
14346    /**
14347     * @enum _Elm_Toolbar_Shrink_Mode
14348     * @typedef Elm_Toolbar_Shrink_Mode
14349     *
14350     * Set toolbar's items display behavior, it can be scrollabel,
14351     * show a menu with exceeding items, or simply hide them.
14352     *
14353     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14354     * from elm config.
14355     *
14356     * Values <b> don't </b> work as bitmask, only one can be choosen.
14357     *
14358     * @see elm_toolbar_mode_shrink_set()
14359     * @see elm_toolbar_mode_shrink_get()
14360     *
14361     * @ingroup Toolbar
14362     */
14363    typedef enum _Elm_Toolbar_Shrink_Mode
14364      {
14365         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14366         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14367         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14368         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14369         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14370      } Elm_Toolbar_Shrink_Mode;
14371
14372    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
14373
14374    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
14375
14376    /**
14377     * Add a new toolbar widget to the given parent Elementary
14378     * (container) object.
14379     *
14380     * @param parent The parent object.
14381     * @return a new toolbar widget handle or @c NULL, on errors.
14382     *
14383     * This function inserts a new toolbar widget on the canvas.
14384     *
14385     * @ingroup Toolbar
14386     */
14387    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14388
14389    /**
14390     * Set the icon size, in pixels, to be used by toolbar items.
14391     *
14392     * @param obj The toolbar object
14393     * @param icon_size The icon size in pixels
14394     *
14395     * @note Default value is @c 32. It reads value from elm config.
14396     *
14397     * @see elm_toolbar_icon_size_get()
14398     *
14399     * @ingroup Toolbar
14400     */
14401    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14402
14403    /**
14404     * Get the icon size, in pixels, to be used by toolbar items.
14405     *
14406     * @param obj The toolbar object.
14407     * @return The icon size in pixels.
14408     *
14409     * @see elm_toolbar_icon_size_set() for details.
14410     *
14411     * @ingroup Toolbar
14412     */
14413    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14414
14415    /**
14416     * Sets icon lookup order, for toolbar items' icons.
14417     *
14418     * @param obj The toolbar object.
14419     * @param order The icon lookup order.
14420     *
14421     * Icons added before calling this function will not be affected.
14422     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14423     *
14424     * @see elm_toolbar_icon_order_lookup_get()
14425     *
14426     * @ingroup Toolbar
14427     */
14428    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14429
14430    /**
14431     * Gets the icon lookup order.
14432     *
14433     * @param obj The toolbar object.
14434     * @return The icon lookup order.
14435     *
14436     * @see elm_toolbar_icon_order_lookup_set() for details.
14437     *
14438     * @ingroup Toolbar
14439     */
14440    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14441
14442    /**
14443     * Set whether the toolbar should always have an item selected.
14444     *
14445     * @param obj The toolbar object.
14446     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14447     * disable it.
14448     *
14449     * This will cause the toolbar to always have an item selected, and clicking
14450     * the selected item will not cause a selected event to be emitted. Enabling this mode
14451     * will immediately select the first toolbar item.
14452     *
14453     * Always-selected is disabled by default.
14454     *
14455     * @see elm_toolbar_always_select_mode_get().
14456     *
14457     * @ingroup Toolbar
14458     */
14459    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14460
14461    /**
14462     * Get whether the toolbar should always have an item selected.
14463     *
14464     * @param obj The toolbar object.
14465     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14466     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14467     *
14468     * @see elm_toolbar_always_select_mode_set() for details.
14469     *
14470     * @ingroup Toolbar
14471     */
14472    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14473
14474    /**
14475     * Set whether the toolbar items' should be selected by the user or not.
14476     *
14477     * @param obj The toolbar object.
14478     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14479     * enable it.
14480     *
14481     * This will turn off the ability to select items entirely and they will
14482     * neither appear selected nor emit selected signals. The clicked
14483     * callback function will still be called.
14484     *
14485     * Selection is enabled by default.
14486     *
14487     * @see elm_toolbar_no_select_mode_get().
14488     *
14489     * @ingroup Toolbar
14490     */
14491    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14492
14493    /**
14494     * Set whether the toolbar items' should be selected by the user or not.
14495     *
14496     * @param obj The toolbar object.
14497     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14498     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14499     *
14500     * @see elm_toolbar_no_select_mode_set() for details.
14501     *
14502     * @ingroup Toolbar
14503     */
14504    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14505
14506    /**
14507     * Append item to the toolbar.
14508     *
14509     * @param obj The toolbar object.
14510     * @param icon A string with icon name or the absolute path of an image file.
14511     * @param label The label of the item.
14512     * @param func The function to call when the item is clicked.
14513     * @param data The data to associate with the item for related callbacks.
14514     * @return The created item or @c NULL upon failure.
14515     *
14516     * A new item will be created and appended to the toolbar, i.e., will
14517     * be set as @b last item.
14518     *
14519     * Items created with this method can be deleted with
14520     * elm_toolbar_item_del().
14521     *
14522     * Associated @p data can be properly freed when item is deleted if a
14523     * callback function is set with elm_toolbar_item_del_cb_set().
14524     *
14525     * If a function is passed as argument, it will be called everytime this item
14526     * is selected, i.e., the user clicks over an unselected item.
14527     * If such function isn't needed, just passing
14528     * @c NULL as @p func is enough. The same should be done for @p data.
14529     *
14530     * Toolbar will load icon image from fdo or current theme.
14531     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14532     * If an absolute path is provided it will load it direct from a file.
14533     *
14534     * @see elm_toolbar_item_icon_set()
14535     * @see elm_toolbar_item_del()
14536     * @see elm_toolbar_item_del_cb_set()
14537     *
14538     * @ingroup Toolbar
14539     */
14540    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);
14541
14542    /**
14543     * Prepend item to the toolbar.
14544     *
14545     * @param obj The toolbar object.
14546     * @param icon A string with icon name or the absolute path of an image file.
14547     * @param label The label of the item.
14548     * @param func The function to call when the item is clicked.
14549     * @param data The data to associate with the item for related callbacks.
14550     * @return The created item or @c NULL upon failure.
14551     *
14552     * A new item will be created and prepended to the toolbar, i.e., will
14553     * be set as @b first item.
14554     *
14555     * Items created with this method can be deleted with
14556     * elm_toolbar_item_del().
14557     *
14558     * Associated @p data can be properly freed when item is deleted if a
14559     * callback function is set with elm_toolbar_item_del_cb_set().
14560     *
14561     * If a function is passed as argument, it will be called everytime this item
14562     * is selected, i.e., the user clicks over an unselected item.
14563     * If such function isn't needed, just passing
14564     * @c NULL as @p func is enough. The same should be done for @p data.
14565     *
14566     * Toolbar will load icon image from fdo or current theme.
14567     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14568     * If an absolute path is provided it will load it direct from a file.
14569     *
14570     * @see elm_toolbar_item_icon_set()
14571     * @see elm_toolbar_item_del()
14572     * @see elm_toolbar_item_del_cb_set()
14573     *
14574     * @ingroup Toolbar
14575     */
14576    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);
14577
14578    /**
14579     * Insert a new item into the toolbar object before item @p before.
14580     *
14581     * @param obj The toolbar object.
14582     * @param before The toolbar item to insert before.
14583     * @param icon A string with icon name or the absolute path of an image file.
14584     * @param label The label of the item.
14585     * @param func The function to call when the item is clicked.
14586     * @param data The data to associate with the item for related callbacks.
14587     * @return The created item or @c NULL upon failure.
14588     *
14589     * A new item will be created and added to the toolbar. Its position in
14590     * this toolbar will be just before item @p before.
14591     *
14592     * Items created with this method can be deleted with
14593     * elm_toolbar_item_del().
14594     *
14595     * Associated @p data can be properly freed when item is deleted if a
14596     * callback function is set with elm_toolbar_item_del_cb_set().
14597     *
14598     * If a function is passed as argument, it will be called everytime this item
14599     * is selected, i.e., the user clicks over an unselected item.
14600     * If such function isn't needed, just passing
14601     * @c NULL as @p func is enough. The same should be done for @p data.
14602     *
14603     * Toolbar will load icon image from fdo or current theme.
14604     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14605     * If an absolute path is provided it will load it direct from a file.
14606     *
14607     * @see elm_toolbar_item_icon_set()
14608     * @see elm_toolbar_item_del()
14609     * @see elm_toolbar_item_del_cb_set()
14610     *
14611     * @ingroup Toolbar
14612     */
14613    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);
14614
14615    /**
14616     * Insert a new item into the toolbar object after item @p after.
14617     *
14618     * @param obj The toolbar object.
14619     * @param after The toolbar item to insert after.
14620     * @param icon A string with icon name or the absolute path of an image file.
14621     * @param label The label of the item.
14622     * @param func The function to call when the item is clicked.
14623     * @param data The data to associate with the item for related callbacks.
14624     * @return The created item or @c NULL upon failure.
14625     *
14626     * A new item will be created and added to the toolbar. Its position in
14627     * this toolbar will be just after item @p after.
14628     *
14629     * Items created with this method can be deleted with
14630     * elm_toolbar_item_del().
14631     *
14632     * Associated @p data can be properly freed when item is deleted if a
14633     * callback function is set with elm_toolbar_item_del_cb_set().
14634     *
14635     * If a function is passed as argument, it will be called everytime this item
14636     * is selected, i.e., the user clicks over an unselected item.
14637     * If such function isn't needed, just passing
14638     * @c NULL as @p func is enough. The same should be done for @p data.
14639     *
14640     * Toolbar will load icon image from fdo or current theme.
14641     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14642     * If an absolute path is provided it will load it direct from a file.
14643     *
14644     * @see elm_toolbar_item_icon_set()
14645     * @see elm_toolbar_item_del()
14646     * @see elm_toolbar_item_del_cb_set()
14647     *
14648     * @ingroup Toolbar
14649     */
14650    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);
14651
14652    /**
14653     * Get the first item in the given toolbar widget's list of
14654     * items.
14655     *
14656     * @param obj The toolbar object
14657     * @return The first item or @c NULL, if it has no items (and on
14658     * errors)
14659     *
14660     * @see elm_toolbar_item_append()
14661     * @see elm_toolbar_last_item_get()
14662     *
14663     * @ingroup Toolbar
14664     */
14665    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14666
14667    /**
14668     * Get the last item in the given toolbar widget's list of
14669     * items.
14670     *
14671     * @param obj The toolbar object
14672     * @return The last item or @c NULL, if it has no items (and on
14673     * errors)
14674     *
14675     * @see elm_toolbar_item_prepend()
14676     * @see elm_toolbar_first_item_get()
14677     *
14678     * @ingroup Toolbar
14679     */
14680    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14681
14682    /**
14683     * Get the item after @p item in toolbar.
14684     *
14685     * @param item The toolbar item.
14686     * @return The item after @p item, or @c NULL if none or on failure.
14687     *
14688     * @note If it is the last item, @c NULL will be returned.
14689     *
14690     * @see elm_toolbar_item_append()
14691     *
14692     * @ingroup Toolbar
14693     */
14694    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14695
14696    /**
14697     * Get the item before @p item in toolbar.
14698     *
14699     * @param item The toolbar item.
14700     * @return The item before @p item, or @c NULL if none or on failure.
14701     *
14702     * @note If it is the first item, @c NULL will be returned.
14703     *
14704     * @see elm_toolbar_item_prepend()
14705     *
14706     * @ingroup Toolbar
14707     */
14708    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14709
14710    /**
14711     * Get the toolbar object from an item.
14712     *
14713     * @param item The item.
14714     * @return The toolbar object.
14715     *
14716     * This returns the toolbar object itself that an item belongs to.
14717     *
14718     * @ingroup Toolbar
14719     */
14720    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14721
14722    /**
14723     * Set the priority of a toolbar item.
14724     *
14725     * @param item The toolbar item.
14726     * @param priority The item priority. The default is zero.
14727     *
14728     * This is used only when the toolbar shrink mode is set to
14729     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14730     * When space is less than required, items with low priority
14731     * will be removed from the toolbar and added to a dynamically-created menu,
14732     * while items with higher priority will remain on the toolbar,
14733     * with the same order they were added.
14734     *
14735     * @see elm_toolbar_item_priority_get()
14736     *
14737     * @ingroup Toolbar
14738     */
14739    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14740
14741    /**
14742     * Get the priority of a toolbar item.
14743     *
14744     * @param item The toolbar item.
14745     * @return The @p item priority, or @c 0 on failure.
14746     *
14747     * @see elm_toolbar_item_priority_set() for details.
14748     *
14749     * @ingroup Toolbar
14750     */
14751    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14752
14753    /**
14754     * Get the label of item.
14755     *
14756     * @param item The item of toolbar.
14757     * @return The label of item.
14758     *
14759     * The return value is a pointer to the label associated to @p item when
14760     * it was created, with function elm_toolbar_item_append() or similar,
14761     * or later,
14762     * with function elm_toolbar_item_label_set. If no label
14763     * was passed as argument, it will return @c NULL.
14764     *
14765     * @see elm_toolbar_item_label_set() for more details.
14766     * @see elm_toolbar_item_append()
14767     *
14768     * @ingroup Toolbar
14769     */
14770    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14771
14772    /**
14773     * Set the label of item.
14774     *
14775     * @param item The item of toolbar.
14776     * @param text The label of item.
14777     *
14778     * The label to be displayed by the item.
14779     * Label will be placed at icons bottom (if set).
14780     *
14781     * If a label was passed as argument on item creation, with function
14782     * elm_toolbar_item_append() or similar, it will be already
14783     * displayed by the item.
14784     *
14785     * @see elm_toolbar_item_label_get()
14786     * @see elm_toolbar_item_append()
14787     *
14788     * @ingroup Toolbar
14789     */
14790    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14791
14792    /**
14793     * Return the data associated with a given toolbar widget item.
14794     *
14795     * @param item The toolbar widget item handle.
14796     * @return The data associated with @p item.
14797     *
14798     * @see elm_toolbar_item_data_set()
14799     *
14800     * @ingroup Toolbar
14801     */
14802    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14803
14804    /**
14805     * Set the data associated with a given toolbar widget item.
14806     *
14807     * @param item The toolbar widget item handle.
14808     * @param data The new data pointer to set to @p item.
14809     *
14810     * This sets new item data on @p item.
14811     *
14812     * @warning The old data pointer won't be touched by this function, so
14813     * the user had better to free that old data himself/herself.
14814     *
14815     * @ingroup Toolbar
14816     */
14817    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14818
14819    /**
14820     * Returns a pointer to a toolbar item by its label.
14821     *
14822     * @param obj The toolbar object.
14823     * @param label The label of the item to find.
14824     *
14825     * @return The pointer to the toolbar item matching @p label or @c NULL
14826     * on failure.
14827     *
14828     * @ingroup Toolbar
14829     */
14830    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14831
14832    /*
14833     * Get whether the @p item is selected or not.
14834     *
14835     * @param item The toolbar item.
14836     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14837     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14838     *
14839     * @see elm_toolbar_selected_item_set() for details.
14840     * @see elm_toolbar_item_selected_get()
14841     *
14842     * @ingroup Toolbar
14843     */
14844    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14845
14846    /**
14847     * Set the selected state of an item.
14848     *
14849     * @param item The toolbar item
14850     * @param selected The selected state
14851     *
14852     * This sets the selected state of the given item @p it.
14853     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14854     *
14855     * If a new item is selected the previosly selected will be unselected.
14856     * Previoulsy selected item can be get with function
14857     * elm_toolbar_selected_item_get().
14858     *
14859     * Selected items will be highlighted.
14860     *
14861     * @see elm_toolbar_item_selected_get()
14862     * @see elm_toolbar_selected_item_get()
14863     *
14864     * @ingroup Toolbar
14865     */
14866    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14867
14868    /**
14869     * Get the selected item.
14870     *
14871     * @param obj The toolbar object.
14872     * @return The selected toolbar item.
14873     *
14874     * The selected item can be unselected with function
14875     * elm_toolbar_item_selected_set().
14876     *
14877     * The selected item always will be highlighted on toolbar.
14878     *
14879     * @see elm_toolbar_selected_items_get()
14880     *
14881     * @ingroup Toolbar
14882     */
14883    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14884
14885    /**
14886     * Set the icon associated with @p item.
14887     *
14888     * @param obj The parent of this item.
14889     * @param item The toolbar item.
14890     * @param icon A string with icon name or the absolute path of an image file.
14891     *
14892     * Toolbar will load icon image from fdo or current theme.
14893     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14894     * If an absolute path is provided it will load it direct from a file.
14895     *
14896     * @see elm_toolbar_icon_order_lookup_set()
14897     * @see elm_toolbar_icon_order_lookup_get()
14898     *
14899     * @ingroup Toolbar
14900     */
14901    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14902
14903    /**
14904     * Get the string used to set the icon of @p item.
14905     *
14906     * @param item The toolbar item.
14907     * @return The string associated with the icon object.
14908     *
14909     * @see elm_toolbar_item_icon_set() for details.
14910     *
14911     * @ingroup Toolbar
14912     */
14913    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14914
14915    /**
14916     * Get the object of @p item.
14917     *
14918     * @param item The toolbar item.
14919     * @return The object
14920     *
14921     * @ingroup Toolbar
14922     */
14923    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14924
14925    /**
14926     * Get the icon object of @p item.
14927     *
14928     * @param item The toolbar item.
14929     * @return The icon object
14930     *
14931     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14932     *
14933     * @ingroup Toolbar
14934     */
14935    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14936
14937    /**
14938     * Set the icon associated with @p item to an image in a binary buffer.
14939     *
14940     * @param item The toolbar item.
14941     * @param img The binary data that will be used as an image
14942     * @param size The size of binary data @p img
14943     * @param format Optional format of @p img to pass to the image loader
14944     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14945     *
14946     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14947     *
14948     * @note The icon image set by this function can be changed by
14949     * elm_toolbar_item_icon_set().
14950     * 
14951     * @ingroup Toolbar
14952     */
14953    EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
14954
14955    /**
14956     * Delete them item from the toolbar.
14957     *
14958     * @param item The item of toolbar to be deleted.
14959     *
14960     * @see elm_toolbar_item_append()
14961     * @see elm_toolbar_item_del_cb_set()
14962     *
14963     * @ingroup Toolbar
14964     */
14965    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14966
14967    /**
14968     * Set the function called when a toolbar item is freed.
14969     *
14970     * @param item The item to set the callback on.
14971     * @param func The function called.
14972     *
14973     * If there is a @p func, then it will be called prior item's memory release.
14974     * That will be called with the following arguments:
14975     * @li item's data;
14976     * @li item's Evas object;
14977     * @li item itself;
14978     *
14979     * This way, a data associated to a toolbar item could be properly freed.
14980     *
14981     * @ingroup Toolbar
14982     */
14983    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14984
14985    /**
14986     * Get a value whether toolbar item is disabled or not.
14987     *
14988     * @param item The item.
14989     * @return The disabled state.
14990     *
14991     * @see elm_toolbar_item_disabled_set() for more details.
14992     *
14993     * @ingroup Toolbar
14994     */
14995    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14996
14997    /**
14998     * Sets the disabled/enabled state of a toolbar item.
14999     *
15000     * @param item The item.
15001     * @param disabled The disabled state.
15002     *
15003     * A disabled item cannot be selected or unselected. It will also
15004     * change its appearance (generally greyed out). This sets the
15005     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15006     * enabled).
15007     *
15008     * @ingroup Toolbar
15009     */
15010    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15011
15012    /**
15013     * Set or unset item as a separator.
15014     *
15015     * @param item The toolbar item.
15016     * @param setting @c EINA_TRUE to set item @p item as separator or
15017     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15018     *
15019     * Items aren't set as separator by default.
15020     *
15021     * If set as separator it will display separator theme, so won't display
15022     * icons or label.
15023     *
15024     * @see elm_toolbar_item_separator_get()
15025     *
15026     * @ingroup Toolbar
15027     */
15028    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15029
15030    /**
15031     * Get a value whether item is a separator or not.
15032     *
15033     * @param item The toolbar item.
15034     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15035     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15036     *
15037     * @see elm_toolbar_item_separator_set() for details.
15038     *
15039     * @ingroup Toolbar
15040     */
15041    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15042
15043    /**
15044     * Set the shrink state of toolbar @p obj.
15045     *
15046     * @param obj The toolbar object.
15047     * @param shrink_mode Toolbar's items display behavior.
15048     *
15049     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15050     * but will enforce a minimun size so all the items will fit, won't scroll
15051     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15052     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15053     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15054     *
15055     * @ingroup Toolbar
15056     */
15057    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15058
15059    /**
15060     * Get the shrink mode of toolbar @p obj.
15061     *
15062     * @param obj The toolbar object.
15063     * @return Toolbar's items display behavior.
15064     *
15065     * @see elm_toolbar_mode_shrink_set() for details.
15066     *
15067     * @ingroup Toolbar
15068     */
15069    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15070
15071    /**
15072     * Enable/disable homogenous mode.
15073     *
15074     * @param obj The toolbar object
15075     * @param homogeneous Assume the items within the toolbar are of the
15076     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15077     *
15078     * This will enable the homogeneous mode where items are of the same size.
15079     * @see elm_toolbar_homogeneous_get()
15080     *
15081     * @ingroup Toolbar
15082     */
15083    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15084
15085    /**
15086     * Get whether the homogenous mode is enabled.
15087     *
15088     * @param obj The toolbar object.
15089     * @return Assume the items within the toolbar are of the same height
15090     * and width (EINA_TRUE = on, EINA_FALSE = off).
15091     *
15092     * @see elm_toolbar_homogeneous_set()
15093     *
15094     * @ingroup Toolbar
15095     */
15096    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15097
15098    /**
15099     * Enable/disable homogenous mode.
15100     *
15101     * @param obj The toolbar object
15102     * @param homogeneous Assume the items within the toolbar are of the
15103     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15104     *
15105     * This will enable the homogeneous mode where items are of the same size.
15106     * @see elm_toolbar_homogeneous_get()
15107     *
15108     * @deprecated use elm_toolbar_homogeneous_set() instead.
15109     *
15110     * @ingroup Toolbar
15111     */
15112    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15113
15114    /**
15115     * Get whether the homogenous mode is enabled.
15116     *
15117     * @param obj The toolbar object.
15118     * @return Assume the items within the toolbar are of the same height
15119     * and width (EINA_TRUE = on, EINA_FALSE = off).
15120     *
15121     * @see elm_toolbar_homogeneous_set()
15122     * @deprecated use elm_toolbar_homogeneous_get() instead.
15123     *
15124     * @ingroup Toolbar
15125     */
15126    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15127
15128    /**
15129     * Set the parent object of the toolbar items' menus.
15130     *
15131     * @param obj The toolbar object.
15132     * @param parent The parent of the menu objects.
15133     *
15134     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15135     *
15136     * For more details about setting the parent for toolbar menus, see
15137     * elm_menu_parent_set().
15138     *
15139     * @see elm_menu_parent_set() for details.
15140     * @see elm_toolbar_item_menu_set() for details.
15141     *
15142     * @ingroup Toolbar
15143     */
15144    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15145
15146    /**
15147     * Get the parent object of the toolbar items' menus.
15148     *
15149     * @param obj The toolbar object.
15150     * @return The parent of the menu objects.
15151     *
15152     * @see elm_toolbar_menu_parent_set() for details.
15153     *
15154     * @ingroup Toolbar
15155     */
15156    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15157
15158    /**
15159     * Set the alignment of the items.
15160     *
15161     * @param obj The toolbar object.
15162     * @param align The new alignment, a float between <tt> 0.0 </tt>
15163     * and <tt> 1.0 </tt>.
15164     *
15165     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15166     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15167     * items.
15168     *
15169     * Centered items by default.
15170     *
15171     * @see elm_toolbar_align_get()
15172     *
15173     * @ingroup Toolbar
15174     */
15175    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15176
15177    /**
15178     * Get the alignment of the items.
15179     *
15180     * @param obj The toolbar object.
15181     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15182     * <tt> 1.0 </tt>.
15183     *
15184     * @see elm_toolbar_align_set() for details.
15185     *
15186     * @ingroup Toolbar
15187     */
15188    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15189
15190    /**
15191     * Set whether the toolbar item opens a menu.
15192     *
15193     * @param item The toolbar item.
15194     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15195     *
15196     * A toolbar item can be set to be a menu, using this function.
15197     *
15198     * Once it is set to be a menu, it can be manipulated through the
15199     * menu-like function elm_toolbar_menu_parent_set() and the other
15200     * elm_menu functions, using the Evas_Object @c menu returned by
15201     * elm_toolbar_item_menu_get().
15202     *
15203     * So, items to be displayed in this item's menu should be added with
15204     * elm_menu_item_add().
15205     *
15206     * The following code exemplifies the most basic usage:
15207     * @code
15208     * tb = elm_toolbar_add(win)
15209     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15210     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15211     * elm_toolbar_menu_parent_set(tb, win);
15212     * menu = elm_toolbar_item_menu_get(item);
15213     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15214     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15215     * NULL);
15216     * @endcode
15217     *
15218     * @see elm_toolbar_item_menu_get()
15219     *
15220     * @ingroup Toolbar
15221     */
15222    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15223
15224    /**
15225     * Get toolbar item's menu.
15226     *
15227     * @param item The toolbar item.
15228     * @return Item's menu object or @c NULL on failure.
15229     *
15230     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15231     * this function will set it.
15232     *
15233     * @see elm_toolbar_item_menu_set() for details.
15234     *
15235     * @ingroup Toolbar
15236     */
15237    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15238
15239    /**
15240     * Add a new state to @p item.
15241     *
15242     * @param item The item.
15243     * @param icon A string with icon name or the absolute path of an image file.
15244     * @param label The label of the new state.
15245     * @param func The function to call when the item is clicked when this
15246     * state is selected.
15247     * @param data The data to associate with the state.
15248     * @return The toolbar item state, or @c NULL upon failure.
15249     *
15250     * Toolbar will load icon image from fdo or current theme.
15251     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15252     * If an absolute path is provided it will load it direct from a file.
15253     *
15254     * States created with this function can be removed with
15255     * elm_toolbar_item_state_del().
15256     *
15257     * @see elm_toolbar_item_state_del()
15258     * @see elm_toolbar_item_state_sel()
15259     * @see elm_toolbar_item_state_get()
15260     *
15261     * @ingroup Toolbar
15262     */
15263    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);
15264
15265    /**
15266     * Delete a previoulsy added state to @p item.
15267     *
15268     * @param item The toolbar item.
15269     * @param state The state to be deleted.
15270     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15271     *
15272     * @see elm_toolbar_item_state_add()
15273     */
15274    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15275
15276    /**
15277     * Set @p state as the current state of @p it.
15278     *
15279     * @param it The item.
15280     * @param state The state to use.
15281     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15282     *
15283     * If @p state is @c NULL, it won't select any state and the default item's
15284     * icon and label will be used. It's the same behaviour than
15285     * elm_toolbar_item_state_unser().
15286     *
15287     * @see elm_toolbar_item_state_unset()
15288     *
15289     * @ingroup Toolbar
15290     */
15291    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15292
15293    /**
15294     * Unset the state of @p it.
15295     *
15296     * @param it The item.
15297     *
15298     * The default icon and label from this item will be displayed.
15299     *
15300     * @see elm_toolbar_item_state_set() for more details.
15301     *
15302     * @ingroup Toolbar
15303     */
15304    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15305
15306    /**
15307     * Get the current state of @p it.
15308     *
15309     * @param item The item.
15310     * @return The selected state or @c NULL if none is selected or on failure.
15311     *
15312     * @see elm_toolbar_item_state_set() for details.
15313     * @see elm_toolbar_item_state_unset()
15314     * @see elm_toolbar_item_state_add()
15315     *
15316     * @ingroup Toolbar
15317     */
15318    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15319
15320    /**
15321     * Get the state after selected state in toolbar's @p item.
15322     *
15323     * @param it The toolbar item to change state.
15324     * @return The state after current state, or @c NULL on failure.
15325     *
15326     * If last state is selected, this function will return first state.
15327     *
15328     * @see elm_toolbar_item_state_set()
15329     * @see elm_toolbar_item_state_add()
15330     *
15331     * @ingroup Toolbar
15332     */
15333    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15334
15335    /**
15336     * Get the state before selected state in toolbar's @p item.
15337     *
15338     * @param it The toolbar item to change state.
15339     * @return The state before current state, or @c NULL on failure.
15340     *
15341     * If first state is selected, this function will return last state.
15342     *
15343     * @see elm_toolbar_item_state_set()
15344     * @see elm_toolbar_item_state_add()
15345     *
15346     * @ingroup Toolbar
15347     */
15348    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15349
15350    /**
15351     * Set the text to be shown in a given toolbar item's tooltips.
15352     *
15353     * @param item Target item.
15354     * @param text The text to set in the content.
15355     *
15356     * Setup the text as tooltip to object. The item can have only one tooltip,
15357     * so any previous tooltip data - set with this function or
15358     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15359     *
15360     * @see elm_object_tooltip_text_set() for more details.
15361     *
15362     * @ingroup Toolbar
15363     */
15364    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15365
15366    /**
15367     * Set the content to be shown in the tooltip item.
15368     *
15369     * Setup the tooltip to item. The item can have only one tooltip,
15370     * so any previous tooltip data is removed. @p func(with @p data) will
15371     * be called every time that need show the tooltip and it should
15372     * return a valid Evas_Object. This object is then managed fully by
15373     * tooltip system and is deleted when the tooltip is gone.
15374     *
15375     * @param item the toolbar item being attached a tooltip.
15376     * @param func the function used to create the tooltip contents.
15377     * @param data what to provide to @a func as callback data/context.
15378     * @param del_cb called when data is not needed anymore, either when
15379     *        another callback replaces @a func, the tooltip is unset with
15380     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15381     *        dies. This callback receives as the first parameter the
15382     *        given @a data, and @c event_info is the item.
15383     *
15384     * @see elm_object_tooltip_content_cb_set() for more details.
15385     *
15386     * @ingroup Toolbar
15387     */
15388    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);
15389
15390    /**
15391     * Unset tooltip from item.
15392     *
15393     * @param item toolbar item to remove previously set tooltip.
15394     *
15395     * Remove tooltip from item. The callback provided as del_cb to
15396     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15397     * it is not used anymore.
15398     *
15399     * @see elm_object_tooltip_unset() for more details.
15400     * @see elm_toolbar_item_tooltip_content_cb_set()
15401     *
15402     * @ingroup Toolbar
15403     */
15404    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15405
15406    /**
15407     * Sets a different style for this item tooltip.
15408     *
15409     * @note before you set a style you should define a tooltip with
15410     *       elm_toolbar_item_tooltip_content_cb_set() or
15411     *       elm_toolbar_item_tooltip_text_set()
15412     *
15413     * @param item toolbar item with tooltip already set.
15414     * @param style the theme style to use (default, transparent, ...)
15415     *
15416     * @see elm_object_tooltip_style_set() for more details.
15417     *
15418     * @ingroup Toolbar
15419     */
15420    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15421
15422    /**
15423     * Get the style for this item tooltip.
15424     *
15425     * @param item toolbar item with tooltip already set.
15426     * @return style the theme style in use, defaults to "default". If the
15427     *         object does not have a tooltip set, then NULL is returned.
15428     *
15429     * @see elm_object_tooltip_style_get() for more details.
15430     * @see elm_toolbar_item_tooltip_style_set()
15431     *
15432     * @ingroup Toolbar
15433     */
15434    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15435
15436    /**
15437     * Set the type of mouse pointer/cursor decoration to be shown,
15438     * when the mouse pointer is over the given toolbar widget item
15439     *
15440     * @param item toolbar item to customize cursor on
15441     * @param cursor the cursor type's name
15442     *
15443     * This function works analogously as elm_object_cursor_set(), but
15444     * here the cursor's changing area is restricted to the item's
15445     * area, and not the whole widget's. Note that that item cursors
15446     * have precedence over widget cursors, so that a mouse over an
15447     * item with custom cursor set will always show @b that cursor.
15448     *
15449     * If this function is called twice for an object, a previously set
15450     * cursor will be unset on the second call.
15451     *
15452     * @see elm_object_cursor_set()
15453     * @see elm_toolbar_item_cursor_get()
15454     * @see elm_toolbar_item_cursor_unset()
15455     *
15456     * @ingroup Toolbar
15457     */
15458    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15459
15460    /*
15461     * Get the type of mouse pointer/cursor decoration set to be shown,
15462     * when the mouse pointer is over the given toolbar widget item
15463     *
15464     * @param item toolbar item with custom cursor set
15465     * @return the cursor type's name or @c NULL, if no custom cursors
15466     * were set to @p item (and on errors)
15467     *
15468     * @see elm_object_cursor_get()
15469     * @see elm_toolbar_item_cursor_set()
15470     * @see elm_toolbar_item_cursor_unset()
15471     *
15472     * @ingroup Toolbar
15473     */
15474    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15475
15476    /**
15477     * Unset any custom mouse pointer/cursor decoration set to be
15478     * shown, when the mouse pointer is over the given toolbar widget
15479     * item, thus making it show the @b default cursor again.
15480     *
15481     * @param item a toolbar item
15482     *
15483     * Use this call to undo any custom settings on this item's cursor
15484     * decoration, bringing it back to defaults (no custom style set).
15485     *
15486     * @see elm_object_cursor_unset()
15487     * @see elm_toolbar_item_cursor_set()
15488     *
15489     * @ingroup Toolbar
15490     */
15491    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15492
15493    /**
15494     * Set a different @b style for a given custom cursor set for a
15495     * toolbar item.
15496     *
15497     * @param item toolbar item with custom cursor set
15498     * @param style the <b>theme style</b> to use (e.g. @c "default",
15499     * @c "transparent", etc)
15500     *
15501     * This function only makes sense when one is using custom mouse
15502     * cursor decorations <b>defined in a theme file</b>, which can have,
15503     * given a cursor name/type, <b>alternate styles</b> on it. It
15504     * works analogously as elm_object_cursor_style_set(), but here
15505     * applyed only to toolbar item objects.
15506     *
15507     * @warning Before you set a cursor style you should have definen a
15508     *       custom cursor previously on the item, with
15509     *       elm_toolbar_item_cursor_set()
15510     *
15511     * @see elm_toolbar_item_cursor_engine_only_set()
15512     * @see elm_toolbar_item_cursor_style_get()
15513     *
15514     * @ingroup Toolbar
15515     */
15516    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15517
15518    /**
15519     * Get the current @b style set for a given toolbar item's custom
15520     * cursor
15521     *
15522     * @param item toolbar item with custom cursor set.
15523     * @return style the cursor style in use. If the object does not
15524     *         have a cursor set, then @c NULL is returned.
15525     *
15526     * @see elm_toolbar_item_cursor_style_set() for more details
15527     *
15528     * @ingroup Toolbar
15529     */
15530    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15531
15532    /**
15533     * Set if the (custom)cursor for a given toolbar item should be
15534     * searched in its theme, also, or should only rely on the
15535     * rendering engine.
15536     *
15537     * @param item item with custom (custom) cursor already set on
15538     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15539     * only on those provided by the rendering engine, @c EINA_FALSE to
15540     * have them searched on the widget's theme, as well.
15541     *
15542     * @note This call is of use only if you've set a custom cursor
15543     * for toolbar items, with elm_toolbar_item_cursor_set().
15544     *
15545     * @note By default, cursors will only be looked for between those
15546     * provided by the rendering engine.
15547     *
15548     * @ingroup Toolbar
15549     */
15550    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15551
15552    /**
15553     * Get if the (custom) cursor for a given toolbar item is being
15554     * searched in its theme, also, or is only relying on the rendering
15555     * engine.
15556     *
15557     * @param item a toolbar item
15558     * @return @c EINA_TRUE, if cursors are being looked for only on
15559     * those provided by the rendering engine, @c EINA_FALSE if they
15560     * are being searched on the widget's theme, as well.
15561     *
15562     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15563     *
15564     * @ingroup Toolbar
15565     */
15566    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15567
15568    /**
15569     * Change a toolbar's orientation
15570     * @param obj The toolbar object
15571     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15572     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15573     * @ingroup Toolbar
15574     * @deprecated use elm_toolbar_horizontal_set() instead.
15575     */
15576    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15577
15578    /**
15579     * Change a toolbar's orientation
15580     * @param obj The toolbar object
15581     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15582     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15583     * @ingroup Toolbar
15584     */
15585    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15586
15587    /**
15588     * Get a toolbar's orientation
15589     * @param obj The toolbar object
15590     * @return If @c EINA_TRUE, the toolbar is vertical
15591     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15592     * @ingroup Toolbar
15593     * @deprecated use elm_toolbar_horizontal_get() instead.
15594     */
15595    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15596
15597    /**
15598     * Get a toolbar's orientation
15599     * @param obj The toolbar object
15600     * @return If @c EINA_TRUE, the toolbar is horizontal
15601     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15602     * @ingroup Toolbar
15603     */
15604    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15605    /**
15606     * @}
15607     */
15608
15609    /**
15610     * @defgroup Tooltips Tooltips
15611     *
15612     * The Tooltip is an (internal, for now) smart object used to show a
15613     * content in a frame on mouse hover of objects(or widgets), with
15614     * tips/information about them.
15615     *
15616     * @{
15617     */
15618
15619    EAPI double       elm_tooltip_delay_get(void);
15620    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15621    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15622    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15623    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15624    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15625 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15626    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);
15627    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15628    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15629    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15630
15631    /**
15632     * @defgroup Cursors Cursors
15633     *
15634     * The Elementary cursor is an internal smart object used to
15635     * customize the mouse cursor displayed over objects (or
15636     * widgets). In the most common scenario, the cursor decoration
15637     * comes from the graphical @b engine Elementary is running
15638     * on. Those engines may provide different decorations for cursors,
15639     * and Elementary provides functions to choose them (think of X11
15640     * cursors, as an example).
15641     *
15642     * There's also the possibility of, besides using engine provided
15643     * cursors, also use ones coming from Edje theming files. Both
15644     * globally and per widget, Elementary makes it possible for one to
15645     * make the cursors lookup to be held on engines only or on
15646     * Elementary's theme file, too. To set cursor's hot spot,
15647     * two data items should be added to cursor's theme: "hot_x" and
15648     * "hot_y", that are the offset from upper-left corner of the cursor
15649     * (coordinates 0,0).
15650     *
15651     * @{
15652     */
15653
15654    /**
15655     * Set the cursor to be shown when mouse is over the object
15656     *
15657     * Set the cursor that will be displayed when mouse is over the
15658     * object. The object can have only one cursor set to it, so if
15659     * this function is called twice for an object, the previous set
15660     * will be unset.
15661     * If using X cursors, a definition of all the valid cursor names
15662     * is listed on Elementary_Cursors.h. If an invalid name is set
15663     * the default cursor will be used.
15664     *
15665     * @param obj the object being set a cursor.
15666     * @param cursor the cursor name to be used.
15667     *
15668     * @ingroup Cursors
15669     */
15670    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15671
15672    /**
15673     * Get the cursor to be shown when mouse is over the object
15674     *
15675     * @param obj an object with cursor already set.
15676     * @return the cursor name.
15677     *
15678     * @ingroup Cursors
15679     */
15680    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15681
15682    /**
15683     * Unset cursor for object
15684     *
15685     * Unset cursor for object, and set the cursor to default if the mouse
15686     * was over this object.
15687     *
15688     * @param obj Target object
15689     * @see elm_object_cursor_set()
15690     *
15691     * @ingroup Cursors
15692     */
15693    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15694
15695    /**
15696     * Sets a different style for this object cursor.
15697     *
15698     * @note before you set a style you should define a cursor with
15699     *       elm_object_cursor_set()
15700     *
15701     * @param obj an object with cursor already set.
15702     * @param style the theme style to use (default, transparent, ...)
15703     *
15704     * @ingroup Cursors
15705     */
15706    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15707
15708    /**
15709     * Get the style for this object cursor.
15710     *
15711     * @param obj an object with cursor already set.
15712     * @return style the theme style in use, defaults to "default". If the
15713     *         object does not have a cursor set, then NULL is returned.
15714     *
15715     * @ingroup Cursors
15716     */
15717    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15718
15719    /**
15720     * Set if the cursor set should be searched on the theme or should use
15721     * the provided by the engine, only.
15722     *
15723     * @note before you set if should look on theme you should define a cursor
15724     * with elm_object_cursor_set(). By default it will only look for cursors
15725     * provided by the engine.
15726     *
15727     * @param obj an object with cursor already set.
15728     * @param engine_only boolean to define it cursors should be looked only
15729     * between the provided by the engine or searched on widget's theme as well.
15730     *
15731     * @ingroup Cursors
15732     */
15733    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15734
15735    /**
15736     * Get the cursor engine only usage for this object cursor.
15737     *
15738     * @param obj an object with cursor already set.
15739     * @return engine_only boolean to define it cursors should be
15740     * looked only between the provided by the engine or searched on
15741     * widget's theme as well. If the object does not have a cursor
15742     * set, then EINA_FALSE is returned.
15743     *
15744     * @ingroup Cursors
15745     */
15746    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15747
15748    /**
15749     * Get the configured cursor engine only usage
15750     *
15751     * This gets the globally configured exclusive usage of engine cursors.
15752     *
15753     * @return 1 if only engine cursors should be used
15754     * @ingroup Cursors
15755     */
15756    EAPI int          elm_cursor_engine_only_get(void);
15757
15758    /**
15759     * Set the configured cursor engine only usage
15760     *
15761     * This sets the globally configured exclusive usage of engine cursors.
15762     * It won't affect cursors set before changing this value.
15763     *
15764     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15765     * look for them on theme before.
15766     * @return EINA_TRUE if value is valid and setted (0 or 1)
15767     * @ingroup Cursors
15768     */
15769    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15770
15771    /**
15772     * @}
15773     */
15774
15775    /**
15776     * @defgroup Menu Menu
15777     *
15778     * @image html img/widget/menu/preview-00.png
15779     * @image latex img/widget/menu/preview-00.eps
15780     *
15781     * A menu is a list of items displayed above its parent. When the menu is
15782     * showing its parent is darkened. Each item can have a sub-menu. The menu
15783     * object can be used to display a menu on a right click event, in a toolbar,
15784     * anywhere.
15785     *
15786     * Signals that you can add callbacks for are:
15787     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15788     *             event_info is NULL.
15789     *
15790     * @see @ref tutorial_menu
15791     * @{
15792     */
15793    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15794    /**
15795     * @brief Add a new menu to the parent
15796     *
15797     * @param parent The parent object.
15798     * @return The new object or NULL if it cannot be created.
15799     */
15800    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15801    /**
15802     * @brief Set the parent for the given menu widget
15803     *
15804     * @param obj The menu object.
15805     * @param parent The new parent.
15806     */
15807    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15808    /**
15809     * @brief Get the parent for the given menu widget
15810     *
15811     * @param obj The menu object.
15812     * @return The parent.
15813     *
15814     * @see elm_menu_parent_set()
15815     */
15816    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15817    /**
15818     * @brief Move the menu to a new position
15819     *
15820     * @param obj The menu object.
15821     * @param x The new position.
15822     * @param y The new position.
15823     *
15824     * Sets the top-left position of the menu to (@p x,@p y).
15825     *
15826     * @note @p x and @p y coordinates are relative to parent.
15827     */
15828    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15829    /**
15830     * @brief Close a opened menu
15831     *
15832     * @param obj the menu object
15833     * @return void
15834     *
15835     * Hides the menu and all it's sub-menus.
15836     */
15837    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15838    /**
15839     * @brief Returns a list of @p item's items.
15840     *
15841     * @param obj The menu object
15842     * @return An Eina_List* of @p item's items
15843     */
15844    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15845    /**
15846     * @brief Get the Evas_Object of an Elm_Menu_Item
15847     *
15848     * @param item The menu item object.
15849     * @return The edje object containing the swallowed content
15850     *
15851     * @warning Don't manipulate this object!
15852     */
15853    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15854    /**
15855     * @brief Add an item at the end of the given menu widget
15856     *
15857     * @param obj The menu object.
15858     * @param parent The parent menu item (optional)
15859     * @param icon A icon display on the item. The icon will be destryed by the menu.
15860     * @param label The label of the item.
15861     * @param func Function called when the user select the item.
15862     * @param data Data sent by the callback.
15863     * @return Returns the new item.
15864     */
15865    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);
15866    /**
15867     * @brief Add an object swallowed in an item at the end of the given menu
15868     * widget
15869     *
15870     * @param obj The menu object.
15871     * @param parent The parent menu item (optional)
15872     * @param subobj The object to swallow
15873     * @param func Function called when the user select the item.
15874     * @param data Data sent by the callback.
15875     * @return Returns the new item.
15876     *
15877     * Add an evas object as an item to the menu.
15878     */
15879    EAPI Elm_Menu_Item     *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15880    /**
15881     * @brief Set the label of a menu item
15882     *
15883     * @param item The menu item object.
15884     * @param label The label to set for @p item
15885     *
15886     * @warning Don't use this funcion on items created with
15887     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15888     */
15889    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15890    /**
15891     * @brief Get the label of a menu item
15892     *
15893     * @param item The menu item object.
15894     * @return The label of @p item
15895     */
15896    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15897    /**
15898     * @brief Set the icon of a menu item to the standard icon with name @p icon
15899     *
15900     * @param item The menu item object.
15901     * @param icon The icon object to set for the content of @p item
15902     *
15903     * Once this icon is set, any previously set icon will be deleted.
15904     */
15905    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15906    /**
15907     * @brief Get the string representation from the icon of a menu item
15908     *
15909     * @param item The menu item object.
15910     * @return The string representation of @p item's icon or NULL
15911     *
15912     * @see elm_menu_item_object_icon_name_set()
15913     */
15914    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15915    /**
15916     * @brief Set the content object of a menu item
15917     *
15918     * @param item The menu item object
15919     * @param The content object or NULL
15920     * @return EINA_TRUE on success, else EINA_FALSE
15921     *
15922     * Use this function to change the object swallowed by a menu item, deleting
15923     * any previously swallowed object.
15924     */
15925    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15926    /**
15927     * @brief Get the content object of a menu item
15928     *
15929     * @param item The menu item object
15930     * @return The content object or NULL
15931     * @note If @p item was added with elm_menu_item_add_object, this
15932     * function will return the object passed, else it will return the
15933     * icon object.
15934     *
15935     * @see elm_menu_item_object_content_set()
15936     */
15937    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15938
15939    EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
15940      {
15941         elm_menu_item_object_icon_name_set(item, icon);
15942      }
15943
15944    EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15945      {
15946         return elm_menu_item_object_content_get(item);
15947      }
15948
15949    EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
15950      {
15951         return elm_menu_item_object_icon_name_get(item);
15952      }
15953
15954    /**
15955     * @brief Set the selected state of @p item.
15956     *
15957     * @param item The menu item object.
15958     * @param selected The selected/unselected state of the item
15959     */
15960    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15961    /**
15962     * @brief Get the selected state of @p item.
15963     *
15964     * @param item The menu item object.
15965     * @return The selected/unselected state of the item
15966     *
15967     * @see elm_menu_item_selected_set()
15968     */
15969    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15970    /**
15971     * @brief Set the disabled state of @p item.
15972     *
15973     * @param item The menu item object.
15974     * @param disabled The enabled/disabled state of the item
15975     */
15976    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15977    /**
15978     * @brief Get the disabled state of @p item.
15979     *
15980     * @param item The menu item object.
15981     * @return The enabled/disabled state of the item
15982     *
15983     * @see elm_menu_item_disabled_set()
15984     */
15985    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15986    /**
15987     * @brief Add a separator item to menu @p obj under @p parent.
15988     *
15989     * @param obj The menu object
15990     * @param parent The item to add the separator under
15991     * @return The created item or NULL on failure
15992     *
15993     * This is item is a @ref Separator.
15994     */
15995    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15996    /**
15997     * @brief Returns whether @p item is a separator.
15998     *
15999     * @param item The item to check
16000     * @return If true, @p item is a separator
16001     *
16002     * @see elm_menu_item_separator_add()
16003     */
16004    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16005    /**
16006     * @brief Deletes an item from the menu.
16007     *
16008     * @param item The item to delete.
16009     *
16010     * @see elm_menu_item_add()
16011     */
16012    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16013    /**
16014     * @brief Set the function called when a menu item is deleted.
16015     *
16016     * @param item The item to set the callback on
16017     * @param func The function called
16018     *
16019     * @see elm_menu_item_add()
16020     * @see elm_menu_item_del()
16021     */
16022    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16023    /**
16024     * @brief Returns the data associated with menu item @p item.
16025     *
16026     * @param item The item
16027     * @return The data associated with @p item or NULL if none was set.
16028     *
16029     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16030     */
16031    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16032    /**
16033     * @brief Sets the data to be associated with menu item @p item.
16034     *
16035     * @param item The item
16036     * @param data The data to be associated with @p item
16037     */
16038    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16039    /**
16040     * @brief Returns a list of @p item's subitems.
16041     *
16042     * @param item The item
16043     * @return An Eina_List* of @p item's subitems
16044     *
16045     * @see elm_menu_add()
16046     */
16047    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16048    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16049    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16050    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16051    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16052    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16053    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16054
16055    /**
16056     * @}
16057     */
16058
16059    /**
16060     * @defgroup List List
16061     * @ingroup Elementary
16062     *
16063     * @image html img/widget/list/preview-00.png
16064     * @image latex img/widget/list/preview-00.eps width=\textwidth
16065     *
16066     * @image html img/list.png
16067     * @image latex img/list.eps width=\textwidth
16068     *
16069     * A list widget is a container whose children are displayed vertically or
16070     * horizontally, in order, and can be selected.
16071     * The list can accept only one or multiple items selection. Also has many
16072     * modes of items displaying.
16073     *
16074     * A list is a very simple type of list widget.  For more robust
16075     * lists, @ref Genlist should probably be used.
16076     *
16077     * Smart callbacks one can listen to:
16078     * - @c "activated" - The user has double-clicked or pressed
16079     *   (enter|return|spacebar) on an item. The @c event_info parameter
16080     *   is the item that was activated.
16081     * - @c "clicked,double" - The user has double-clicked an item.
16082     *   The @c event_info parameter is the item that was double-clicked.
16083     * - "selected" - when the user selected an item
16084     * - "unselected" - when the user unselected an item
16085     * - "longpressed" - an item in the list is long-pressed
16086     * - "edge,top" - the list is scrolled until the top edge
16087     * - "edge,bottom" - the list is scrolled until the bottom edge
16088     * - "edge,left" - the list is scrolled until the left edge
16089     * - "edge,right" - the list is scrolled until the right edge
16090     * - "language,changed" - the program's language changed
16091     *
16092     * Available styles for it:
16093     * - @c "default"
16094     *
16095     * List of examples:
16096     * @li @ref list_example_01
16097     * @li @ref list_example_02
16098     * @li @ref list_example_03
16099     */
16100
16101    /**
16102     * @addtogroup List
16103     * @{
16104     */
16105
16106    /**
16107     * @enum _Elm_List_Mode
16108     * @typedef Elm_List_Mode
16109     *
16110     * Set list's resize behavior, transverse axis scroll and
16111     * items cropping. See each mode's description for more details.
16112     *
16113     * @note Default value is #ELM_LIST_SCROLL.
16114     *
16115     * Values <b> don't </b> work as bitmask, only one can be choosen.
16116     *
16117     * @see elm_list_mode_set()
16118     * @see elm_list_mode_get()
16119     *
16120     * @ingroup List
16121     */
16122    typedef enum _Elm_List_Mode
16123      {
16124         ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
16125         ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
16126         ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
16127         ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
16128         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16129      } Elm_List_Mode;
16130
16131    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item. Can be created with elm_list_item_append(), elm_list_item_prepend() and functions to add items in relative positions, like elm_list_item_insert_before(), and deleted with elm_list_item_del().  */
16132
16133    /**
16134     * Add a new list widget to the given parent Elementary
16135     * (container) object.
16136     *
16137     * @param parent The parent object.
16138     * @return a new list widget handle or @c NULL, on errors.
16139     *
16140     * This function inserts a new list widget on the canvas.
16141     *
16142     * @ingroup List
16143     */
16144    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16145
16146    /**
16147     * Starts the list.
16148     *
16149     * @param obj The list object
16150     *
16151     * @note Call before running show() on the list object.
16152     * @warning If not called, it won't display the list properly.
16153     *
16154     * @code
16155     * li = elm_list_add(win);
16156     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16157     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16158     * elm_list_go(li);
16159     * evas_object_show(li);
16160     * @endcode
16161     *
16162     * @ingroup List
16163     */
16164    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16165
16166    /**
16167     * Enable or disable multiple items selection on the list object.
16168     *
16169     * @param obj The list object
16170     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16171     * disable it.
16172     *
16173     * Disabled by default. If disabled, the user can select a single item of
16174     * the list each time. Selected items are highlighted on list.
16175     * If enabled, many items can be selected.
16176     *
16177     * If a selected item is selected again, it will be unselected.
16178     *
16179     * @see elm_list_multi_select_get()
16180     *
16181     * @ingroup List
16182     */
16183    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16184
16185    /**
16186     * Get a value whether multiple items selection is enabled or not.
16187     *
16188     * @see elm_list_multi_select_set() for details.
16189     *
16190     * @param obj The list object.
16191     * @return @c EINA_TRUE means multiple items selection is enabled.
16192     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16193     * @c EINA_FALSE is returned.
16194     *
16195     * @ingroup List
16196     */
16197    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16198
16199    /**
16200     * Set which mode to use for the list object.
16201     *
16202     * @param obj The list object
16203     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16204     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16205     *
16206     * Set list's resize behavior, transverse axis scroll and
16207     * items cropping. See each mode's description for more details.
16208     *
16209     * @note Default value is #ELM_LIST_SCROLL.
16210     *
16211     * Only one can be set, if a previous one was set, it will be changed
16212     * by the new mode set. Bitmask won't work as well.
16213     *
16214     * @see elm_list_mode_get()
16215     *
16216     * @ingroup List
16217     */
16218    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16219
16220    /**
16221     * Get the mode the list is at.
16222     *
16223     * @param obj The list object
16224     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16225     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16226     *
16227     * @note see elm_list_mode_set() for more information.
16228     *
16229     * @ingroup List
16230     */
16231    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16232
16233    /**
16234     * Enable or disable horizontal mode on the list object.
16235     *
16236     * @param obj The list object.
16237     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16238     * disable it, i.e., to enable vertical mode.
16239     *
16240     * @note Vertical mode is set by default.
16241     *
16242     * On horizontal mode items are displayed on list from left to right,
16243     * instead of from top to bottom. Also, the list will scroll horizontally.
16244     * Each item will presents left icon on top and right icon, or end, at
16245     * the bottom.
16246     *
16247     * @see elm_list_horizontal_get()
16248     *
16249     * @ingroup List
16250     */
16251    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16252
16253    /**
16254     * Get a value whether horizontal mode is enabled or not.
16255     *
16256     * @param obj The list object.
16257     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16258     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16259     * @c EINA_FALSE is returned.
16260     *
16261     * @see elm_list_horizontal_set() for details.
16262     *
16263     * @ingroup List
16264     */
16265    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16266
16267    /**
16268     * Enable or disable always select mode on the list object.
16269     *
16270     * @param obj The list object
16271     * @param always_select @c EINA_TRUE to enable always select mode or
16272     * @c EINA_FALSE to disable it.
16273     *
16274     * @note Always select mode is disabled by default.
16275     *
16276     * Default behavior of list items is to only call its callback function
16277     * the first time it's pressed, i.e., when it is selected. If a selected
16278     * item is pressed again, and multi-select is disabled, it won't call
16279     * this function (if multi-select is enabled it will unselect the item).
16280     *
16281     * If always select is enabled, it will call the callback function
16282     * everytime a item is pressed, so it will call when the item is selected,
16283     * and again when a selected item is pressed.
16284     *
16285     * @see elm_list_always_select_mode_get()
16286     * @see elm_list_multi_select_set()
16287     *
16288     * @ingroup List
16289     */
16290    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16291
16292    /**
16293     * Get a value whether always select mode is enabled or not, meaning that
16294     * an item will always call its callback function, even if already selected.
16295     *
16296     * @param obj The list object
16297     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16298     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16299     * @c EINA_FALSE is returned.
16300     *
16301     * @see elm_list_always_select_mode_set() for details.
16302     *
16303     * @ingroup List
16304     */
16305    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16306
16307    /**
16308     * Set bouncing behaviour when the scrolled content reaches an edge.
16309     *
16310     * Tell the internal scroller object whether it should bounce or not
16311     * when it reaches the respective edges for each axis.
16312     *
16313     * @param obj The list object
16314     * @param h_bounce Whether to bounce or not in the horizontal axis.
16315     * @param v_bounce Whether to bounce or not in the vertical axis.
16316     *
16317     * @see elm_scroller_bounce_set()
16318     *
16319     * @ingroup List
16320     */
16321    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16322
16323    /**
16324     * Get the bouncing behaviour of the internal scroller.
16325     *
16326     * Get whether the internal scroller should bounce when the edge of each
16327     * axis is reached scrolling.
16328     *
16329     * @param obj The list object.
16330     * @param h_bounce Pointer where to store the bounce state of the horizontal
16331     * axis.
16332     * @param v_bounce Pointer where to store the bounce state of the vertical
16333     * axis.
16334     *
16335     * @see elm_scroller_bounce_get()
16336     * @see elm_list_bounce_set()
16337     *
16338     * @ingroup List
16339     */
16340    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16341
16342    /**
16343     * Set the scrollbar policy.
16344     *
16345     * @param obj The list object
16346     * @param policy_h Horizontal scrollbar policy.
16347     * @param policy_v Vertical scrollbar policy.
16348     *
16349     * This sets the scrollbar visibility policy for the given scroller.
16350     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16351     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16352     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16353     * This applies respectively for the horizontal and vertical scrollbars.
16354     *
16355     * The both are disabled by default, i.e., are set to
16356     * #ELM_SCROLLER_POLICY_OFF.
16357     *
16358     * @ingroup List
16359     */
16360    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16361
16362    /**
16363     * Get the scrollbar policy.
16364     *
16365     * @see elm_list_scroller_policy_get() for details.
16366     *
16367     * @param obj The list object.
16368     * @param policy_h Pointer where to store horizontal scrollbar policy.
16369     * @param policy_v Pointer where to store vertical scrollbar policy.
16370     *
16371     * @ingroup List
16372     */
16373    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);
16374
16375    /**
16376     * Append a new item to the list object.
16377     *
16378     * @param obj The list object.
16379     * @param label The label of the list item.
16380     * @param icon The icon object to use for the left side of the item. An
16381     * icon can be any Evas object, but usually it is an icon created
16382     * with elm_icon_add().
16383     * @param end The icon object to use for the right side of the item. An
16384     * icon can be any Evas object.
16385     * @param func The function to call when the item is clicked.
16386     * @param data The data to associate with the item for related callbacks.
16387     *
16388     * @return The created item or @c NULL upon failure.
16389     *
16390     * A new item will be created and appended to the list, i.e., will
16391     * be set as @b last item.
16392     *
16393     * Items created with this method can be deleted with
16394     * elm_list_item_del().
16395     *
16396     * Associated @p data can be properly freed when item is deleted if a
16397     * callback function is set with elm_list_item_del_cb_set().
16398     *
16399     * If a function is passed as argument, it will be called everytime this item
16400     * is selected, i.e., the user clicks over an unselected item.
16401     * If always select is enabled it will call this function every time
16402     * user clicks over an item (already selected or not).
16403     * If such function isn't needed, just passing
16404     * @c NULL as @p func is enough. The same should be done for @p data.
16405     *
16406     * Simple example (with no function callback or data associated):
16407     * @code
16408     * li = elm_list_add(win);
16409     * ic = elm_icon_add(win);
16410     * elm_icon_file_set(ic, "path/to/image", NULL);
16411     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16412     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16413     * elm_list_go(li);
16414     * evas_object_show(li);
16415     * @endcode
16416     *
16417     * @see elm_list_always_select_mode_set()
16418     * @see elm_list_item_del()
16419     * @see elm_list_item_del_cb_set()
16420     * @see elm_list_clear()
16421     * @see elm_icon_add()
16422     *
16423     * @ingroup List
16424     */
16425    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);
16426
16427    /**
16428     * Prepend a new item to the list object.
16429     *
16430     * @param obj The list object.
16431     * @param label The label of the list item.
16432     * @param icon The icon object to use for the left side of the item. An
16433     * icon can be any Evas object, but usually it is an icon created
16434     * with elm_icon_add().
16435     * @param end The icon object to use for the right side of the item. An
16436     * icon can be any Evas object.
16437     * @param func The function to call when the item is clicked.
16438     * @param data The data to associate with the item for related callbacks.
16439     *
16440     * @return The created item or @c NULL upon failure.
16441     *
16442     * A new item will be created and prepended to the list, i.e., will
16443     * be set as @b first item.
16444     *
16445     * Items created with this method can be deleted with
16446     * elm_list_item_del().
16447     *
16448     * Associated @p data can be properly freed when item is deleted if a
16449     * callback function is set with elm_list_item_del_cb_set().
16450     *
16451     * If a function is passed as argument, it will be called everytime this item
16452     * is selected, i.e., the user clicks over an unselected item.
16453     * If always select is enabled it will call this function every time
16454     * user clicks over an item (already selected or not).
16455     * If such function isn't needed, just passing
16456     * @c NULL as @p func is enough. The same should be done for @p data.
16457     *
16458     * @see elm_list_item_append() for a simple code example.
16459     * @see elm_list_always_select_mode_set()
16460     * @see elm_list_item_del()
16461     * @see elm_list_item_del_cb_set()
16462     * @see elm_list_clear()
16463     * @see elm_icon_add()
16464     *
16465     * @ingroup List
16466     */
16467    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);
16468
16469    /**
16470     * Insert a new item into the list object before item @p before.
16471     *
16472     * @param obj The list object.
16473     * @param before The list item to insert before.
16474     * @param label The label of the list item.
16475     * @param icon The icon object to use for the left side of the item. An
16476     * icon can be any Evas object, but usually it is an icon created
16477     * with elm_icon_add().
16478     * @param end The icon object to use for the right side of the item. An
16479     * icon can be any Evas object.
16480     * @param func The function to call when the item is clicked.
16481     * @param data The data to associate with the item for related callbacks.
16482     *
16483     * @return The created item or @c NULL upon failure.
16484     *
16485     * A new item will be created and added to the list. Its position in
16486     * this list will be just before item @p before.
16487     *
16488     * Items created with this method can be deleted with
16489     * elm_list_item_del().
16490     *
16491     * Associated @p data can be properly freed when item is deleted if a
16492     * callback function is set with elm_list_item_del_cb_set().
16493     *
16494     * If a function is passed as argument, it will be called everytime this item
16495     * is selected, i.e., the user clicks over an unselected item.
16496     * If always select is enabled it will call this function every time
16497     * user clicks over an item (already selected or not).
16498     * If such function isn't needed, just passing
16499     * @c NULL as @p func is enough. The same should be done for @p data.
16500     *
16501     * @see elm_list_item_append() for a simple code example.
16502     * @see elm_list_always_select_mode_set()
16503     * @see elm_list_item_del()
16504     * @see elm_list_item_del_cb_set()
16505     * @see elm_list_clear()
16506     * @see elm_icon_add()
16507     *
16508     * @ingroup List
16509     */
16510    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);
16511
16512    /**
16513     * Insert a new item into the list object after item @p after.
16514     *
16515     * @param obj The list object.
16516     * @param after The list item to insert after.
16517     * @param label The label of the list item.
16518     * @param icon The icon object to use for the left side of the item. An
16519     * icon can be any Evas object, but usually it is an icon created
16520     * with elm_icon_add().
16521     * @param end The icon object to use for the right side of the item. An
16522     * icon can be any Evas object.
16523     * @param func The function to call when the item is clicked.
16524     * @param data The data to associate with the item for related callbacks.
16525     *
16526     * @return The created item or @c NULL upon failure.
16527     *
16528     * A new item will be created and added to the list. Its position in
16529     * this list will be just after item @p after.
16530     *
16531     * Items created with this method can be deleted with
16532     * elm_list_item_del().
16533     *
16534     * Associated @p data can be properly freed when item is deleted if a
16535     * callback function is set with elm_list_item_del_cb_set().
16536     *
16537     * If a function is passed as argument, it will be called everytime this item
16538     * is selected, i.e., the user clicks over an unselected item.
16539     * If always select is enabled it will call this function every time
16540     * user clicks over an item (already selected or not).
16541     * If such function isn't needed, just passing
16542     * @c NULL as @p func is enough. The same should be done for @p data.
16543     *
16544     * @see elm_list_item_append() for a simple code example.
16545     * @see elm_list_always_select_mode_set()
16546     * @see elm_list_item_del()
16547     * @see elm_list_item_del_cb_set()
16548     * @see elm_list_clear()
16549     * @see elm_icon_add()
16550     *
16551     * @ingroup List
16552     */
16553    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);
16554
16555    /**
16556     * Insert a new item into the sorted list object.
16557     *
16558     * @param obj The list object.
16559     * @param label The label of the list item.
16560     * @param icon The icon object to use for the left side of the item. An
16561     * icon can be any Evas object, but usually it is an icon created
16562     * with elm_icon_add().
16563     * @param end The icon object to use for the right side of the item. An
16564     * icon can be any Evas object.
16565     * @param func The function to call when the item is clicked.
16566     * @param data The data to associate with the item for related callbacks.
16567     * @param cmp_func The comparing function to be used to sort list
16568     * items <b>by #Elm_List_Item item handles</b>. This function will
16569     * receive two items and compare them, returning a non-negative integer
16570     * if the second item should be place after the first, or negative value
16571     * if should be placed before.
16572     *
16573     * @return The created item or @c NULL upon failure.
16574     *
16575     * @note This function inserts values into a list object assuming it was
16576     * sorted and the result will be sorted.
16577     *
16578     * A new item will be created and added to the list. Its position in
16579     * this list will be found comparing the new item with previously inserted
16580     * items using function @p cmp_func.
16581     *
16582     * Items created with this method can be deleted with
16583     * elm_list_item_del().
16584     *
16585     * Associated @p data can be properly freed when item is deleted if a
16586     * callback function is set with elm_list_item_del_cb_set().
16587     *
16588     * If a function is passed as argument, it will be called everytime this item
16589     * is selected, i.e., the user clicks over an unselected item.
16590     * If always select is enabled it will call this function every time
16591     * user clicks over an item (already selected or not).
16592     * If such function isn't needed, just passing
16593     * @c NULL as @p func is enough. The same should be done for @p data.
16594     *
16595     * @see elm_list_item_append() for a simple code example.
16596     * @see elm_list_always_select_mode_set()
16597     * @see elm_list_item_del()
16598     * @see elm_list_item_del_cb_set()
16599     * @see elm_list_clear()
16600     * @see elm_icon_add()
16601     *
16602     * @ingroup List
16603     */
16604    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);
16605
16606    /**
16607     * Remove all list's items.
16608     *
16609     * @param obj The list object
16610     *
16611     * @see elm_list_item_del()
16612     * @see elm_list_item_append()
16613     *
16614     * @ingroup List
16615     */
16616    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16617
16618    /**
16619     * Get a list of all the list items.
16620     *
16621     * @param obj The list object
16622     * @return An @c Eina_List of list items, #Elm_List_Item,
16623     * or @c NULL on failure.
16624     *
16625     * @see elm_list_item_append()
16626     * @see elm_list_item_del()
16627     * @see elm_list_clear()
16628     *
16629     * @ingroup List
16630     */
16631    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16632
16633    /**
16634     * Get the selected item.
16635     *
16636     * @param obj The list object.
16637     * @return The selected list item.
16638     *
16639     * The selected item can be unselected with function
16640     * elm_list_item_selected_set().
16641     *
16642     * The selected item always will be highlighted on list.
16643     *
16644     * @see elm_list_selected_items_get()
16645     *
16646     * @ingroup List
16647     */
16648    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16649
16650    /**
16651     * Return a list of the currently selected list items.
16652     *
16653     * @param obj The list object.
16654     * @return An @c Eina_List of list items, #Elm_List_Item,
16655     * or @c NULL on failure.
16656     *
16657     * Multiple items can be selected if multi select is enabled. It can be
16658     * done with elm_list_multi_select_set().
16659     *
16660     * @see elm_list_selected_item_get()
16661     * @see elm_list_multi_select_set()
16662     *
16663     * @ingroup List
16664     */
16665    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16666
16667    /**
16668     * Set the selected state of an item.
16669     *
16670     * @param item The list item
16671     * @param selected The selected state
16672     *
16673     * This sets the selected state of the given item @p it.
16674     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16675     *
16676     * If a new item is selected the previosly selected will be unselected,
16677     * unless multiple selection is enabled with elm_list_multi_select_set().
16678     * Previoulsy selected item can be get with function
16679     * elm_list_selected_item_get().
16680     *
16681     * Selected items will be highlighted.
16682     *
16683     * @see elm_list_item_selected_get()
16684     * @see elm_list_selected_item_get()
16685     * @see elm_list_multi_select_set()
16686     *
16687     * @ingroup List
16688     */
16689    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16690
16691    /*
16692     * Get whether the @p item is selected or not.
16693     *
16694     * @param item The list item.
16695     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16696     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16697     *
16698     * @see elm_list_selected_item_set() for details.
16699     * @see elm_list_item_selected_get()
16700     *
16701     * @ingroup List
16702     */
16703    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16704
16705    /**
16706     * Set or unset item as a separator.
16707     *
16708     * @param it The list item.
16709     * @param setting @c EINA_TRUE to set item @p it as separator or
16710     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16711     *
16712     * Items aren't set as separator by default.
16713     *
16714     * If set as separator it will display separator theme, so won't display
16715     * icons or label.
16716     *
16717     * @see elm_list_item_separator_get()
16718     *
16719     * @ingroup List
16720     */
16721    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16722
16723    /**
16724     * Get a value whether item is a separator or not.
16725     *
16726     * @see elm_list_item_separator_set() for details.
16727     *
16728     * @param it The list item.
16729     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16730     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16731     *
16732     * @ingroup List
16733     */
16734    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16735
16736    /**
16737     * Show @p item in the list view.
16738     *
16739     * @param item The list item to be shown.
16740     *
16741     * It won't animate list until item is visible. If such behavior is wanted,
16742     * use elm_list_bring_in() intead.
16743     *
16744     * @ingroup List
16745     */
16746    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16747
16748    /**
16749     * Bring in the given item to list view.
16750     *
16751     * @param item The item.
16752     *
16753     * This causes list to jump to the given item @p item and show it
16754     * (by scrolling), if it is not fully visible.
16755     *
16756     * This may use animation to do so and take a period of time.
16757     *
16758     * If animation isn't wanted, elm_list_item_show() can be used.
16759     *
16760     * @ingroup List
16761     */
16762    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16763
16764    /**
16765     * Delete them item from the list.
16766     *
16767     * @param item The item of list to be deleted.
16768     *
16769     * If deleting all list items is required, elm_list_clear()
16770     * should be used instead of getting items list and deleting each one.
16771     *
16772     * @see elm_list_clear()
16773     * @see elm_list_item_append()
16774     * @see elm_list_item_del_cb_set()
16775     *
16776     * @ingroup List
16777     */
16778    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16779
16780    /**
16781     * Set the function called when a list item is freed.
16782     *
16783     * @param item The item to set the callback on
16784     * @param func The function called
16785     *
16786     * If there is a @p func, then it will be called prior item's memory release.
16787     * That will be called with the following arguments:
16788     * @li item's data;
16789     * @li item's Evas object;
16790     * @li item itself;
16791     *
16792     * This way, a data associated to a list item could be properly freed.
16793     *
16794     * @ingroup List
16795     */
16796    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16797
16798    /**
16799     * Get the data associated to the item.
16800     *
16801     * @param item The list item
16802     * @return The data associated to @p item
16803     *
16804     * The return value is a pointer to data associated to @p item when it was
16805     * created, with function elm_list_item_append() or similar. If no data
16806     * was passed as argument, it will return @c NULL.
16807     *
16808     * @see elm_list_item_append()
16809     *
16810     * @ingroup List
16811     */
16812    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16813
16814    /**
16815     * Get the left side icon associated to the item.
16816     *
16817     * @param item The list item
16818     * @return The left side icon associated to @p item
16819     *
16820     * The return value is a pointer to the icon associated to @p item when
16821     * it was
16822     * created, with function elm_list_item_append() or similar, or later
16823     * with function elm_list_item_icon_set(). If no icon
16824     * was passed as argument, it will return @c NULL.
16825     *
16826     * @see elm_list_item_append()
16827     * @see elm_list_item_icon_set()
16828     *
16829     * @ingroup List
16830     */
16831    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16832
16833    /**
16834     * Set the left side icon associated to the item.
16835     *
16836     * @param item The list item
16837     * @param icon The left side icon object to associate with @p item
16838     *
16839     * The icon object to use at left side of the item. An
16840     * icon can be any Evas object, but usually it is an icon created
16841     * with elm_icon_add().
16842     *
16843     * Once the icon object is set, a previously set one will be deleted.
16844     * @warning Setting the same icon for two items will cause the icon to
16845     * dissapear from the first item.
16846     *
16847     * If an icon was passed as argument on item creation, with function
16848     * elm_list_item_append() or similar, it will be already
16849     * associated to the item.
16850     *
16851     * @see elm_list_item_append()
16852     * @see elm_list_item_icon_get()
16853     *
16854     * @ingroup List
16855     */
16856    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16857
16858    /**
16859     * Get the right side icon associated to the item.
16860     *
16861     * @param item The list item
16862     * @return The right side icon associated to @p item
16863     *
16864     * The return value is a pointer to the icon associated to @p item when
16865     * it was
16866     * created, with function elm_list_item_append() or similar, or later
16867     * with function elm_list_item_icon_set(). If no icon
16868     * was passed as argument, it will return @c NULL.
16869     *
16870     * @see elm_list_item_append()
16871     * @see elm_list_item_icon_set()
16872     *
16873     * @ingroup List
16874     */
16875    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16876
16877    /**
16878     * Set the right side icon associated to the item.
16879     *
16880     * @param item The list item
16881     * @param end The right side icon object to associate with @p item
16882     *
16883     * The icon object to use at right side of the item. An
16884     * icon can be any Evas object, but usually it is an icon created
16885     * with elm_icon_add().
16886     *
16887     * Once the icon object is set, a previously set one will be deleted.
16888     * @warning Setting the same icon for two items will cause the icon to
16889     * dissapear from the first item.
16890     *
16891     * If an icon was passed as argument on item creation, with function
16892     * elm_list_item_append() or similar, it will be already
16893     * associated to the item.
16894     *
16895     * @see elm_list_item_append()
16896     * @see elm_list_item_end_get()
16897     *
16898     * @ingroup List
16899     */
16900    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16901    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16902
16903    /**
16904     * Gets the base object of the item.
16905     *
16906     * @param item The list item
16907     * @return The base object associated with @p item
16908     *
16909     * Base object is the @c Evas_Object that represents that item.
16910     *
16911     * @ingroup List
16912     */
16913    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16914
16915    /**
16916     * Get the label of item.
16917     *
16918     * @param item The item of list.
16919     * @return The label of item.
16920     *
16921     * The return value is a pointer to the label associated to @p item when
16922     * it was created, with function elm_list_item_append(), or later
16923     * with function elm_list_item_label_set. If no label
16924     * was passed as argument, it will return @c NULL.
16925     *
16926     * @see elm_list_item_label_set() for more details.
16927     * @see elm_list_item_append()
16928     *
16929     * @ingroup List
16930     */
16931    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16932
16933    /**
16934     * Set the label of item.
16935     *
16936     * @param item The item of list.
16937     * @param text The label of item.
16938     *
16939     * The label to be displayed by the item.
16940     * Label will be placed between left and right side icons (if set).
16941     *
16942     * If a label was passed as argument on item creation, with function
16943     * elm_list_item_append() or similar, it will be already
16944     * displayed by the item.
16945     *
16946     * @see elm_list_item_label_get()
16947     * @see elm_list_item_append()
16948     *
16949     * @ingroup List
16950     */
16951    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16952
16953
16954    /**
16955     * Get the item before @p it in list.
16956     *
16957     * @param it The list item.
16958     * @return The item before @p it, or @c NULL if none or on failure.
16959     *
16960     * @note If it is the first item, @c NULL will be returned.
16961     *
16962     * @see elm_list_item_append()
16963     * @see elm_list_items_get()
16964     *
16965     * @ingroup List
16966     */
16967    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16968
16969    /**
16970     * Get the item after @p it in list.
16971     *
16972     * @param it The list item.
16973     * @return The item after @p it, or @c NULL if none or on failure.
16974     *
16975     * @note If it is the last item, @c NULL will be returned.
16976     *
16977     * @see elm_list_item_append()
16978     * @see elm_list_items_get()
16979     *
16980     * @ingroup List
16981     */
16982    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16983
16984    /**
16985     * Sets the disabled/enabled state of a list item.
16986     *
16987     * @param it The item.
16988     * @param disabled The disabled state.
16989     *
16990     * A disabled item cannot be selected or unselected. It will also
16991     * change its appearance (generally greyed out). This sets the
16992     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16993     * enabled).
16994     *
16995     * @ingroup List
16996     */
16997    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16998
16999    /**
17000     * Get a value whether list item is disabled or not.
17001     *
17002     * @param it The item.
17003     * @return The disabled state.
17004     *
17005     * @see elm_list_item_disabled_set() for more details.
17006     *
17007     * @ingroup List
17008     */
17009    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17010
17011    /**
17012     * Set the text to be shown in a given list item's tooltips.
17013     *
17014     * @param item Target item.
17015     * @param text The text to set in the content.
17016     *
17017     * Setup the text as tooltip to object. The item can have only one tooltip,
17018     * so any previous tooltip data - set with this function or
17019     * elm_list_item_tooltip_content_cb_set() - is removed.
17020     *
17021     * @see elm_object_tooltip_text_set() for more details.
17022     *
17023     * @ingroup List
17024     */
17025    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17026
17027
17028    /**
17029     * @brief Disable size restrictions on an object's tooltip
17030     * @param item The tooltip's anchor object
17031     * @param disable If EINA_TRUE, size restrictions are disabled
17032     * @return EINA_FALSE on failure, EINA_TRUE on success
17033     *
17034     * This function allows a tooltip to expand beyond its parant window's canvas.
17035     * It will instead be limited only by the size of the display.
17036     */
17037    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17038    /**
17039     * @brief Retrieve size restriction state of an object's tooltip
17040     * @param obj The tooltip's anchor object
17041     * @return If EINA_TRUE, size restrictions are disabled
17042     *
17043     * This function returns whether a tooltip is allowed to expand beyond
17044     * its parant window's canvas.
17045     * It will instead be limited only by the size of the display.
17046     */
17047    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17048
17049    /**
17050     * Set the content to be shown in the tooltip item.
17051     *
17052     * Setup the tooltip to item. The item can have only one tooltip,
17053     * so any previous tooltip data is removed. @p func(with @p data) will
17054     * be called every time that need show the tooltip and it should
17055     * return a valid Evas_Object. This object is then managed fully by
17056     * tooltip system and is deleted when the tooltip is gone.
17057     *
17058     * @param item the list item being attached a tooltip.
17059     * @param func the function used to create the tooltip contents.
17060     * @param data what to provide to @a func as callback data/context.
17061     * @param del_cb called when data is not needed anymore, either when
17062     *        another callback replaces @a func, the tooltip is unset with
17063     *        elm_list_item_tooltip_unset() or the owner @a item
17064     *        dies. This callback receives as the first parameter the
17065     *        given @a data, and @c event_info is the item.
17066     *
17067     * @see elm_object_tooltip_content_cb_set() for more details.
17068     *
17069     * @ingroup List
17070     */
17071    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);
17072
17073    /**
17074     * Unset tooltip from item.
17075     *
17076     * @param item list item to remove previously set tooltip.
17077     *
17078     * Remove tooltip from item. The callback provided as del_cb to
17079     * elm_list_item_tooltip_content_cb_set() will be called to notify
17080     * it is not used anymore.
17081     *
17082     * @see elm_object_tooltip_unset() for more details.
17083     * @see elm_list_item_tooltip_content_cb_set()
17084     *
17085     * @ingroup List
17086     */
17087    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17088
17089    /**
17090     * Sets a different style for this item tooltip.
17091     *
17092     * @note before you set a style you should define a tooltip with
17093     *       elm_list_item_tooltip_content_cb_set() or
17094     *       elm_list_item_tooltip_text_set()
17095     *
17096     * @param item list item with tooltip already set.
17097     * @param style the theme style to use (default, transparent, ...)
17098     *
17099     * @see elm_object_tooltip_style_set() for more details.
17100     *
17101     * @ingroup List
17102     */
17103    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17104
17105    /**
17106     * Get the style for this item tooltip.
17107     *
17108     * @param item list item with tooltip already set.
17109     * @return style the theme style in use, defaults to "default". If the
17110     *         object does not have a tooltip set, then NULL is returned.
17111     *
17112     * @see elm_object_tooltip_style_get() for more details.
17113     * @see elm_list_item_tooltip_style_set()
17114     *
17115     * @ingroup List
17116     */
17117    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17118
17119    /**
17120     * Set the type of mouse pointer/cursor decoration to be shown,
17121     * when the mouse pointer is over the given list widget item
17122     *
17123     * @param item list item to customize cursor on
17124     * @param cursor the cursor type's name
17125     *
17126     * This function works analogously as elm_object_cursor_set(), but
17127     * here the cursor's changing area is restricted to the item's
17128     * area, and not the whole widget's. Note that that item cursors
17129     * have precedence over widget cursors, so that a mouse over an
17130     * item with custom cursor set will always show @b that cursor.
17131     *
17132     * If this function is called twice for an object, a previously set
17133     * cursor will be unset on the second call.
17134     *
17135     * @see elm_object_cursor_set()
17136     * @see elm_list_item_cursor_get()
17137     * @see elm_list_item_cursor_unset()
17138     *
17139     * @ingroup List
17140     */
17141    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17142
17143    /*
17144     * Get the type of mouse pointer/cursor decoration set to be shown,
17145     * when the mouse pointer is over the given list widget item
17146     *
17147     * @param item list item with custom cursor set
17148     * @return the cursor type's name or @c NULL, if no custom cursors
17149     * were set to @p item (and on errors)
17150     *
17151     * @see elm_object_cursor_get()
17152     * @see elm_list_item_cursor_set()
17153     * @see elm_list_item_cursor_unset()
17154     *
17155     * @ingroup List
17156     */
17157    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17158
17159    /**
17160     * Unset any custom mouse pointer/cursor decoration set to be
17161     * shown, when the mouse pointer is over the given list widget
17162     * item, thus making it show the @b default cursor again.
17163     *
17164     * @param item a list item
17165     *
17166     * Use this call to undo any custom settings on this item's cursor
17167     * decoration, bringing it back to defaults (no custom style set).
17168     *
17169     * @see elm_object_cursor_unset()
17170     * @see elm_list_item_cursor_set()
17171     *
17172     * @ingroup List
17173     */
17174    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17175
17176    /**
17177     * Set a different @b style for a given custom cursor set for a
17178     * list item.
17179     *
17180     * @param item list item with custom cursor set
17181     * @param style the <b>theme style</b> to use (e.g. @c "default",
17182     * @c "transparent", etc)
17183     *
17184     * This function only makes sense when one is using custom mouse
17185     * cursor decorations <b>defined in a theme file</b>, which can have,
17186     * given a cursor name/type, <b>alternate styles</b> on it. It
17187     * works analogously as elm_object_cursor_style_set(), but here
17188     * applyed only to list item objects.
17189     *
17190     * @warning Before you set a cursor style you should have definen a
17191     *       custom cursor previously on the item, with
17192     *       elm_list_item_cursor_set()
17193     *
17194     * @see elm_list_item_cursor_engine_only_set()
17195     * @see elm_list_item_cursor_style_get()
17196     *
17197     * @ingroup List
17198     */
17199    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17200
17201    /**
17202     * Get the current @b style set for a given list item's custom
17203     * cursor
17204     *
17205     * @param item list item with custom cursor set.
17206     * @return style the cursor style in use. If the object does not
17207     *         have a cursor set, then @c NULL is returned.
17208     *
17209     * @see elm_list_item_cursor_style_set() for more details
17210     *
17211     * @ingroup List
17212     */
17213    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17214
17215    /**
17216     * Set if the (custom)cursor for a given list item should be
17217     * searched in its theme, also, or should only rely on the
17218     * rendering engine.
17219     *
17220     * @param item item with custom (custom) cursor already set on
17221     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17222     * only on those provided by the rendering engine, @c EINA_FALSE to
17223     * have them searched on the widget's theme, as well.
17224     *
17225     * @note This call is of use only if you've set a custom cursor
17226     * for list items, with elm_list_item_cursor_set().
17227     *
17228     * @note By default, cursors will only be looked for between those
17229     * provided by the rendering engine.
17230     *
17231     * @ingroup List
17232     */
17233    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17234
17235    /**
17236     * Get if the (custom) cursor for a given list item is being
17237     * searched in its theme, also, or is only relying on the rendering
17238     * engine.
17239     *
17240     * @param item a list item
17241     * @return @c EINA_TRUE, if cursors are being looked for only on
17242     * those provided by the rendering engine, @c EINA_FALSE if they
17243     * are being searched on the widget's theme, as well.
17244     *
17245     * @see elm_list_item_cursor_engine_only_set(), for more details
17246     *
17247     * @ingroup List
17248     */
17249    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17250
17251    /**
17252     * @}
17253     */
17254
17255    /**
17256     * @defgroup Slider Slider
17257     * @ingroup Elementary
17258     *
17259     * @image html img/widget/slider/preview-00.png
17260     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17261     *
17262     * The slider adds a dragable “slider” widget for selecting the value of
17263     * something within a range.
17264     *
17265     * A slider can be horizontal or vertical. It can contain an Icon and has a
17266     * primary label as well as a units label (that is formatted with floating
17267     * point values and thus accepts a printf-style format string, like
17268     * “%1.2f units”. There is also an indicator string that may be somewhere
17269     * else (like on the slider itself) that also accepts a format string like
17270     * units. Label, Icon Unit and Indicator strings/objects are optional.
17271     *
17272     * A slider may be inverted which means values invert, with high vales being
17273     * on the left or top and low values on the right or bottom (as opposed to
17274     * normally being low on the left or top and high on the bottom and right).
17275     *
17276     * The slider should have its minimum and maximum values set by the
17277     * application with  elm_slider_min_max_set() and value should also be set by
17278     * the application before use with  elm_slider_value_set(). The span of the
17279     * slider is its length (horizontally or vertically). This will be scaled by
17280     * the object or applications scaling factor. At any point code can query the
17281     * slider for its value with elm_slider_value_get().
17282     *
17283     * Smart callbacks one can listen to:
17284     * - "changed" - Whenever the slider value is changed by the user.
17285     * - "slider,drag,start" - dragging the slider indicator around has started.
17286     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17287     * - "delay,changed" - A short time after the value is changed by the user.
17288     * This will be called only when the user stops dragging for
17289     * a very short period or when they release their
17290     * finger/mouse, so it avoids possibly expensive reactions to
17291     * the value change.
17292     *
17293     * Available styles for it:
17294     * - @c "default"
17295     *
17296     * Default contents parts of the slider widget that you can use for are:
17297     * @li "elm.swallow.icon" - A icon of the slider
17298     * @li "elm.swallow.end" - A end part content of the slider
17299     * 
17300     * Here is an example on its usage:
17301     * @li @ref slider_example
17302     */
17303
17304 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17305 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17306
17307    /**
17308     * @addtogroup Slider
17309     * @{
17310     */
17311
17312    /**
17313     * Add a new slider widget to the given parent Elementary
17314     * (container) object.
17315     *
17316     * @param parent The parent object.
17317     * @return a new slider widget handle or @c NULL, on errors.
17318     *
17319     * This function inserts a new slider widget on the canvas.
17320     *
17321     * @ingroup Slider
17322     */
17323    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17324
17325    /**
17326     * Set the label of a given slider widget
17327     *
17328     * @param obj The progress bar object
17329     * @param label The text label string, in UTF-8
17330     *
17331     * @ingroup Slider
17332     * @deprecated use elm_object_text_set() instead.
17333     */
17334    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17335
17336    /**
17337     * Get the label of a given slider widget
17338     *
17339     * @param obj The progressbar object
17340     * @return The text label string, in UTF-8
17341     *
17342     * @ingroup Slider
17343     * @deprecated use elm_object_text_get() instead.
17344     */
17345    EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17346
17347    /**
17348     * Set the icon object of the slider object.
17349     *
17350     * @param obj The slider object.
17351     * @param icon The icon object.
17352     *
17353     * On horizontal mode, icon is placed at left, and on vertical mode,
17354     * placed at top.
17355     *
17356     * @note Once the icon object is set, a previously set one will be deleted.
17357     * If you want to keep that old content object, use the
17358     * elm_slider_icon_unset() function.
17359     *
17360     * @warning If the object being set does not have minimum size hints set,
17361     * it won't get properly displayed.
17362     *
17363     * @ingroup Slider
17364     * @deprecated use elm_object_content_set() instead.
17365     */
17366    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17367
17368    /**
17369     * Unset an icon set on a given slider widget.
17370     *
17371     * @param obj The slider object.
17372     * @return The icon object that was being used, if any was set, or
17373     * @c NULL, otherwise (and on errors).
17374     *
17375     * On horizontal mode, icon is placed at left, and on vertical mode,
17376     * placed at top.
17377     *
17378     * This call will unparent and return the icon object which was set
17379     * for this widget, previously, on success.
17380     *
17381     * @see elm_slider_icon_set() for more details
17382     * @see elm_slider_icon_get()
17383     * @deprecated use elm_object_content_unset() instead.
17384     *
17385     * @ingroup Slider
17386     */
17387    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17388
17389    /**
17390     * Retrieve the icon object set for a given slider widget.
17391     *
17392     * @param obj The slider object.
17393     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17394     * otherwise (and on errors).
17395     *
17396     * On horizontal mode, icon is placed at left, and on vertical mode,
17397     * placed at top.
17398     *
17399     * @see elm_slider_icon_set() for more details
17400     * @see elm_slider_icon_unset()
17401     *
17402     * @ingroup Slider
17403     */
17404    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17405
17406    /**
17407     * Set the end object of the slider object.
17408     *
17409     * @param obj The slider object.
17410     * @param end The end object.
17411     *
17412     * On horizontal mode, end is placed at left, and on vertical mode,
17413     * placed at bottom.
17414     *
17415     * @note Once the icon object is set, a previously set one will be deleted.
17416     * If you want to keep that old content object, use the
17417     * elm_slider_end_unset() function.
17418     *
17419     * @warning If the object being set does not have minimum size hints set,
17420     * it won't get properly displayed.
17421     *
17422     * @ingroup Slider
17423     */
17424    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17425
17426    /**
17427     * Unset an end object set on a given slider widget.
17428     *
17429     * @param obj The slider object.
17430     * @return The end object that was being used, if any was set, or
17431     * @c NULL, otherwise (and on errors).
17432     *
17433     * On horizontal mode, end is placed at left, and on vertical mode,
17434     * placed at bottom.
17435     *
17436     * This call will unparent and return the icon object which was set
17437     * for this widget, previously, on success.
17438     *
17439     * @see elm_slider_end_set() for more details.
17440     * @see elm_slider_end_get()
17441     *
17442     * @ingroup Slider
17443     */
17444    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17445
17446    /**
17447     * Retrieve the end object set for a given slider widget.
17448     *
17449     * @param obj The slider object.
17450     * @return The end object's handle, if @p obj had one set, or @c NULL,
17451     * otherwise (and on errors).
17452     *
17453     * On horizontal mode, icon is placed at right, and on vertical mode,
17454     * placed at bottom.
17455     *
17456     * @see elm_slider_end_set() for more details.
17457     * @see elm_slider_end_unset()
17458     *
17459     * @ingroup Slider
17460     */
17461    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17462
17463    /**
17464     * Set the (exact) length of the bar region of a given slider widget.
17465     *
17466     * @param obj The slider object.
17467     * @param size The length of the slider's bar region.
17468     *
17469     * This sets the minimum width (when in horizontal mode) or height
17470     * (when in vertical mode) of the actual bar area of the slider
17471     * @p obj. This in turn affects the object's minimum size. Use
17472     * this when you're not setting other size hints expanding on the
17473     * given direction (like weight and alignment hints) and you would
17474     * like it to have a specific size.
17475     *
17476     * @note Icon, end, label, indicator and unit text around @p obj
17477     * will require their
17478     * own space, which will make @p obj to require more the @p size,
17479     * actually.
17480     *
17481     * @see elm_slider_span_size_get()
17482     *
17483     * @ingroup Slider
17484     */
17485    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17486
17487    /**
17488     * Get the length set for the bar region of a given slider widget
17489     *
17490     * @param obj The slider object.
17491     * @return The length of the slider's bar region.
17492     *
17493     * If that size was not set previously, with
17494     * elm_slider_span_size_set(), this call will return @c 0.
17495     *
17496     * @ingroup Slider
17497     */
17498    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17499
17500    /**
17501     * Set the format string for the unit label.
17502     *
17503     * @param obj The slider object.
17504     * @param format The format string for the unit display.
17505     *
17506     * Unit label is displayed all the time, if set, after slider's bar.
17507     * In horizontal mode, at right and in vertical mode, at bottom.
17508     *
17509     * If @c NULL, unit label won't be visible. If not it sets the format
17510     * string for the label text. To the label text is provided a floating point
17511     * value, so the label text can display up to 1 floating point value.
17512     * Note that this is optional.
17513     *
17514     * Use a format string such as "%1.2f meters" for example, and it will
17515     * display values like: "3.14 meters" for a value equal to 3.14159.
17516     *
17517     * Default is unit label disabled.
17518     *
17519     * @see elm_slider_indicator_format_get()
17520     *
17521     * @ingroup Slider
17522     */
17523    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17524
17525    /**
17526     * Get the unit label format of the slider.
17527     *
17528     * @param obj The slider object.
17529     * @return The unit label format string in UTF-8.
17530     *
17531     * Unit label is displayed all the time, if set, after slider's bar.
17532     * In horizontal mode, at right and in vertical mode, at bottom.
17533     *
17534     * @see elm_slider_unit_format_set() for more
17535     * information on how this works.
17536     *
17537     * @ingroup Slider
17538     */
17539    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17540
17541    /**
17542     * Set the format string for the indicator label.
17543     *
17544     * @param obj The slider object.
17545     * @param indicator The format string for the indicator display.
17546     *
17547     * The slider may display its value somewhere else then unit label,
17548     * for example, above the slider knob that is dragged around. This function
17549     * sets the format string used for this.
17550     *
17551     * If @c NULL, indicator label won't be visible. If not it sets the format
17552     * string for the label text. To the label text is provided a floating point
17553     * value, so the label text can display up to 1 floating point value.
17554     * Note that this is optional.
17555     *
17556     * Use a format string such as "%1.2f meters" for example, and it will
17557     * display values like: "3.14 meters" for a value equal to 3.14159.
17558     *
17559     * Default is indicator label disabled.
17560     *
17561     * @see elm_slider_indicator_format_get()
17562     *
17563     * @ingroup Slider
17564     */
17565    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17566
17567    /**
17568     * Get the indicator label format of the slider.
17569     *
17570     * @param obj The slider object.
17571     * @return The indicator label format string in UTF-8.
17572     *
17573     * The slider may display its value somewhere else then unit label,
17574     * for example, above the slider knob that is dragged around. This function
17575     * gets the format string used for this.
17576     *
17577     * @see elm_slider_indicator_format_set() for more
17578     * information on how this works.
17579     *
17580     * @ingroup Slider
17581     */
17582    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17583
17584    /**
17585     * Set the format function pointer for the indicator label
17586     *
17587     * @param obj The slider object.
17588     * @param func The indicator format function.
17589     * @param free_func The freeing function for the format string.
17590     *
17591     * Set the callback function to format the indicator string.
17592     *
17593     * @see elm_slider_indicator_format_set() for more info on how this works.
17594     *
17595     * @ingroup Slider
17596     */
17597   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);
17598
17599   /**
17600    * Set the format function pointer for the units label
17601    *
17602    * @param obj The slider object.
17603    * @param func The units format function.
17604    * @param free_func The freeing function for the format string.
17605    *
17606    * Set the callback function to format the indicator string.
17607    *
17608    * @see elm_slider_units_format_set() for more info on how this works.
17609    *
17610    * @ingroup Slider
17611    */
17612   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);
17613
17614   /**
17615    * Set the orientation of a given slider widget.
17616    *
17617    * @param obj The slider object.
17618    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17619    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17620    *
17621    * Use this function to change how your slider is to be
17622    * disposed: vertically or horizontally.
17623    *
17624    * By default it's displayed horizontally.
17625    *
17626    * @see elm_slider_horizontal_get()
17627    *
17628    * @ingroup Slider
17629    */
17630    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17631
17632    /**
17633     * Retrieve the orientation of a given slider widget
17634     *
17635     * @param obj The slider object.
17636     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17637     * @c EINA_FALSE if it's @b vertical (and on errors).
17638     *
17639     * @see elm_slider_horizontal_set() for more details.
17640     *
17641     * @ingroup Slider
17642     */
17643    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17644
17645    /**
17646     * Set the minimum and maximum values for the slider.
17647     *
17648     * @param obj The slider object.
17649     * @param min The minimum value.
17650     * @param max The maximum value.
17651     *
17652     * Define the allowed range of values to be selected by the user.
17653     *
17654     * If actual value is less than @p min, it will be updated to @p min. If it
17655     * is bigger then @p max, will be updated to @p max. Actual value can be
17656     * get with elm_slider_value_get().
17657     *
17658     * By default, min is equal to 0.0, and max is equal to 1.0.
17659     *
17660     * @warning Maximum must be greater than minimum, otherwise behavior
17661     * is undefined.
17662     *
17663     * @see elm_slider_min_max_get()
17664     *
17665     * @ingroup Slider
17666     */
17667    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17668
17669    /**
17670     * Get the minimum and maximum values of the slider.
17671     *
17672     * @param obj The slider object.
17673     * @param min Pointer where to store the minimum value.
17674     * @param max Pointer where to store the maximum value.
17675     *
17676     * @note If only one value is needed, the other pointer can be passed
17677     * as @c NULL.
17678     *
17679     * @see elm_slider_min_max_set() for details.
17680     *
17681     * @ingroup Slider
17682     */
17683    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17684
17685    /**
17686     * Set the value the slider displays.
17687     *
17688     * @param obj The slider object.
17689     * @param val The value to be displayed.
17690     *
17691     * Value will be presented on the unit label following format specified with
17692     * elm_slider_unit_format_set() and on indicator with
17693     * elm_slider_indicator_format_set().
17694     *
17695     * @warning The value must to be between min and max values. This values
17696     * are set by elm_slider_min_max_set().
17697     *
17698     * @see elm_slider_value_get()
17699     * @see elm_slider_unit_format_set()
17700     * @see elm_slider_indicator_format_set()
17701     * @see elm_slider_min_max_set()
17702     *
17703     * @ingroup Slider
17704     */
17705    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17706
17707    /**
17708     * Get the value displayed by the spinner.
17709     *
17710     * @param obj The spinner object.
17711     * @return The value displayed.
17712     *
17713     * @see elm_spinner_value_set() for details.
17714     *
17715     * @ingroup Slider
17716     */
17717    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17718
17719    /**
17720     * Invert a given slider widget's displaying values order
17721     *
17722     * @param obj The slider object.
17723     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17724     * @c EINA_FALSE to bring it back to default, non-inverted values.
17725     *
17726     * A slider may be @b inverted, in which state it gets its
17727     * values inverted, with high vales being on the left or top and
17728     * low values on the right or bottom, as opposed to normally have
17729     * the low values on the former and high values on the latter,
17730     * respectively, for horizontal and vertical modes.
17731     *
17732     * @see elm_slider_inverted_get()
17733     *
17734     * @ingroup Slider
17735     */
17736    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17737
17738    /**
17739     * Get whether a given slider widget's displaying values are
17740     * inverted or not.
17741     *
17742     * @param obj The slider object.
17743     * @return @c EINA_TRUE, if @p obj has inverted values,
17744     * @c EINA_FALSE otherwise (and on errors).
17745     *
17746     * @see elm_slider_inverted_set() for more details.
17747     *
17748     * @ingroup Slider
17749     */
17750    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17751
17752    /**
17753     * Set whether to enlarge slider indicator (augmented knob) or not.
17754     *
17755     * @param obj The slider object.
17756     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17757     * let the knob always at default size.
17758     *
17759     * By default, indicator will be bigger while dragged by the user.
17760     *
17761     * @warning It won't display values set with
17762     * elm_slider_indicator_format_set() if you disable indicator.
17763     *
17764     * @ingroup Slider
17765     */
17766    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17767
17768    /**
17769     * Get whether a given slider widget's enlarging indicator or not.
17770     *
17771     * @param obj The slider object.
17772     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17773     * @c EINA_FALSE otherwise (and on errors).
17774     *
17775     * @see elm_slider_indicator_show_set() for details.
17776     *
17777     * @ingroup Slider
17778     */
17779    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17780
17781    /**
17782     * @}
17783     */
17784
17785    /**
17786     * @addtogroup Actionslider Actionslider
17787     *
17788     * @image html img/widget/actionslider/preview-00.png
17789     * @image latex img/widget/actionslider/preview-00.eps
17790     *
17791     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17792     * properties. The user drags and releases the indicator, to choose a label.
17793     *
17794     * Labels occupy the following positions.
17795     * a. Left
17796     * b. Right
17797     * c. Center
17798     *
17799     * Positions can be enabled or disabled.
17800     *
17801     * Magnets can be set on the above positions.
17802     *
17803     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17804     *
17805     * @note By default all positions are set as enabled.
17806     *
17807     * Signals that you can add callbacks for are:
17808     *
17809     * "selected" - when user selects an enabled position (the label is passed
17810     *              as event info)".
17811     * @n
17812     * "pos_changed" - when the indicator reaches any of the positions("left",
17813     *                 "right" or "center").
17814     *
17815     * See an example of actionslider usage @ref actionslider_example_page "here"
17816     * @{
17817     */
17818
17819    typedef enum _Elm_Actionslider_Indicator_Pos
17820      {
17821         ELM_ACTIONSLIDER_INDICATOR_NONE,
17822         ELM_ACTIONSLIDER_INDICATOR_LEFT,
17823         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17824         ELM_ACTIONSLIDER_INDICATOR_CENTER
17825      } Elm_Actionslider_Indicator_Pos;
17826
17827    typedef enum _Elm_Actionslider_Magnet_Pos
17828      {
17829         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17830         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17831         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17832         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17833         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17834         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17835      } Elm_Actionslider_Magnet_Pos;
17836
17837    typedef enum _Elm_Actionslider_Label_Pos
17838      {
17839         ELM_ACTIONSLIDER_LABEL_LEFT,
17840         ELM_ACTIONSLIDER_LABEL_RIGHT,
17841         ELM_ACTIONSLIDER_LABEL_CENTER,
17842         ELM_ACTIONSLIDER_LABEL_BUTTON
17843      } Elm_Actionslider_Label_Pos;
17844
17845    /* smart callbacks called:
17846     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17847     */
17848
17849    /**
17850     * Add a new actionslider to the parent.
17851     *
17852     * @param parent The parent object
17853     * @return The new actionslider object or NULL if it cannot be created
17854     */
17855    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17856
17857    /**
17858    * Set actionslider label.
17859    *
17860    * @param[in] obj The actionslider object
17861    * @param[in] pos The position of the label.
17862    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17863    * @param label The label which is going to be set.
17864    */
17865    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17866    /**
17867     * Get actionslider labels.
17868     *
17869     * @param obj The actionslider object
17870     * @param left_label A char** to place the left_label of @p obj into.
17871     * @param center_label A char** to place the center_label of @p obj into.
17872     * @param right_label A char** to place the right_label of @p obj into.
17873     */
17874    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);
17875    /**
17876     * Get actionslider selected label.
17877     *
17878     * @param obj The actionslider object
17879     * @return The selected label
17880     */
17881    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17882    /**
17883     * Set actionslider indicator position.
17884     *
17885     * @param obj The actionslider object.
17886     * @param pos The position of the indicator.
17887     */
17888    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17889    /**
17890     * Get actionslider indicator position.
17891     *
17892     * @param obj The actionslider object.
17893     * @return The position of the indicator.
17894     */
17895    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17896    /**
17897     * Set actionslider magnet position. To make multiple positions magnets @c or
17898     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17899     *
17900     * @param obj The actionslider object.
17901     * @param pos Bit mask indicating the magnet positions.
17902     */
17903    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17904    /**
17905     * Get actionslider magnet position.
17906     *
17907     * @param obj The actionslider object.
17908     * @return The positions with magnet property.
17909     */
17910    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17911    /**
17912     * Set actionslider enabled position. To set multiple positions as enabled @c or
17913     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17914     *
17915     * @note All the positions are enabled by default.
17916     *
17917     * @param obj The actionslider object.
17918     * @param pos Bit mask indicating the enabled positions.
17919     */
17920    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17921    /**
17922     * Get actionslider enabled position.
17923     *
17924     * @param obj The actionslider object.
17925     * @return The enabled positions.
17926     */
17927    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17928    /**
17929     * Set the label used on the indicator.
17930     *
17931     * @param obj The actionslider object
17932     * @param label The label to be set on the indicator.
17933     * @deprecated use elm_object_text_set() instead.
17934     */
17935    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17936    /**
17937     * Get the label used on the indicator object.
17938     *
17939     * @param obj The actionslider object
17940     * @return The indicator label
17941     * @deprecated use elm_object_text_get() instead.
17942     */
17943    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17944
17945    /**
17946    * Hold actionslider object movement.
17947    *
17948    * @param[in] obj The actionslider object
17949    * @param[in] flag Actionslider hold/release
17950    * (EINA_TURE = hold/EIN_FALSE = release)
17951    *
17952    * @ingroup Actionslider
17953    */
17954    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17955
17956
17957    /**
17958     *
17959     */
17960
17961    /**
17962     * @defgroup Genlist Genlist
17963     *
17964     * @image html img/widget/genlist/preview-00.png
17965     * @image latex img/widget/genlist/preview-00.eps
17966     * @image html img/genlist.png
17967     * @image latex img/genlist.eps
17968     *
17969     * This widget aims to have more expansive list than the simple list in
17970     * Elementary that could have more flexible items and allow many more entries
17971     * while still being fast and low on memory usage. At the same time it was
17972     * also made to be able to do tree structures. But the price to pay is more
17973     * complexity when it comes to usage. If all you want is a simple list with
17974     * icons and a single label, use the normal @ref List object.
17975     *
17976     * Genlist has a fairly large API, mostly because it's relatively complex,
17977     * trying to be both expansive, powerful and efficient. First we will begin
17978     * an overview on the theory behind genlist.
17979     *
17980     * @section Genlist_Item_Class Genlist item classes - creating items
17981     *
17982     * In order to have the ability to add and delete items on the fly, genlist
17983     * implements a class (callback) system where the application provides a
17984     * structure with information about that type of item (genlist may contain
17985     * multiple different items with different classes, states and styles).
17986     * Genlist will call the functions in this struct (methods) when an item is
17987     * "realized" (i.e., created dynamically, while the user is scrolling the
17988     * grid). All objects will simply be deleted when no longer needed with
17989     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17990     * following members:
17991     * - @c item_style - This is a constant string and simply defines the name
17992     *   of the item style. It @b must be specified and the default should be @c
17993     *   "default".
17994     *
17995     * - @c func - A struct with pointers to functions that will be called when
17996     *   an item is going to be actually created. All of them receive a @c data
17997     *   parameter that will point to the same data passed to
17998     *   elm_genlist_item_append() and related item creation functions, and a @c
17999     *   obj parameter that points to the genlist object itself.
18000     *
18001     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18002     * state_get and @c del. The 3 first functions also receive a @c part
18003     * parameter described below. A brief description of these functions follows:
18004     *
18005     * - @c label_get - The @c part parameter is the name string of one of the
18006     *   existing text parts in the Edje group implementing the item's theme.
18007     *   This function @b must return a strdup'()ed string, as the caller will
18008     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18009     * - @c content_get - The @c part parameter is the name string of one of the
18010     *   existing (content) swallow parts in the Edje group implementing the item's
18011     *   theme. It must return @c NULL, when no content is desired, or a valid
18012     *   object handle, otherwise.  The object will be deleted by the genlist on
18013     *   its deletion or when the item is "unrealized".  See
18014     *   #Elm_Genlist_Item_Icon_Get_Cb.
18015     * - @c func.state_get - The @c part parameter is the name string of one of
18016     *   the state parts in the Edje group implementing the item's theme. Return
18017     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18018     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18019     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18020     *   the state is true (the default is false), where @c XXX is the name of
18021     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18022     * - @c func.del - This is intended for use when genlist items are deleted,
18023     *   so any data attached to the item (e.g. its data parameter on creation)
18024     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18025     *
18026     * available item styles:
18027     * - default
18028     * - default_style - The text part is a textblock
18029     *
18030     * @image html img/widget/genlist/preview-04.png
18031     * @image latex img/widget/genlist/preview-04.eps
18032     *
18033     * - double_label
18034     *
18035     * @image html img/widget/genlist/preview-01.png
18036     * @image latex img/widget/genlist/preview-01.eps
18037     *
18038     * - icon_top_text_bottom
18039     *
18040     * @image html img/widget/genlist/preview-02.png
18041     * @image latex img/widget/genlist/preview-02.eps
18042     *
18043     * - group_index
18044     *
18045     * @image html img/widget/genlist/preview-03.png
18046     * @image latex img/widget/genlist/preview-03.eps
18047     *
18048     * @section Genlist_Items Structure of items
18049     *
18050     * An item in a genlist can have 0 or more text labels (they can be regular
18051     * text or textblock Evas objects - that's up to the style to determine), 0
18052     * or more contents (which are simply objects swallowed into the genlist item's
18053     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18054     * behavior left to the user to define. The Edje part names for each of
18055     * these properties will be looked up, in the theme file for the genlist,
18056     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18057     * "states", respectively. For each of those properties, if more than one
18058     * part is provided, they must have names listed separated by spaces in the
18059     * data fields. For the default genlist item theme, we have @b one label
18060     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18061     * "elm.swallow.end") and @b no state parts.
18062     *
18063     * A genlist item may be at one of several styles. Elementary provides one
18064     * by default - "default", but this can be extended by system or application
18065     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18066     * details).
18067     *
18068     * @section Genlist_Manipulation Editing and Navigating
18069     *
18070     * Items can be added by several calls. All of them return a @ref
18071     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18072     * They all take a data parameter that is meant to be used for a handle to
18073     * the applications internal data (eg the struct with the original item
18074     * data). The parent parameter is the parent genlist item this belongs to if
18075     * it is a tree or an indexed group, and NULL if there is no parent. The
18076     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18077     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18078     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18079     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18080     * is set then this item is group index item that is displayed at the top
18081     * until the next group comes. The func parameter is a convenience callback
18082     * that is called when the item is selected and the data parameter will be
18083     * the func_data parameter, obj be the genlist object and event_info will be
18084     * the genlist item.
18085     *
18086     * elm_genlist_item_append() adds an item to the end of the list, or if
18087     * there is a parent, to the end of all the child items of the parent.
18088     * elm_genlist_item_prepend() is the same but adds to the beginning of
18089     * the list or children list. elm_genlist_item_insert_before() inserts at
18090     * item before another item and elm_genlist_item_insert_after() inserts after
18091     * the indicated item.
18092     *
18093     * The application can clear the list with elm_genlist_clear() which deletes
18094     * all the items in the list and elm_genlist_item_del() will delete a specific
18095     * item. elm_genlist_item_subitems_clear() will clear all items that are
18096     * children of the indicated parent item.
18097     *
18098     * To help inspect list items you can jump to the item at the top of the list
18099     * with elm_genlist_first_item_get() which will return the item pointer, and
18100     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18101     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18102     * and previous items respectively relative to the indicated item. Using
18103     * these calls you can walk the entire item list/tree. Note that as a tree
18104     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18105     * let you know which item is the parent (and thus know how to skip them if
18106     * wanted).
18107     *
18108     * @section Genlist_Muti_Selection Multi-selection
18109     *
18110     * If the application wants multiple items to be able to be selected,
18111     * elm_genlist_multi_select_set() can enable this. If the list is
18112     * single-selection only (the default), then elm_genlist_selected_item_get()
18113     * will return the selected item, if any, or NULL I none is selected. If the
18114     * list is multi-select then elm_genlist_selected_items_get() will return a
18115     * list (that is only valid as long as no items are modified (added, deleted,
18116     * selected or unselected)).
18117     *
18118     * @section Genlist_Usage_Hints Usage hints
18119     *
18120     * There are also convenience functions. elm_genlist_item_genlist_get() will
18121     * return the genlist object the item belongs to. elm_genlist_item_show()
18122     * will make the scroller scroll to show that specific item so its visible.
18123     * elm_genlist_item_data_get() returns the data pointer set by the item
18124     * creation functions.
18125     *
18126     * If an item changes (state of boolean changes, label or contents change),
18127     * then use elm_genlist_item_update() to have genlist update the item with
18128     * the new state. Genlist will re-realize the item thus call the functions
18129     * in the _Elm_Genlist_Item_Class for that item.
18130     *
18131     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18132     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18133     * to expand/contract an item and get its expanded state, use
18134     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18135     * again to make an item disabled (unable to be selected and appear
18136     * differently) use elm_genlist_item_disabled_set() to set this and
18137     * elm_genlist_item_disabled_get() to get the disabled state.
18138     *
18139     * In general to indicate how the genlist should expand items horizontally to
18140     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18141     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18142     * mode means that if items are too wide to fit, the scroller will scroll
18143     * horizontally. Otherwise items are expanded to fill the width of the
18144     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18145     * to the viewport width and limited to that size. This can be combined with
18146     * a different style that uses edjes' ellipsis feature (cutting text off like
18147     * this: "tex...").
18148     *
18149     * Items will only call their selection func and callback when first becoming
18150     * selected. Any further clicks will do nothing, unless you enable always
18151     * select with elm_genlist_always_select_mode_set(). This means even if
18152     * selected, every click will make the selected callbacks be called.
18153     * elm_genlist_no_select_mode_set() will turn off the ability to select
18154     * items entirely and they will neither appear selected nor call selected
18155     * callback functions.
18156     *
18157     * Remember that you can create new styles and add your own theme augmentation
18158     * per application with elm_theme_extension_add(). If you absolutely must
18159     * have a specific style that overrides any theme the user or system sets up
18160     * you can use elm_theme_overlay_add() to add such a file.
18161     *
18162     * @section Genlist_Implementation Implementation
18163     *
18164     * Evas tracks every object you create. Every time it processes an event
18165     * (mouse move, down, up etc.) it needs to walk through objects and find out
18166     * what event that affects. Even worse every time it renders display updates,
18167     * in order to just calculate what to re-draw, it needs to walk through many
18168     * many many objects. Thus, the more objects you keep active, the more
18169     * overhead Evas has in just doing its work. It is advisable to keep your
18170     * active objects to the minimum working set you need. Also remember that
18171     * object creation and deletion carries an overhead, so there is a
18172     * middle-ground, which is not easily determined. But don't keep massive lists
18173     * of objects you can't see or use. Genlist does this with list objects. It
18174     * creates and destroys them dynamically as you scroll around. It groups them
18175     * into blocks so it can determine the visibility etc. of a whole block at
18176     * once as opposed to having to walk the whole list. This 2-level list allows
18177     * for very large numbers of items to be in the list (tests have used up to
18178     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18179     * may be different sizes, every item added needs to be calculated as to its
18180     * size and thus this presents a lot of overhead on populating the list, this
18181     * genlist employs a queue. Any item added is queued and spooled off over
18182     * time, actually appearing some time later, so if your list has many members
18183     * you may find it takes a while for them to all appear, with your process
18184     * consuming a lot of CPU while it is busy spooling.
18185     *
18186     * Genlist also implements a tree structure, but it does so with callbacks to
18187     * the application, with the application filling in tree structures when
18188     * requested (allowing for efficient building of a very deep tree that could
18189     * even be used for file-management). See the above smart signal callbacks for
18190     * details.
18191     *
18192     * @section Genlist_Smart_Events Genlist smart events
18193     *
18194     * Signals that you can add callbacks for are:
18195     * - @c "activated" - The user has double-clicked or pressed
18196     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18197     *   item that was activated.
18198     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18199     *   event_info parameter is the item that was double-clicked.
18200     * - @c "selected" - This is called when a user has made an item selected.
18201     *   The event_info parameter is the genlist item that was selected.
18202     * - @c "unselected" - This is called when a user has made an item
18203     *   unselected. The event_info parameter is the genlist item that was
18204     *   unselected.
18205     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18206     *   called and the item is now meant to be expanded. The event_info
18207     *   parameter is the genlist item that was indicated to expand.  It is the
18208     *   job of this callback to then fill in the child items.
18209     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18210     *   called and the item is now meant to be contracted. The event_info
18211     *   parameter is the genlist item that was indicated to contract. It is the
18212     *   job of this callback to then delete the child items.
18213     * - @c "expand,request" - This is called when a user has indicated they want
18214     *   to expand a tree branch item. The callback should decide if the item can
18215     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18216     *   appropriately to set the state. The event_info parameter is the genlist
18217     *   item that was indicated to expand.
18218     * - @c "contract,request" - This is called when a user has indicated they
18219     *   want to contract a tree branch item. The callback should decide if the
18220     *   item can contract (has any children) and then call
18221     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18222     *   event_info parameter is the genlist item that was indicated to contract.
18223     * - @c "realized" - This is called when the item in the list is created as a
18224     *   real evas object. event_info parameter is the genlist item that was
18225     *   created. The object may be deleted at any time, so it is up to the
18226     *   caller to not use the object pointer from elm_genlist_item_object_get()
18227     *   in a way where it may point to freed objects.
18228     * - @c "unrealized" - This is called just before an item is unrealized.
18229     *   After this call content objects provided will be deleted and the item
18230     *   object itself delete or be put into a floating cache.
18231     * - @c "drag,start,up" - This is called when the item in the list has been
18232     *   dragged (not scrolled) up.
18233     * - @c "drag,start,down" - This is called when the item in the list has been
18234     *   dragged (not scrolled) down.
18235     * - @c "drag,start,left" - This is called when the item in the list has been
18236     *   dragged (not scrolled) left.
18237     * - @c "drag,start,right" - This is called when the item in the list has
18238     *   been dragged (not scrolled) right.
18239     * - @c "drag,stop" - This is called when the item in the list has stopped
18240     *   being dragged.
18241     * - @c "drag" - This is called when the item in the list is being dragged.
18242     * - @c "longpressed" - This is called when the item is pressed for a certain
18243     *   amount of time. By default it's 1 second.
18244     * - @c "scroll,anim,start" - This is called when scrolling animation has
18245     *   started.
18246     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18247     *   stopped.
18248     * - @c "scroll,drag,start" - This is called when dragging the content has
18249     *   started.
18250     * - @c "scroll,drag,stop" - This is called when dragging the content has
18251     *   stopped.
18252     * - @c "edge,top" - This is called when the genlist is scrolled until
18253     *   the top edge.
18254     * - @c "edge,bottom" - This is called when the genlist is scrolled
18255     *   until the bottom edge.
18256     * - @c "edge,left" - This is called when the genlist is scrolled
18257     *   until the left edge.
18258     * - @c "edge,right" - This is called when the genlist is scrolled
18259     *   until the right edge.
18260     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18261     *   swiped left.
18262     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18263     *   swiped right.
18264     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18265     *   swiped up.
18266     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18267     *   swiped down.
18268     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18269     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18270     *   multi-touch pinched in.
18271     * - @c "swipe" - This is called when the genlist is swiped.
18272     * - @c "moved" - This is called when a genlist item is moved.
18273     * - @c "language,changed" - This is called when the program's language is
18274     *   changed.
18275     *
18276     * @section Genlist_Examples Examples
18277     *
18278     * Here is a list of examples that use the genlist, trying to show some of
18279     * its capabilities:
18280     * - @ref genlist_example_01
18281     * - @ref genlist_example_02
18282     * - @ref genlist_example_03
18283     * - @ref genlist_example_04
18284     * - @ref genlist_example_05
18285     */
18286
18287    /**
18288     * @addtogroup Genlist
18289     * @{
18290     */
18291
18292    /**
18293     * @enum _Elm_Genlist_Item_Flags
18294     * @typedef Elm_Genlist_Item_Flags
18295     *
18296     * Defines if the item is of any special type (has subitems or it's the
18297     * index of a group), or is just a simple item.
18298     *
18299     * @ingroup Genlist
18300     */
18301    typedef enum _Elm_Genlist_Item_Flags
18302      {
18303         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18304         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18305         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18306      } Elm_Genlist_Item_Flags;
18307    typedef enum _Elm_Genlist_Item_Field_Flags
18308      {
18309         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18310         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18311         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18312         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18313      } Elm_Genlist_Item_Field_Flags;
18314    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18315    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18316    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18317    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18318    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
18319    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18320    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
18321    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18322
18323    /**
18324     * @struct _Elm_Genlist_Item_Class
18325     *
18326     * Genlist item class definition structs.
18327     *
18328     * This struct contains the style and fetching functions that will define the
18329     * contents of each item.
18330     *
18331     * @see @ref Genlist_Item_Class
18332     */
18333    struct _Elm_Genlist_Item_Class
18334      {
18335         const char                *item_style;
18336         struct {
18337           GenlistItemLabelGetFunc  label_get;
18338           GenlistItemIconGetFunc   icon_get;
18339           GenlistItemStateGetFunc  state_get;
18340           GenlistItemDelFunc       del;
18341           GenlistItemMovedFunc     moved;
18342         } func;
18343         const char *edit_item_style;
18344         const char                *mode_item_style;
18345      };
18346    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18347    /**
18348     * Add a new genlist widget to the given parent Elementary
18349     * (container) object
18350     *
18351     * @param parent The parent object
18352     * @return a new genlist widget handle or @c NULL, on errors
18353     *
18354     * This function inserts a new genlist widget on the canvas.
18355     *
18356     * @see elm_genlist_item_append()
18357     * @see elm_genlist_item_del()
18358     * @see elm_genlist_clear()
18359     *
18360     * @ingroup Genlist
18361     */
18362    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18363    /**
18364     * Remove all items from a given genlist widget.
18365     *
18366     * @param obj The genlist object
18367     *
18368     * This removes (and deletes) all items in @p obj, leaving it empty.
18369     *
18370     * @see elm_genlist_item_del(), to remove just one item.
18371     *
18372     * @ingroup Genlist
18373     */
18374    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18375    /**
18376     * Enable or disable multi-selection in the genlist
18377     *
18378     * @param obj The genlist object
18379     * @param multi Multi-select enable/disable. Default is disabled.
18380     *
18381     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18382     * the list. This allows more than 1 item to be selected. To retrieve the list
18383     * of selected items, use elm_genlist_selected_items_get().
18384     *
18385     * @see elm_genlist_selected_items_get()
18386     * @see elm_genlist_multi_select_get()
18387     *
18388     * @ingroup Genlist
18389     */
18390    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18391    /**
18392     * Gets if multi-selection in genlist is enabled or disabled.
18393     *
18394     * @param obj The genlist object
18395     * @return Multi-select enabled/disabled
18396     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18397     *
18398     * @see elm_genlist_multi_select_set()
18399     *
18400     * @ingroup Genlist
18401     */
18402    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18403    /**
18404     * This sets the horizontal stretching mode.
18405     *
18406     * @param obj The genlist object
18407     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18408     *
18409     * This sets the mode used for sizing items horizontally. Valid modes
18410     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18411     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18412     * the scroller will scroll horizontally. Otherwise items are expanded
18413     * to fill the width of the viewport of the scroller. If it is
18414     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18415     * limited to that size.
18416     *
18417     * @see elm_genlist_horizontal_get()
18418     *
18419     * @ingroup Genlist
18420     */
18421    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18422    /**
18423     * Gets the horizontal stretching mode.
18424     *
18425     * @param obj The genlist object
18426     * @return The mode to use
18427     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18428     *
18429     * @see elm_genlist_horizontal_set()
18430     *
18431     * @ingroup Genlist
18432     */
18433    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18434    /**
18435     * Set the always select mode.
18436     *
18437     * @param obj The genlist object
18438     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18439     * EINA_FALSE = off). Default is @c EINA_FALSE.
18440     *
18441     * Items will only call their selection func and callback when first
18442     * becoming selected. Any further clicks will do nothing, unless you
18443     * enable always select with elm_genlist_always_select_mode_set().
18444     * This means that, even if selected, every click will make the selected
18445     * callbacks be called.
18446     *
18447     * @see elm_genlist_always_select_mode_get()
18448     *
18449     * @ingroup Genlist
18450     */
18451    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18452    /**
18453     * Get the always select mode.
18454     *
18455     * @param obj The genlist object
18456     * @return The always select mode
18457     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18458     *
18459     * @see elm_genlist_always_select_mode_set()
18460     *
18461     * @ingroup Genlist
18462     */
18463    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18464    /**
18465     * Enable/disable the no select mode.
18466     *
18467     * @param obj The genlist object
18468     * @param no_select The no select mode
18469     * (EINA_TRUE = on, EINA_FALSE = off)
18470     *
18471     * This will turn off the ability to select items entirely and they
18472     * will neither appear selected nor call selected callback functions.
18473     *
18474     * @see elm_genlist_no_select_mode_get()
18475     *
18476     * @ingroup Genlist
18477     */
18478    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18479    /**
18480     * Gets whether the no select mode is enabled.
18481     *
18482     * @param obj The genlist object
18483     * @return The no select mode
18484     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18485     *
18486     * @see elm_genlist_no_select_mode_set()
18487     *
18488     * @ingroup Genlist
18489     */
18490    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18491    /**
18492     * Enable/disable compress mode.
18493     *
18494     * @param obj The genlist object
18495     * @param compress The compress mode
18496     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18497     *
18498     * This will enable the compress mode where items are "compressed"
18499     * horizontally to fit the genlist scrollable viewport width. This is
18500     * special for genlist.  Do not rely on
18501     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18502     * work as genlist needs to handle it specially.
18503     *
18504     * @see elm_genlist_compress_mode_get()
18505     *
18506     * @ingroup Genlist
18507     */
18508    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18509    /**
18510     * Get whether the compress mode is enabled.
18511     *
18512     * @param obj The genlist object
18513     * @return The compress mode
18514     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18515     *
18516     * @see elm_genlist_compress_mode_set()
18517     *
18518     * @ingroup Genlist
18519     */
18520    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18521    /**
18522     * Enable/disable height-for-width mode.
18523     *
18524     * @param obj The genlist object
18525     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18526     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18527     *
18528     * With height-for-width mode the item width will be fixed (restricted
18529     * to a minimum of) to the list width when calculating its size in
18530     * order to allow the height to be calculated based on it. This allows,
18531     * for instance, text block to wrap lines if the Edje part is
18532     * configured with "text.min: 0 1".
18533     *
18534     * @note This mode will make list resize slower as it will have to
18535     *       recalculate every item height again whenever the list width
18536     *       changes!
18537     *
18538     * @note When height-for-width mode is enabled, it also enables
18539     *       compress mode (see elm_genlist_compress_mode_set()) and
18540     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18541     *
18542     * @ingroup Genlist
18543     */
18544    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18545    /**
18546     * Get whether the height-for-width mode is enabled.
18547     *
18548     * @param obj The genlist object
18549     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18550     * off)
18551     *
18552     * @ingroup Genlist
18553     */
18554    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18555    /**
18556     * Enable/disable horizontal and vertical bouncing effect.
18557     *
18558     * @param obj The genlist object
18559     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18560     * EINA_FALSE = off). Default is @c EINA_FALSE.
18561     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18562     * EINA_FALSE = off). Default is @c EINA_TRUE.
18563     *
18564     * This will enable or disable the scroller bouncing effect for the
18565     * genlist. See elm_scroller_bounce_set() for details.
18566     *
18567     * @see elm_scroller_bounce_set()
18568     * @see elm_genlist_bounce_get()
18569     *
18570     * @ingroup Genlist
18571     */
18572    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18573    /**
18574     * Get whether the horizontal and vertical bouncing effect is enabled.
18575     *
18576     * @param obj The genlist object
18577     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18578     * option is set.
18579     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18580     * option is set.
18581     *
18582     * @see elm_genlist_bounce_set()
18583     *
18584     * @ingroup Genlist
18585     */
18586    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18587    /**
18588     * Enable/disable homogenous mode.
18589     *
18590     * @param obj The genlist object
18591     * @param homogeneous Assume the items within the genlist are of the
18592     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18593     * EINA_FALSE.
18594     *
18595     * This will enable the homogeneous mode where items are of the same
18596     * height and width so that genlist may do the lazy-loading at its
18597     * maximum (which increases the performance for scrolling the list). This
18598     * implies 'compressed' mode.
18599     *
18600     * @see elm_genlist_compress_mode_set()
18601     * @see elm_genlist_homogeneous_get()
18602     *
18603     * @ingroup Genlist
18604     */
18605    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18606    /**
18607     * Get whether the homogenous mode is enabled.
18608     *
18609     * @param obj The genlist object
18610     * @return Assume the items within the genlist are of the same height
18611     * and width (EINA_TRUE = on, EINA_FALSE = off)
18612     *
18613     * @see elm_genlist_homogeneous_set()
18614     *
18615     * @ingroup Genlist
18616     */
18617    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18618    /**
18619     * Set the maximum number of items within an item block
18620     *
18621     * @param obj The genlist object
18622     * @param n   Maximum number of items within an item block. Default is 32.
18623     *
18624     * This will configure the block count to tune to the target with
18625     * particular performance matrix.
18626     *
18627     * A block of objects will be used to reduce the number of operations due to
18628     * many objects in the screen. It can determine the visibility, or if the
18629     * object has changed, it theme needs to be updated, etc. doing this kind of
18630     * calculation to the entire block, instead of per object.
18631     *
18632     * The default value for the block count is enough for most lists, so unless
18633     * you know you will have a lot of objects visible in the screen at the same
18634     * time, don't try to change this.
18635     *
18636     * @see elm_genlist_block_count_get()
18637     * @see @ref Genlist_Implementation
18638     *
18639     * @ingroup Genlist
18640     */
18641    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18642    /**
18643     * Get the maximum number of items within an item block
18644     *
18645     * @param obj The genlist object
18646     * @return Maximum number of items within an item block
18647     *
18648     * @see elm_genlist_block_count_set()
18649     *
18650     * @ingroup Genlist
18651     */
18652    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18653    /**
18654     * Set the timeout in seconds for the longpress event.
18655     *
18656     * @param obj The genlist object
18657     * @param timeout timeout in seconds. Default is 1.
18658     *
18659     * This option will change how long it takes to send an event "longpressed"
18660     * after the mouse down signal is sent to the list. If this event occurs, no
18661     * "clicked" event will be sent.
18662     *
18663     * @see elm_genlist_longpress_timeout_set()
18664     *
18665     * @ingroup Genlist
18666     */
18667    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18668    /**
18669     * Get the timeout in seconds for the longpress event.
18670     *
18671     * @param obj The genlist object
18672     * @return timeout in seconds
18673     *
18674     * @see elm_genlist_longpress_timeout_get()
18675     *
18676     * @ingroup Genlist
18677     */
18678    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18679    /**
18680     * Append a new item in a given genlist widget.
18681     *
18682     * @param obj The genlist object
18683     * @param itc The item class for the item
18684     * @param data The item data
18685     * @param parent The parent item, or NULL if none
18686     * @param flags Item flags
18687     * @param func Convenience function called when the item is selected
18688     * @param func_data Data passed to @p func above.
18689     * @return A handle to the item added or @c NULL if not possible
18690     *
18691     * This adds the given item to the end of the list or the end of
18692     * the children list if the @p parent is given.
18693     *
18694     * @see elm_genlist_item_prepend()
18695     * @see elm_genlist_item_insert_before()
18696     * @see elm_genlist_item_insert_after()
18697     * @see elm_genlist_item_del()
18698     *
18699     * @ingroup Genlist
18700     */
18701    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);
18702    /**
18703     * Prepend a new item in a given genlist widget.
18704     *
18705     * @param obj The genlist object
18706     * @param itc The item class for the item
18707     * @param data The item data
18708     * @param parent The parent item, or NULL if none
18709     * @param flags Item flags
18710     * @param func Convenience function called when the item is selected
18711     * @param func_data Data passed to @p func above.
18712     * @return A handle to the item added or NULL if not possible
18713     *
18714     * This adds an item to the beginning of the list or beginning of the
18715     * children of the parent if given.
18716     *
18717     * @see elm_genlist_item_append()
18718     * @see elm_genlist_item_insert_before()
18719     * @see elm_genlist_item_insert_after()
18720     * @see elm_genlist_item_del()
18721     *
18722     * @ingroup Genlist
18723     */
18724    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);
18725    /**
18726     * Insert an item before another in a genlist widget
18727     *
18728     * @param obj The genlist object
18729     * @param itc The item class for the item
18730     * @param data The item data
18731     * @param before The item to place this new one before.
18732     * @param flags Item flags
18733     * @param func Convenience function called when the item is selected
18734     * @param func_data Data passed to @p func above.
18735     * @return A handle to the item added or @c NULL if not possible
18736     *
18737     * This inserts an item before another in the list. It will be in the
18738     * same tree level or group as the item it is inserted before.
18739     *
18740     * @see elm_genlist_item_append()
18741     * @see elm_genlist_item_prepend()
18742     * @see elm_genlist_item_insert_after()
18743     * @see elm_genlist_item_del()
18744     *
18745     * @ingroup Genlist
18746     */
18747    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);
18748    /**
18749     * Insert an item after another in a genlist widget
18750     *
18751     * @param obj The genlist object
18752     * @param itc The item class for the item
18753     * @param data The item data
18754     * @param after The item to place this new one after.
18755     * @param flags Item flags
18756     * @param func Convenience function called when the item is selected
18757     * @param func_data Data passed to @p func above.
18758     * @return A handle to the item added or @c NULL if not possible
18759     *
18760     * This inserts an item after another in the list. It will be in the
18761     * same tree level or group as the item it is inserted after.
18762     *
18763     * @see elm_genlist_item_append()
18764     * @see elm_genlist_item_prepend()
18765     * @see elm_genlist_item_insert_before()
18766     * @see elm_genlist_item_del()
18767     *
18768     * @ingroup Genlist
18769     */
18770    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);
18771    /**
18772     * Insert a new item into the sorted genlist object
18773     *
18774     * @param obj The genlist object
18775     * @param itc The item class for the item
18776     * @param data The item data
18777     * @param parent The parent item, or NULL if none
18778     * @param flags Item flags
18779     * @param comp The function called for the sort
18780     * @param func Convenience function called when item selected
18781     * @param func_data Data passed to @p func above.
18782     * @return A handle to the item added or NULL if not possible
18783     *
18784     * @ingroup Genlist
18785     */
18786    EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
18787    EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
18788    /* operations to retrieve existing items */
18789    /**
18790     * Get the selectd item in the genlist.
18791     *
18792     * @param obj The genlist object
18793     * @return The selected item, or NULL if none is selected.
18794     *
18795     * This gets the selected item in the list (if multi-selection is enabled, only
18796     * the item that was first selected in the list is returned - which is not very
18797     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18798     * used).
18799     *
18800     * If no item is selected, NULL is returned.
18801     *
18802     * @see elm_genlist_selected_items_get()
18803     *
18804     * @ingroup Genlist
18805     */
18806    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18807    /**
18808     * Get a list of selected items in the genlist.
18809     *
18810     * @param obj The genlist object
18811     * @return The list of selected items, or NULL if none are selected.
18812     *
18813     * It returns a list of the selected items. This list pointer is only valid so
18814     * long as the selection doesn't change (no items are selected or unselected, or
18815     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18816     * pointers. The order of the items in this list is the order which they were
18817     * selected, i.e. the first item in this list is the first item that was
18818     * selected, and so on.
18819     *
18820     * @note If not in multi-select mode, consider using function
18821     * elm_genlist_selected_item_get() instead.
18822     *
18823     * @see elm_genlist_multi_select_set()
18824     * @see elm_genlist_selected_item_get()
18825     *
18826     * @ingroup Genlist
18827     */
18828    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18829    /**
18830     * Get the mode item style of items in the genlist
18831     * @param obj The genlist object
18832     * @return The mode item style string, or NULL if none is specified
18833     * 
18834     * This is a constant string and simply defines the name of the
18835     * style that will be used for mode animations. It can be
18836     * @c NULL if you don't plan to use Genlist mode. See
18837     * elm_genlist_item_mode_set() for more info.
18838     * 
18839     * @ingroup Genlist
18840     */
18841    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18842    /**
18843     * Set the mode item style of items in the genlist
18844     * @param obj The genlist object
18845     * @param style The mode item style string, or NULL if none is desired
18846     * 
18847     * This is a constant string and simply defines the name of the
18848     * style that will be used for mode animations. It can be
18849     * @c NULL if you don't plan to use Genlist mode. See
18850     * elm_genlist_item_mode_set() for more info.
18851     * 
18852     * @ingroup Genlist
18853     */
18854    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18855    /**
18856     * Get a list of realized items in genlist
18857     *
18858     * @param obj The genlist object
18859     * @return The list of realized items, nor NULL if none are realized.
18860     *
18861     * This returns a list of the realized items in the genlist. The list
18862     * contains Elm_Genlist_Item pointers. The list must be freed by the
18863     * caller when done with eina_list_free(). The item pointers in the
18864     * list are only valid so long as those items are not deleted or the
18865     * genlist is not deleted.
18866     *
18867     * @see elm_genlist_realized_items_update()
18868     *
18869     * @ingroup Genlist
18870     */
18871    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18872    /**
18873     * Get the item that is at the x, y canvas coords.
18874     *
18875     * @param obj The gelinst object.
18876     * @param x The input x coordinate
18877     * @param y The input y coordinate
18878     * @param posret The position relative to the item returned here
18879     * @return The item at the coordinates or NULL if none
18880     *
18881     * This returns the item at the given coordinates (which are canvas
18882     * relative, not object-relative). If an item is at that coordinate,
18883     * that item handle is returned, and if @p posret is not NULL, the
18884     * integer pointed to is set to a value of -1, 0 or 1, depending if
18885     * the coordinate is on the upper portion of that item (-1), on the
18886     * middle section (0) or on the lower part (1). If NULL is returned as
18887     * an item (no item found there), then posret may indicate -1 or 1
18888     * based if the coordinate is above or below all items respectively in
18889     * the genlist.
18890     *
18891     * @ingroup Genlist
18892     */
18893    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);
18894    /**
18895     * Get the first item in the genlist
18896     *
18897     * This returns the first item in the list.
18898     *
18899     * @param obj The genlist object
18900     * @return The first item, or NULL if none
18901     *
18902     * @ingroup Genlist
18903     */
18904    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18905    /**
18906     * Get the last item in the genlist
18907     *
18908     * This returns the last item in the list.
18909     *
18910     * @return The last item, or NULL if none
18911     *
18912     * @ingroup Genlist
18913     */
18914    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18915    /**
18916     * Set the scrollbar policy
18917     *
18918     * @param obj The genlist object
18919     * @param policy_h Horizontal scrollbar policy.
18920     * @param policy_v Vertical scrollbar policy.
18921     *
18922     * This sets the scrollbar visibility policy for the given genlist
18923     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18924     * made visible if it is needed, and otherwise kept hidden.
18925     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18926     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18927     * respectively for the horizontal and vertical scrollbars. Default is
18928     * #ELM_SMART_SCROLLER_POLICY_AUTO
18929     *
18930     * @see elm_genlist_scroller_policy_get()
18931     *
18932     * @ingroup Genlist
18933     */
18934    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18935    /**
18936     * Get the scrollbar policy
18937     *
18938     * @param obj The genlist object
18939     * @param policy_h Pointer to store the horizontal scrollbar policy.
18940     * @param policy_v Pointer to store the vertical scrollbar policy.
18941     *
18942     * @see elm_genlist_scroller_policy_set()
18943     *
18944     * @ingroup Genlist
18945     */
18946    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);
18947    /**
18948     * Get the @b next item in a genlist widget's internal list of items,
18949     * given a handle to one of those items.
18950     *
18951     * @param item The genlist item to fetch next from
18952     * @return The item after @p item, or @c NULL if there's none (and
18953     * on errors)
18954     *
18955     * This returns the item placed after the @p item, on the container
18956     * genlist.
18957     *
18958     * @see elm_genlist_item_prev_get()
18959     *
18960     * @ingroup Genlist
18961     */
18962    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18963    /**
18964     * Get the @b previous item in a genlist widget's internal list of items,
18965     * given a handle to one of those items.
18966     *
18967     * @param item The genlist item to fetch previous from
18968     * @return The item before @p item, or @c NULL if there's none (and
18969     * on errors)
18970     *
18971     * This returns the item placed before the @p item, on the container
18972     * genlist.
18973     *
18974     * @see elm_genlist_item_next_get()
18975     *
18976     * @ingroup Genlist
18977     */
18978    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18979    /**
18980     * Get the genlist object's handle which contains a given genlist
18981     * item
18982     *
18983     * @param item The item to fetch the container from
18984     * @return The genlist (parent) object
18985     *
18986     * This returns the genlist object itself that an item belongs to.
18987     *
18988     * @ingroup Genlist
18989     */
18990    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18991    /**
18992     * Get the parent item of the given item
18993     *
18994     * @param it The item
18995     * @return The parent of the item or @c NULL if it has no parent.
18996     *
18997     * This returns the item that was specified as parent of the item @p it on
18998     * elm_genlist_item_append() and insertion related functions.
18999     *
19000     * @ingroup Genlist
19001     */
19002    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19003    /**
19004     * Remove all sub-items (children) of the given item
19005     *
19006     * @param it The item
19007     *
19008     * This removes all items that are children (and their descendants) of the
19009     * given item @p it.
19010     *
19011     * @see elm_genlist_clear()
19012     * @see elm_genlist_item_del()
19013     *
19014     * @ingroup Genlist
19015     */
19016    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19017    /**
19018     * Set whether a given genlist item is selected or not
19019     *
19020     * @param it The item
19021     * @param selected Use @c EINA_TRUE, to make it selected, @c
19022     * EINA_FALSE to make it unselected
19023     *
19024     * This sets the selected state of an item. If multi selection is
19025     * not enabled on the containing genlist and @p selected is @c
19026     * EINA_TRUE, any other previously selected items will get
19027     * unselected in favor of this new one.
19028     *
19029     * @see elm_genlist_item_selected_get()
19030     *
19031     * @ingroup Genlist
19032     */
19033    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19034    /**
19035     * Get whether a given genlist item is selected or not
19036     *
19037     * @param it The item
19038     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19039     *
19040     * @see elm_genlist_item_selected_set() for more details
19041     *
19042     * @ingroup Genlist
19043     */
19044    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19045    /**
19046     * Sets the expanded state of an item.
19047     *
19048     * @param it The item
19049     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19050     *
19051     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19052     * expanded or not.
19053     *
19054     * The theme will respond to this change visually, and a signal "expanded" or
19055     * "contracted" will be sent from the genlist with a pointer to the item that
19056     * has been expanded/contracted.
19057     *
19058     * Calling this function won't show or hide any child of this item (if it is
19059     * a parent). You must manually delete and create them on the callbacks fo
19060     * the "expanded" or "contracted" signals.
19061     *
19062     * @see elm_genlist_item_expanded_get()
19063     *
19064     * @ingroup Genlist
19065     */
19066    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19067    /**
19068     * Get the expanded state of an item
19069     *
19070     * @param it The item
19071     * @return The expanded state
19072     *
19073     * This gets the expanded state of an item.
19074     *
19075     * @see elm_genlist_item_expanded_set()
19076     *
19077     * @ingroup Genlist
19078     */
19079    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19080    /**
19081     * Get the depth of expanded item
19082     *
19083     * @param it The genlist item object
19084     * @return The depth of expanded item
19085     *
19086     * @ingroup Genlist
19087     */
19088    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19089    /**
19090     * Set whether a given genlist item is disabled or not.
19091     *
19092     * @param it The item
19093     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19094     * to enable it back.
19095     *
19096     * A disabled item cannot be selected or unselected. It will also
19097     * change its appearance, to signal the user it's disabled.
19098     *
19099     * @see elm_genlist_item_disabled_get()
19100     *
19101     * @ingroup Genlist
19102     */
19103    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19104    /**
19105     * Get whether a given genlist item is disabled or not.
19106     *
19107     * @param it The item
19108     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19109     * (and on errors).
19110     *
19111     * @see elm_genlist_item_disabled_set() for more details
19112     *
19113     * @ingroup Genlist
19114     */
19115    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19116    /**
19117     * Sets the display only state of an item.
19118     *
19119     * @param it The item
19120     * @param display_only @c EINA_TRUE if the item is display only, @c
19121     * EINA_FALSE otherwise.
19122     *
19123     * A display only item cannot be selected or unselected. It is for
19124     * display only and not selecting or otherwise clicking, dragging
19125     * etc. by the user, thus finger size rules will not be applied to
19126     * this item.
19127     *
19128     * It's good to set group index items to display only state.
19129     *
19130     * @see elm_genlist_item_display_only_get()
19131     *
19132     * @ingroup Genlist
19133     */
19134    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19135    /**
19136     * Get the display only state of an item
19137     *
19138     * @param it The item
19139     * @return @c EINA_TRUE if the item is display only, @c
19140     * EINA_FALSE otherwise.
19141     *
19142     * @see elm_genlist_item_display_only_set()
19143     *
19144     * @ingroup Genlist
19145     */
19146    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19147    /**
19148     * Show the portion of a genlist's internal list containing a given
19149     * item, immediately.
19150     *
19151     * @param it The item to display
19152     *
19153     * This causes genlist to jump to the given item @p it and show it (by
19154     * immediately scrolling to that position), if it is not fully visible.
19155     *
19156     * @see elm_genlist_item_bring_in()
19157     * @see elm_genlist_item_top_show()
19158     * @see elm_genlist_item_middle_show()
19159     *
19160     * @ingroup Genlist
19161     */
19162    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19163    /**
19164     * Animatedly bring in, to the visible are of a genlist, a given
19165     * item on it.
19166     *
19167     * @param it The item to display
19168     *
19169     * This causes genlist to jump to the given item @p it and show it (by
19170     * animatedly scrolling), if it is not fully visible. This may use animation
19171     * to do so and take a period of time
19172     *
19173     * @see elm_genlist_item_show()
19174     * @see elm_genlist_item_top_bring_in()
19175     * @see elm_genlist_item_middle_bring_in()
19176     *
19177     * @ingroup Genlist
19178     */
19179    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19180    /**
19181     * Show the portion of a genlist's internal list containing a given
19182     * item, immediately.
19183     *
19184     * @param it The item to display
19185     *
19186     * This causes genlist to jump to the given item @p it and show it (by
19187     * immediately scrolling to that position), if it is not fully visible.
19188     *
19189     * The item will be positioned at the top of the genlist viewport.
19190     *
19191     * @see elm_genlist_item_show()
19192     * @see elm_genlist_item_top_bring_in()
19193     *
19194     * @ingroup Genlist
19195     */
19196    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19197    /**
19198     * Animatedly bring in, to the visible are of a genlist, a given
19199     * item on it.
19200     *
19201     * @param it The item
19202     *
19203     * This causes genlist to jump to the given item @p it and show it (by
19204     * animatedly scrolling), if it is not fully visible. This may use animation
19205     * to do so and take a period of time
19206     *
19207     * The item will be positioned at the top of the genlist viewport.
19208     *
19209     * @see elm_genlist_item_bring_in()
19210     * @see elm_genlist_item_top_show()
19211     *
19212     * @ingroup Genlist
19213     */
19214    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19215    /**
19216     * Show the portion of a genlist's internal list containing a given
19217     * item, immediately.
19218     *
19219     * @param it The item to display
19220     *
19221     * This causes genlist to jump to the given item @p it and show it (by
19222     * immediately scrolling to that position), if it is not fully visible.
19223     *
19224     * The item will be positioned at the middle of the genlist viewport.
19225     *
19226     * @see elm_genlist_item_show()
19227     * @see elm_genlist_item_middle_bring_in()
19228     *
19229     * @ingroup Genlist
19230     */
19231    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19232    /**
19233     * Animatedly bring in, to the visible are of a genlist, a given
19234     * item on it.
19235     *
19236     * @param it The item
19237     *
19238     * This causes genlist to jump to the given item @p it and show it (by
19239     * animatedly scrolling), if it is not fully visible. This may use animation
19240     * to do so and take a period of time
19241     *
19242     * The item will be positioned at the middle of the genlist viewport.
19243     *
19244     * @see elm_genlist_item_bring_in()
19245     * @see elm_genlist_item_middle_show()
19246     *
19247     * @ingroup Genlist
19248     */
19249    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19250    /**
19251     * Remove a genlist item from the its parent, deleting it.
19252     *
19253     * @param item The item to be removed.
19254     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19255     *
19256     * @see elm_genlist_clear(), to remove all items in a genlist at
19257     * once.
19258     *
19259     * @ingroup Genlist
19260     */
19261    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19262    /**
19263     * Return the data associated to a given genlist item
19264     *
19265     * @param item The genlist item.
19266     * @return the data associated to this item.
19267     *
19268     * This returns the @c data value passed on the
19269     * elm_genlist_item_append() and related item addition calls.
19270     *
19271     * @see elm_genlist_item_append()
19272     * @see elm_genlist_item_data_set()
19273     *
19274     * @ingroup Genlist
19275     */
19276    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19277    /**
19278     * Set the data associated to a given genlist item
19279     *
19280     * @param item The genlist item
19281     * @param data The new data pointer to set on it
19282     *
19283     * This @b overrides the @c data value passed on the
19284     * elm_genlist_item_append() and related item addition calls. This
19285     * function @b won't call elm_genlist_item_update() automatically,
19286     * so you'd issue it afterwards if you want to hove the item
19287     * updated to reflect the that new data.
19288     *
19289     * @see elm_genlist_item_data_get()
19290     *
19291     * @ingroup Genlist
19292     */
19293    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19294    /**
19295     * Tells genlist to "orphan" icons fetchs by the item class
19296     *
19297     * @param it The item
19298     *
19299     * This instructs genlist to release references to icons in the item,
19300     * meaning that they will no longer be managed by genlist and are
19301     * floating "orphans" that can be re-used elsewhere if the user wants
19302     * to.
19303     *
19304     * @ingroup Genlist
19305     */
19306    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19307    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19308    /**
19309     * Get the real Evas object created to implement the view of a
19310     * given genlist item
19311     *
19312     * @param item The genlist item.
19313     * @return the Evas object implementing this item's view.
19314     *
19315     * This returns the actual Evas object used to implement the
19316     * specified genlist item's view. This may be @c NULL, as it may
19317     * not have been created or may have been deleted, at any time, by
19318     * the genlist. <b>Do not modify this object</b> (move, resize,
19319     * show, hide, etc.), as the genlist is controlling it. This
19320     * function is for querying, emitting custom signals or hooking
19321     * lower level callbacks for events on that object. Do not delete
19322     * this object under any circumstances.
19323     *
19324     * @see elm_genlist_item_data_get()
19325     *
19326     * @ingroup Genlist
19327     */
19328    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19329    /**
19330     * Update the contents of an item
19331     *
19332     * @param it The item
19333     *
19334     * This updates an item by calling all the item class functions again
19335     * to get the icons, labels and states. Use this when the original
19336     * item data has changed and the changes are desired to be reflected.
19337     *
19338     * Use elm_genlist_realized_items_update() to update all already realized
19339     * items.
19340     *
19341     * @see elm_genlist_realized_items_update()
19342     *
19343     * @ingroup Genlist
19344     */
19345    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19346    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19347    /**
19348     * Update the item class of an item
19349     *
19350     * @param it The item
19351     * @param itc The item class for the item
19352     *
19353     * This sets another class fo the item, changing the way that it is
19354     * displayed. After changing the item class, elm_genlist_item_update() is
19355     * called on the item @p it.
19356     *
19357     * @ingroup Genlist
19358     */
19359    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19360    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19361    /**
19362     * Set the text to be shown in a given genlist item's tooltips.
19363     *
19364     * @param item The genlist item
19365     * @param text The text to set in the content
19366     *
19367     * This call will setup the text to be used as tooltip to that item
19368     * (analogous to elm_object_tooltip_text_set(), but being item
19369     * tooltips with higher precedence than object tooltips). It can
19370     * have only one tooltip at a time, so any previous tooltip data
19371     * will get removed.
19372     *
19373     * In order to set an icon or something else as a tooltip, look at
19374     * elm_genlist_item_tooltip_content_cb_set().
19375     *
19376     * @ingroup Genlist
19377     */
19378    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19379    /**
19380     * Set the content to be shown in a given genlist item's tooltips
19381     *
19382     * @param item The genlist item.
19383     * @param func The function returning the tooltip contents.
19384     * @param data What to provide to @a func as callback data/context.
19385     * @param del_cb Called when data is not needed anymore, either when
19386     *        another callback replaces @p func, the tooltip is unset with
19387     *        elm_genlist_item_tooltip_unset() or the owner @p item
19388     *        dies. This callback receives as its first parameter the
19389     *        given @p data, being @c event_info the item handle.
19390     *
19391     * This call will setup the tooltip's contents to @p item
19392     * (analogous to elm_object_tooltip_content_cb_set(), but being
19393     * item tooltips with higher precedence than object tooltips). It
19394     * can have only one tooltip at a time, so any previous tooltip
19395     * content will get removed. @p func (with @p data) will be called
19396     * every time Elementary needs to show the tooltip and it should
19397     * return a valid Evas object, which will be fully managed by the
19398     * tooltip system, getting deleted when the tooltip is gone.
19399     *
19400     * In order to set just a text as a tooltip, look at
19401     * elm_genlist_item_tooltip_text_set().
19402     *
19403     * @ingroup Genlist
19404     */
19405    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);
19406    /**
19407     * Unset a tooltip from a given genlist item
19408     *
19409     * @param item genlist item to remove a previously set tooltip from.
19410     *
19411     * This call removes any tooltip set on @p item. The callback
19412     * provided as @c del_cb to
19413     * elm_genlist_item_tooltip_content_cb_set() will be called to
19414     * notify it is not used anymore (and have resources cleaned, if
19415     * need be).
19416     *
19417     * @see elm_genlist_item_tooltip_content_cb_set()
19418     *
19419     * @ingroup Genlist
19420     */
19421    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19422    /**
19423     * Set a different @b style for a given genlist item's tooltip.
19424     *
19425     * @param item genlist item with tooltip set
19426     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19427     * "default", @c "transparent", etc)
19428     *
19429     * Tooltips can have <b>alternate styles</b> to be displayed on,
19430     * which are defined by the theme set on Elementary. This function
19431     * works analogously as elm_object_tooltip_style_set(), but here
19432     * applied only to genlist item objects. The default style for
19433     * tooltips is @c "default".
19434     *
19435     * @note before you set a style you should define a tooltip with
19436     *       elm_genlist_item_tooltip_content_cb_set() or
19437     *       elm_genlist_item_tooltip_text_set()
19438     *
19439     * @see elm_genlist_item_tooltip_style_get()
19440     *
19441     * @ingroup Genlist
19442     */
19443    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19444    /**
19445     * Get the style set a given genlist item's tooltip.
19446     *
19447     * @param item genlist item with tooltip already set on.
19448     * @return style the theme style in use, which defaults to
19449     *         "default". If the object does not have a tooltip set,
19450     *         then @c NULL is returned.
19451     *
19452     * @see elm_genlist_item_tooltip_style_set() for more details
19453     *
19454     * @ingroup Genlist
19455     */
19456    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19457    /**
19458     * Set the type of mouse pointer/cursor decoration to be shown,
19459     * when the mouse pointer is over the given genlist widget item
19460     *
19461     * @param item genlist item to customize cursor on
19462     * @param cursor the cursor type's name
19463     *
19464     * This function works analogously as elm_object_cursor_set(), but
19465     * here the cursor's changing area is restricted to the item's
19466     * area, and not the whole widget's. Note that that item cursors
19467     * have precedence over widget cursors, so that a mouse over @p
19468     * item will always show cursor @p type.
19469     *
19470     * If this function is called twice for an object, a previously set
19471     * cursor will be unset on the second call.
19472     *
19473     * @see elm_object_cursor_set()
19474     * @see elm_genlist_item_cursor_get()
19475     * @see elm_genlist_item_cursor_unset()
19476     *
19477     * @ingroup Genlist
19478     */
19479    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19480    /**
19481     * Get the type of mouse pointer/cursor decoration set to be shown,
19482     * when the mouse pointer is over the given genlist widget item
19483     *
19484     * @param item genlist item with custom cursor set
19485     * @return the cursor type's name or @c NULL, if no custom cursors
19486     * were set to @p item (and on errors)
19487     *
19488     * @see elm_object_cursor_get()
19489     * @see elm_genlist_item_cursor_set() for more details
19490     * @see elm_genlist_item_cursor_unset()
19491     *
19492     * @ingroup Genlist
19493     */
19494    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19495    /**
19496     * Unset any custom mouse pointer/cursor decoration set to be
19497     * shown, when the mouse pointer is over the given genlist widget
19498     * item, thus making it show the @b default cursor again.
19499     *
19500     * @param item a genlist item
19501     *
19502     * Use this call to undo any custom settings on this item's cursor
19503     * decoration, bringing it back to defaults (no custom style set).
19504     *
19505     * @see elm_object_cursor_unset()
19506     * @see elm_genlist_item_cursor_set() for more details
19507     *
19508     * @ingroup Genlist
19509     */
19510    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19511    /**
19512     * Set a different @b style for a given custom cursor set for a
19513     * genlist item.
19514     *
19515     * @param item genlist item with custom cursor set
19516     * @param style the <b>theme style</b> to use (e.g. @c "default",
19517     * @c "transparent", etc)
19518     *
19519     * This function only makes sense when one is using custom mouse
19520     * cursor decorations <b>defined in a theme file</b> , which can
19521     * have, given a cursor name/type, <b>alternate styles</b> on
19522     * it. It works analogously as elm_object_cursor_style_set(), but
19523     * here applied only to genlist item objects.
19524     *
19525     * @warning Before you set a cursor style you should have defined a
19526     *       custom cursor previously on the item, with
19527     *       elm_genlist_item_cursor_set()
19528     *
19529     * @see elm_genlist_item_cursor_engine_only_set()
19530     * @see elm_genlist_item_cursor_style_get()
19531     *
19532     * @ingroup Genlist
19533     */
19534    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19535    /**
19536     * Get the current @b style set for a given genlist item's custom
19537     * cursor
19538     *
19539     * @param item genlist item with custom cursor set.
19540     * @return style the cursor style in use. If the object does not
19541     *         have a cursor set, then @c NULL is returned.
19542     *
19543     * @see elm_genlist_item_cursor_style_set() for more details
19544     *
19545     * @ingroup Genlist
19546     */
19547    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19548    /**
19549     * Set if the (custom) cursor for a given genlist item should be
19550     * searched in its theme, also, or should only rely on the
19551     * rendering engine.
19552     *
19553     * @param item item with custom (custom) cursor already set on
19554     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19555     * only on those provided by the rendering engine, @c EINA_FALSE to
19556     * have them searched on the widget's theme, as well.
19557     *
19558     * @note This call is of use only if you've set a custom cursor
19559     * for genlist items, with elm_genlist_item_cursor_set().
19560     *
19561     * @note By default, cursors will only be looked for between those
19562     * provided by the rendering engine.
19563     *
19564     * @ingroup Genlist
19565     */
19566    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19567    /**
19568     * Get if the (custom) cursor for a given genlist item is being
19569     * searched in its theme, also, or is only relying on the rendering
19570     * engine.
19571     *
19572     * @param item a genlist item
19573     * @return @c EINA_TRUE, if cursors are being looked for only on
19574     * those provided by the rendering engine, @c EINA_FALSE if they
19575     * are being searched on the widget's theme, as well.
19576     *
19577     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19578     *
19579     * @ingroup Genlist
19580     */
19581    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19582    /**
19583     * Update the contents of all realized items.
19584     *
19585     * @param obj The genlist object.
19586     *
19587     * This updates all realized items by calling all the item class functions again
19588     * to get the icons, labels and states. Use this when the original
19589     * item data has changed and the changes are desired to be reflected.
19590     *
19591     * To update just one item, use elm_genlist_item_update().
19592     *
19593     * @see elm_genlist_realized_items_get()
19594     * @see elm_genlist_item_update()
19595     *
19596     * @ingroup Genlist
19597     */
19598    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19599    /**
19600     * Activate a genlist mode on an item
19601     *
19602     * @param item The genlist item
19603     * @param mode Mode name
19604     * @param mode_set Boolean to define set or unset mode.
19605     *
19606     * A genlist mode is a different way of selecting an item. Once a mode is
19607     * activated on an item, any other selected item is immediately unselected.
19608     * This feature provides an easy way of implementing a new kind of animation
19609     * for selecting an item, without having to entirely rewrite the item style
19610     * theme. However, the elm_genlist_selected_* API can't be used to get what
19611     * item is activate for a mode.
19612     *
19613     * The current item style will still be used, but applying a genlist mode to
19614     * an item will select it using a different kind of animation.
19615     *
19616     * The current active item for a mode can be found by
19617     * elm_genlist_mode_item_get().
19618     *
19619     * The characteristics of genlist mode are:
19620     * - Only one mode can be active at any time, and for only one item.
19621     * - Genlist handles deactivating other items when one item is activated.
19622     * - A mode is defined in the genlist theme (edc), and more modes can easily
19623     *   be added.
19624     * - A mode style and the genlist item style are different things. They
19625     *   can be combined to provide a default style to the item, with some kind
19626     *   of animation for that item when the mode is activated.
19627     *
19628     * When a mode is activated on an item, a new view for that item is created.
19629     * The theme of this mode defines the animation that will be used to transit
19630     * the item from the old view to the new view. This second (new) view will be
19631     * active for that item while the mode is active on the item, and will be
19632     * destroyed after the mode is totally deactivated from that item.
19633     *
19634     * @see elm_genlist_mode_get()
19635     * @see elm_genlist_mode_item_get()
19636     *
19637     * @ingroup Genlist
19638     */
19639    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19640    /**
19641     * Get the last (or current) genlist mode used.
19642     *
19643     * @param obj The genlist object
19644     *
19645     * This function just returns the name of the last used genlist mode. It will
19646     * be the current mode if it's still active.
19647     *
19648     * @see elm_genlist_item_mode_set()
19649     * @see elm_genlist_mode_item_get()
19650     *
19651     * @ingroup Genlist
19652     */
19653    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19654    /**
19655     * Get active genlist mode item
19656     *
19657     * @param obj The genlist object
19658     * @return The active item for that current mode. Or @c NULL if no item is
19659     * activated with any mode.
19660     *
19661     * This function returns the item that was activated with a mode, by the
19662     * function elm_genlist_item_mode_set().
19663     *
19664     * @see elm_genlist_item_mode_set()
19665     * @see elm_genlist_mode_get()
19666     *
19667     * @ingroup Genlist
19668     */
19669    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19670
19671    /**
19672     * Set reorder mode
19673     *
19674     * @param obj The genlist object
19675     * @param reorder_mode The reorder mode
19676     * (EINA_TRUE = on, EINA_FALSE = off)
19677     *
19678     * @ingroup Genlist
19679     */
19680    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19681
19682    /**
19683     * Get the reorder mode
19684     *
19685     * @param obj The genlist object
19686     * @return The reorder mode
19687     * (EINA_TRUE = on, EINA_FALSE = off)
19688     *
19689     * @ingroup Genlist
19690     */
19691    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19692
19693    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19694    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19695    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19696    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19697    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19698    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19699    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19700    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19701    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19702    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19703
19704    /**
19705     * @}
19706     */
19707
19708    /**
19709     * @defgroup Check Check
19710     *
19711     * @image html img/widget/check/preview-00.png
19712     * @image latex img/widget/check/preview-00.eps
19713     * @image html img/widget/check/preview-01.png
19714     * @image latex img/widget/check/preview-01.eps
19715     * @image html img/widget/check/preview-02.png
19716     * @image latex img/widget/check/preview-02.eps
19717     *
19718     * @brief The check widget allows for toggling a value between true and
19719     * false.
19720     *
19721     * Check objects are a lot like radio objects in layout and functionality
19722     * except they do not work as a group, but independently and only toggle the
19723     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19724     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19725     * returns the current state. For convenience, like the radio objects, you
19726     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19727     * for it to modify.
19728     *
19729     * Signals that you can add callbacks for are:
19730     * "changed" - This is called whenever the user changes the state of one of
19731     *             the check object(event_info is NULL).
19732     *
19733     * Default contents parts of the check widget that you can use for are:
19734     * @li "elm.swallow.content" - A icon of the check
19735     *
19736     * Default text parts of the check widget that you can use for are:
19737     * @li "elm.text" - Label of the check
19738     *
19739     * @ref tutorial_check should give you a firm grasp of how to use this widget
19740     * .
19741     * @{
19742     */
19743    /**
19744     * @brief Add a new Check object
19745     *
19746     * @param parent The parent object
19747     * @return The new object or NULL if it cannot be created
19748     */
19749    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19750    /**
19751     * @brief Set the text label of the check object
19752     *
19753     * @param obj The check object
19754     * @param label The text label string in UTF-8
19755     *
19756     * @deprecated use elm_object_text_set() instead.
19757     */
19758    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19759    /**
19760     * @brief Get the text label of the check object
19761     *
19762     * @param obj The check object
19763     * @return The text label string in UTF-8
19764     *
19765     * @deprecated use elm_object_text_get() instead.
19766     */
19767    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19768    /**
19769     * @brief Set the icon object of the check object
19770     *
19771     * @param obj The check object
19772     * @param icon The icon object
19773     *
19774     * Once the icon object is set, a previously set one will be deleted.
19775     * If you want to keep that old content object, use the
19776     * elm_object_content_unset() function.
19777     */
19778    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19779    /**
19780     * @brief Get the icon object of the check object
19781     *
19782     * @param obj The check object
19783     * @return The icon object
19784     */
19785    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19786    /**
19787     * @brief Unset the icon used for the check object
19788     *
19789     * @param obj The check object
19790     * @return The icon object that was being used
19791     *
19792     * Unparent and return the icon object which was set for this widget.
19793     */
19794    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19795    /**
19796     * @brief Set the on/off state of the check object
19797     *
19798     * @param obj The check object
19799     * @param state The state to use (1 == on, 0 == off)
19800     *
19801     * This sets the state of the check. If set
19802     * with elm_check_state_pointer_set() the state of that variable is also
19803     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19804     */
19805    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19806    /**
19807     * @brief Get the state of the check object
19808     *
19809     * @param obj The check object
19810     * @return The boolean state
19811     */
19812    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19813    /**
19814     * @brief Set a convenience pointer to a boolean to change
19815     *
19816     * @param obj The check object
19817     * @param statep Pointer to the boolean to modify
19818     *
19819     * This sets a pointer to a boolean, that, in addition to the check objects
19820     * state will also be modified directly. To stop setting the object pointed
19821     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19822     * then when this is called, the check objects state will also be modified to
19823     * reflect the value of the boolean @p statep points to, just like calling
19824     * elm_check_state_set().
19825     */
19826    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19827    /**
19828     * @}
19829     */
19830
19831    /**
19832     * @defgroup Radio Radio
19833     *
19834     * @image html img/widget/radio/preview-00.png
19835     * @image latex img/widget/radio/preview-00.eps
19836     *
19837     * @brief Radio is a widget that allows for 1 or more options to be displayed
19838     * and have the user choose only 1 of them.
19839     *
19840     * A radio object contains an indicator, an optional Label and an optional
19841     * icon object. While it's possible to have a group of only one radio they,
19842     * are normally used in groups of 2 or more. To add a radio to a group use
19843     * elm_radio_group_add(). The radio object(s) will select from one of a set
19844     * of integer values, so any value they are configuring needs to be mapped to
19845     * a set of integers. To configure what value that radio object represents,
19846     * use  elm_radio_state_value_set() to set the integer it represents. To set
19847     * the value the whole group(which one is currently selected) is to indicate
19848     * use elm_radio_value_set() on any group member, and to get the groups value
19849     * use elm_radio_value_get(). For convenience the radio objects are also able
19850     * to directly set an integer(int) to the value that is selected. To specify
19851     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19852     * The radio objects will modify this directly. That implies the pointer must
19853     * point to valid memory for as long as the radio objects exist.
19854     *
19855     * Signals that you can add callbacks for are:
19856     * @li changed - This is called whenever the user changes the state of one of
19857     * the radio objects within the group of radio objects that work together.
19858     *
19859     * Default contents parts of the radio widget that you can use for are:
19860     * @li "elm.swallow.content" - A icon of the radio
19861     *
19862     * @ref tutorial_radio show most of this API in action.
19863     * @{
19864     */
19865    /**
19866     * @brief Add a new radio to the parent
19867     *
19868     * @param parent The parent object
19869     * @return The new object or NULL if it cannot be created
19870     */
19871    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19872    /**
19873     * @brief Set the text label of the radio object
19874     *
19875     * @param obj The radio object
19876     * @param label The text label string in UTF-8
19877     *
19878     * @deprecated use elm_object_text_set() instead.
19879     */
19880    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19881    /**
19882     * @brief Get the text label of the radio object
19883     *
19884     * @param obj The radio object
19885     * @return The text label string in UTF-8
19886     *
19887     * @deprecated use elm_object_text_set() instead.
19888     */
19889    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19890    /**
19891     * @brief Set the icon object of the radio object
19892     *
19893     * @param obj The radio object
19894     * @param icon The icon object
19895     *
19896     * Once the icon object is set, a previously set one will be deleted. If you
19897     * want to keep that old content object, use the elm_radio_icon_unset()
19898     * function.
19899     &
19900     * @deprecated use elm_object_content_set() instead.
19901     */
19902    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19903    /**
19904     * @brief Get the icon object of the radio object
19905     *
19906     * @param obj The radio object
19907     * @return The icon object
19908     *
19909     * @see elm_radio_icon_set()
19910     */
19911    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19912    /**
19913     * @brief Unset the icon used for the radio object
19914     *
19915     * @param obj The radio object
19916     * @return The icon object that was being used
19917     *
19918     * Unparent and return the icon object which was set for this widget.
19919     *
19920     * @see elm_radio_icon_set()
19921     * @deprecated use elm_object_content_unset() instead.
19922     */
19923    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19924    /**
19925     * @brief Add this radio to a group of other radio objects
19926     *
19927     * @param obj The radio object
19928     * @param group Any object whose group the @p obj is to join.
19929     *
19930     * Radio objects work in groups. Each member should have a different integer
19931     * value assigned. In order to have them work as a group, they need to know
19932     * about each other. This adds the given radio object to the group of which
19933     * the group object indicated is a member.
19934     */
19935    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19936    /**
19937     * @brief Set the integer value that this radio object represents
19938     *
19939     * @param obj The radio object
19940     * @param value The value to use if this radio object is selected
19941     *
19942     * This sets the value of the radio.
19943     */
19944    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19945    /**
19946     * @brief Get the integer value that this radio object represents
19947     *
19948     * @param obj The radio object
19949     * @return The value used if this radio object is selected
19950     *
19951     * This gets the value of the radio.
19952     *
19953     * @see elm_radio_value_set()
19954     */
19955    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19956    /**
19957     * @brief Set the value of the radio.
19958     *
19959     * @param obj The radio object
19960     * @param value The value to use for the group
19961     *
19962     * This sets the value of the radio group and will also set the value if
19963     * pointed to, to the value supplied, but will not call any callbacks.
19964     */
19965    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19966    /**
19967     * @brief Get the state of the radio object
19968     *
19969     * @param obj The radio object
19970     * @return The integer state
19971     */
19972    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19973    /**
19974     * @brief Set a convenience pointer to a integer to change
19975     *
19976     * @param obj The radio object
19977     * @param valuep Pointer to the integer to modify
19978     *
19979     * This sets a pointer to a integer, that, in addition to the radio objects
19980     * state will also be modified directly. To stop setting the object pointed
19981     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19982     * when this is called, the radio objects state will also be modified to
19983     * reflect the value of the integer valuep points to, just like calling
19984     * elm_radio_value_set().
19985     */
19986    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19987    /**
19988     * @}
19989     */
19990
19991    /**
19992     * @defgroup Pager Pager
19993     *
19994     * @image html img/widget/pager/preview-00.png
19995     * @image latex img/widget/pager/preview-00.eps
19996     *
19997     * @brief Widget that allows flipping between 1 or more “pages” of objects.
19998     *
19999     * The flipping between “pages” of objects is animated. All content in pager
20000     * is kept in a stack, the last content to be added will be on the top of the
20001     * stack(be visible).
20002     *
20003     * Objects can be pushed or popped from the stack or deleted as normal.
20004     * Pushes and pops will animate (and a pop will delete the object once the
20005     * animation is finished). Any object already in the pager can be promoted to
20006     * the top(from its current stacking position) through the use of
20007     * elm_pager_content_promote(). Objects are pushed to the top with
20008     * elm_pager_content_push() and when the top item is no longer wanted, simply
20009     * pop it with elm_pager_content_pop() and it will also be deleted. If an
20010     * object is no longer needed and is not the top item, just delete it as
20011     * normal. You can query which objects are the top and bottom with
20012     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20013     *
20014     * Signals that you can add callbacks for are:
20015     * "hide,finished" - when the previous page is hided
20016     *
20017     * This widget has the following styles available:
20018     * @li default
20019     * @li fade
20020     * @li fade_translucide
20021     * @li fade_invisible
20022     * @note This styles affect only the flipping animations, the appearance when
20023     * not animating is unaffected by styles.
20024     *
20025     * @ref tutorial_pager gives a good overview of the usage of the API.
20026     * @{
20027     */
20028    /**
20029     * Add a new pager to the parent
20030     *
20031     * @param parent The parent object
20032     * @return The new object or NULL if it cannot be created
20033     *
20034     * @ingroup Pager
20035     */
20036    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20037    /**
20038     * @brief Push an object to the top of the pager stack (and show it).
20039     *
20040     * @param obj The pager object
20041     * @param content The object to push
20042     *
20043     * The object pushed becomes a child of the pager, it will be controlled and
20044     * deleted when the pager is deleted.
20045     *
20046     * @note If the content is already in the stack use
20047     * elm_pager_content_promote().
20048     * @warning Using this function on @p content already in the stack results in
20049     * undefined behavior.
20050     */
20051    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20052    /**
20053     * @brief Pop the object that is on top of the stack
20054     *
20055     * @param obj The pager object
20056     *
20057     * This pops the object that is on the top(visible) of the pager, makes it
20058     * disappear, then deletes the object. The object that was underneath it on
20059     * the stack will become visible.
20060     */
20061    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20062    /**
20063     * @brief Moves an object already in the pager stack to the top of the stack.
20064     *
20065     * @param obj The pager object
20066     * @param content The object to promote
20067     *
20068     * This will take the @p content and move it to the top of the stack as
20069     * if it had been pushed there.
20070     *
20071     * @note If the content isn't already in the stack use
20072     * elm_pager_content_push().
20073     * @warning Using this function on @p content not already in the stack
20074     * results in undefined behavior.
20075     */
20076    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20077    /**
20078     * @brief Return the object at the bottom of the pager stack
20079     *
20080     * @param obj The pager object
20081     * @return The bottom object or NULL if none
20082     */
20083    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20084    /**
20085     * @brief  Return the object at the top of the pager stack
20086     *
20087     * @param obj The pager object
20088     * @return The top object or NULL if none
20089     */
20090    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20091
20092    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20093    EINA_DEPRECATED    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20094
20095    /**
20096     * @}
20097     */
20098
20099    /**
20100     * @defgroup Slideshow Slideshow
20101     *
20102     * @image html img/widget/slideshow/preview-00.png
20103     * @image latex img/widget/slideshow/preview-00.eps
20104     *
20105     * This widget, as the name indicates, is a pre-made image
20106     * slideshow panel, with API functions acting on (child) image
20107     * items presentation. Between those actions, are:
20108     * - advance to next/previous image
20109     * - select the style of image transition animation
20110     * - set the exhibition time for each image
20111     * - start/stop the slideshow
20112     *
20113     * The transition animations are defined in the widget's theme,
20114     * consequently new animations can be added without having to
20115     * update the widget's code.
20116     *
20117     * @section Slideshow_Items Slideshow items
20118     *
20119     * For slideshow items, just like for @ref Genlist "genlist" ones,
20120     * the user defines a @b classes, specifying functions that will be
20121     * called on the item's creation and deletion times.
20122     *
20123     * The #Elm_Slideshow_Item_Class structure contains the following
20124     * members:
20125     *
20126     * - @c func.get - When an item is displayed, this function is
20127     *   called, and it's where one should create the item object, de
20128     *   facto. For example, the object can be a pure Evas image object
20129     *   or an Elementary @ref Photocam "photocam" widget. See
20130     *   #SlideshowItemGetFunc.
20131     * - @c func.del - When an item is no more displayed, this function
20132     *   is called, where the user must delete any data associated to
20133     *   the item. See #SlideshowItemDelFunc.
20134     *
20135     * @section Slideshow_Caching Slideshow caching
20136     *
20137     * The slideshow provides facilities to have items adjacent to the
20138     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20139     * you, so that the system does not have to decode image data
20140     * anymore at the time it has to actually switch images on its
20141     * viewport. The user is able to set the numbers of items to be
20142     * cached @b before and @b after the current item, in the widget's
20143     * item list.
20144     *
20145     * Smart events one can add callbacks for are:
20146     *
20147     * - @c "changed" - when the slideshow switches its view to a new
20148     *   item
20149     *
20150     * List of examples for the slideshow widget:
20151     * @li @ref slideshow_example
20152     */
20153
20154    /**
20155     * @addtogroup Slideshow
20156     * @{
20157     */
20158
20159    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20160    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20161    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20162    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20163    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20164
20165    /**
20166     * @struct _Elm_Slideshow_Item_Class
20167     *
20168     * Slideshow item class definition. See @ref Slideshow_Items for
20169     * field details.
20170     */
20171    struct _Elm_Slideshow_Item_Class
20172      {
20173         struct _Elm_Slideshow_Item_Class_Func
20174           {
20175              SlideshowItemGetFunc get;
20176              SlideshowItemDelFunc del;
20177           } func;
20178      }; /**< #Elm_Slideshow_Item_Class member definitions */
20179
20180    /**
20181     * Add a new slideshow widget to the given parent Elementary
20182     * (container) object
20183     *
20184     * @param parent The parent object
20185     * @return A new slideshow widget handle or @c NULL, on errors
20186     *
20187     * This function inserts a new slideshow widget on the canvas.
20188     *
20189     * @ingroup Slideshow
20190     */
20191    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20192
20193    /**
20194     * Add (append) a new item in a given slideshow widget.
20195     *
20196     * @param obj The slideshow object
20197     * @param itc The item class for the item
20198     * @param data The item's data
20199     * @return A handle to the item added or @c NULL, on errors
20200     *
20201     * Add a new item to @p obj's internal list of items, appending it.
20202     * The item's class must contain the function really fetching the
20203     * image object to show for this item, which could be an Evas image
20204     * object or an Elementary photo, for example. The @p data
20205     * parameter is going to be passed to both class functions of the
20206     * item.
20207     *
20208     * @see #Elm_Slideshow_Item_Class
20209     * @see elm_slideshow_item_sorted_insert()
20210     *
20211     * @ingroup Slideshow
20212     */
20213    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20214
20215    /**
20216     * Insert a new item into the given slideshow widget, using the @p func
20217     * function to sort items (by item handles).
20218     *
20219     * @param obj The slideshow object
20220     * @param itc The item class for the item
20221     * @param data The item's data
20222     * @param func The comparing function to be used to sort slideshow
20223     * items <b>by #Elm_Slideshow_Item item handles</b>
20224     * @return Returns The slideshow item handle, on success, or
20225     * @c NULL, on errors
20226     *
20227     * Add a new item to @p obj's internal list of items, in a position
20228     * determined by the @p func comparing function. The item's class
20229     * must contain the function really fetching the image object to
20230     * show for this item, which could be an Evas image object or an
20231     * Elementary photo, for example. The @p data parameter is going to
20232     * be passed to both class functions of the item.
20233     *
20234     * @see #Elm_Slideshow_Item_Class
20235     * @see elm_slideshow_item_add()
20236     *
20237     * @ingroup Slideshow
20238     */
20239    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);
20240
20241    /**
20242     * Display a given slideshow widget's item, programmatically.
20243     *
20244     * @param obj The slideshow object
20245     * @param item The item to display on @p obj's viewport
20246     *
20247     * The change between the current item and @p item will use the
20248     * transition @p obj is set to use (@see
20249     * elm_slideshow_transition_set()).
20250     *
20251     * @ingroup Slideshow
20252     */
20253    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20254
20255    /**
20256     * Slide to the @b next item, in a given slideshow widget
20257     *
20258     * @param obj The slideshow object
20259     *
20260     * The sliding animation @p obj is set to use will be the
20261     * transition effect used, after this call is issued.
20262     *
20263     * @note If the end of the slideshow's internal list of items is
20264     * reached, it'll wrap around to the list's beginning, again.
20265     *
20266     * @ingroup Slideshow
20267     */
20268    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20269
20270    /**
20271     * Slide to the @b previous item, in a given slideshow widget
20272     *
20273     * @param obj The slideshow object
20274     *
20275     * The sliding animation @p obj is set to use will be the
20276     * transition effect used, after this call is issued.
20277     *
20278     * @note If the beginning of the slideshow's internal list of items
20279     * is reached, it'll wrap around to the list's end, again.
20280     *
20281     * @ingroup Slideshow
20282     */
20283    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20284
20285    /**
20286     * Returns the list of sliding transition/effect names available, for a
20287     * given slideshow widget.
20288     *
20289     * @param obj The slideshow object
20290     * @return The list of transitions (list of @b stringshared strings
20291     * as data)
20292     *
20293     * The transitions, which come from @p obj's theme, must be an EDC
20294     * data item named @c "transitions" on the theme file, with (prefix)
20295     * names of EDC programs actually implementing them.
20296     *
20297     * The available transitions for slideshows on the default theme are:
20298     * - @c "fade" - the current item fades out, while the new one
20299     *   fades in to the slideshow's viewport.
20300     * - @c "black_fade" - the current item fades to black, and just
20301     *   then, the new item will fade in.
20302     * - @c "horizontal" - the current item slides horizontally, until
20303     *   it gets out of the slideshow's viewport, while the new item
20304     *   comes from the left to take its place.
20305     * - @c "vertical" - the current item slides vertically, until it
20306     *   gets out of the slideshow's viewport, while the new item comes
20307     *   from the bottom to take its place.
20308     * - @c "square" - the new item starts to appear from the middle of
20309     *   the current one, but with a tiny size, growing until its
20310     *   target (full) size and covering the old one.
20311     *
20312     * @warning The stringshared strings get no new references
20313     * exclusive to the user grabbing the list, here, so if you'd like
20314     * to use them out of this call's context, you'd better @c
20315     * eina_stringshare_ref() them.
20316     *
20317     * @see elm_slideshow_transition_set()
20318     *
20319     * @ingroup Slideshow
20320     */
20321    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20322
20323    /**
20324     * Set the current slide transition/effect in use for a given
20325     * slideshow widget
20326     *
20327     * @param obj The slideshow object
20328     * @param transition The new transition's name string
20329     *
20330     * If @p transition is implemented in @p obj's theme (i.e., is
20331     * contained in the list returned by
20332     * elm_slideshow_transitions_get()), this new sliding effect will
20333     * be used on the widget.
20334     *
20335     * @see elm_slideshow_transitions_get() for more details
20336     *
20337     * @ingroup Slideshow
20338     */
20339    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20340
20341    /**
20342     * Get the current slide transition/effect in use for a given
20343     * slideshow widget
20344     *
20345     * @param obj The slideshow object
20346     * @return The current transition's name
20347     *
20348     * @see elm_slideshow_transition_set() for more details
20349     *
20350     * @ingroup Slideshow
20351     */
20352    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20353
20354    /**
20355     * Set the interval between each image transition on a given
20356     * slideshow widget, <b>and start the slideshow, itself</b>
20357     *
20358     * @param obj The slideshow object
20359     * @param timeout The new displaying timeout for images
20360     *
20361     * After this call, the slideshow widget will start cycling its
20362     * view, sequentially and automatically, with the images of the
20363     * items it has. The time between each new image displayed is going
20364     * to be @p timeout, in @b seconds. If a different timeout was set
20365     * previously and an slideshow was in progress, it will continue
20366     * with the new time between transitions, after this call.
20367     *
20368     * @note A value less than or equal to 0 on @p timeout will disable
20369     * the widget's internal timer, thus halting any slideshow which
20370     * could be happening on @p obj.
20371     *
20372     * @see elm_slideshow_timeout_get()
20373     *
20374     * @ingroup Slideshow
20375     */
20376    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20377
20378    /**
20379     * Get the interval set for image transitions on a given slideshow
20380     * widget.
20381     *
20382     * @param obj The slideshow object
20383     * @return Returns the timeout set on it
20384     *
20385     * @see elm_slideshow_timeout_set() for more details
20386     *
20387     * @ingroup Slideshow
20388     */
20389    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20390
20391    /**
20392     * Set if, after a slideshow is started, for a given slideshow
20393     * widget, its items should be displayed cyclically or not.
20394     *
20395     * @param obj The slideshow object
20396     * @param loop Use @c EINA_TRUE to make it cycle through items or
20397     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20398     * list of items
20399     *
20400     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20401     * ignore what is set by this functions, i.e., they'll @b always
20402     * cycle through items. This affects only the "automatic"
20403     * slideshow, as set by elm_slideshow_timeout_set().
20404     *
20405     * @see elm_slideshow_loop_get()
20406     *
20407     * @ingroup Slideshow
20408     */
20409    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20410
20411    /**
20412     * Get if, after a slideshow is started, for a given slideshow
20413     * widget, its items are to be displayed cyclically or not.
20414     *
20415     * @param obj The slideshow object
20416     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20417     * through or @c EINA_FALSE, otherwise
20418     *
20419     * @see elm_slideshow_loop_set() for more details
20420     *
20421     * @ingroup Slideshow
20422     */
20423    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20424
20425    /**
20426     * Remove all items from a given slideshow widget
20427     *
20428     * @param obj The slideshow object
20429     *
20430     * This removes (and deletes) all items in @p obj, leaving it
20431     * empty.
20432     *
20433     * @see elm_slideshow_item_del(), to remove just one item.
20434     *
20435     * @ingroup Slideshow
20436     */
20437    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20438
20439    /**
20440     * Get the internal list of items in a given slideshow widget.
20441     *
20442     * @param obj The slideshow object
20443     * @return The list of items (#Elm_Slideshow_Item as data) or
20444     * @c NULL on errors.
20445     *
20446     * This list is @b not to be modified in any way and must not be
20447     * freed. Use the list members with functions like
20448     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20449     *
20450     * @warning This list is only valid until @p obj object's internal
20451     * items list is changed. It should be fetched again with another
20452     * call to this function when changes happen.
20453     *
20454     * @ingroup Slideshow
20455     */
20456    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20457
20458    /**
20459     * Delete a given item from a slideshow widget.
20460     *
20461     * @param item The slideshow item
20462     *
20463     * @ingroup Slideshow
20464     */
20465    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20466
20467    /**
20468     * Return the data associated with a given slideshow item
20469     *
20470     * @param item The slideshow item
20471     * @return Returns the data associated to this item
20472     *
20473     * @ingroup Slideshow
20474     */
20475    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20476
20477    /**
20478     * Returns the currently displayed item, in a given slideshow widget
20479     *
20480     * @param obj The slideshow object
20481     * @return A handle to the item being displayed in @p obj or
20482     * @c NULL, if none is (and on errors)
20483     *
20484     * @ingroup Slideshow
20485     */
20486    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20487
20488    /**
20489     * Get the real Evas object created to implement the view of a
20490     * given slideshow item
20491     *
20492     * @param item The slideshow item.
20493     * @return the Evas object implementing this item's view.
20494     *
20495     * This returns the actual Evas object used to implement the
20496     * specified slideshow item's view. This may be @c NULL, as it may
20497     * not have been created or may have been deleted, at any time, by
20498     * the slideshow. <b>Do not modify this object</b> (move, resize,
20499     * show, hide, etc.), as the slideshow is controlling it. This
20500     * function is for querying, emitting custom signals or hooking
20501     * lower level callbacks for events on that object. Do not delete
20502     * this object under any circumstances.
20503     *
20504     * @see elm_slideshow_item_data_get()
20505     *
20506     * @ingroup Slideshow
20507     */
20508    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20509
20510    /**
20511     * Get the the item, in a given slideshow widget, placed at
20512     * position @p nth, in its internal items list
20513     *
20514     * @param obj The slideshow object
20515     * @param nth The number of the item to grab a handle to (0 being
20516     * the first)
20517     * @return The item stored in @p obj at position @p nth or @c NULL,
20518     * if there's no item with that index (and on errors)
20519     *
20520     * @ingroup Slideshow
20521     */
20522    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20523
20524    /**
20525     * Set the current slide layout in use for a given slideshow widget
20526     *
20527     * @param obj The slideshow object
20528     * @param layout The new layout's name string
20529     *
20530     * If @p layout is implemented in @p obj's theme (i.e., is contained
20531     * in the list returned by elm_slideshow_layouts_get()), this new
20532     * images layout will be used on the widget.
20533     *
20534     * @see elm_slideshow_layouts_get() for more details
20535     *
20536     * @ingroup Slideshow
20537     */
20538    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20539
20540    /**
20541     * Get the current slide layout in use for a given slideshow widget
20542     *
20543     * @param obj The slideshow object
20544     * @return The current layout's name
20545     *
20546     * @see elm_slideshow_layout_set() for more details
20547     *
20548     * @ingroup Slideshow
20549     */
20550    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20551
20552    /**
20553     * Returns the list of @b layout names available, for a given
20554     * slideshow widget.
20555     *
20556     * @param obj The slideshow object
20557     * @return The list of layouts (list of @b stringshared strings
20558     * as data)
20559     *
20560     * Slideshow layouts will change how the widget is to dispose each
20561     * image item in its viewport, with regard to cropping, scaling,
20562     * etc.
20563     *
20564     * The layouts, which come from @p obj's theme, must be an EDC
20565     * data item name @c "layouts" on the theme file, with (prefix)
20566     * names of EDC programs actually implementing them.
20567     *
20568     * The available layouts for slideshows on the default theme are:
20569     * - @c "fullscreen" - item images with original aspect, scaled to
20570     *   touch top and down slideshow borders or, if the image's heigh
20571     *   is not enough, left and right slideshow borders.
20572     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20573     *   one, but always leaving 10% of the slideshow's dimensions of
20574     *   distance between the item image's borders and the slideshow
20575     *   borders, for each axis.
20576     *
20577     * @warning The stringshared strings get no new references
20578     * exclusive to the user grabbing the list, here, so if you'd like
20579     * to use them out of this call's context, you'd better @c
20580     * eina_stringshare_ref() them.
20581     *
20582     * @see elm_slideshow_layout_set()
20583     *
20584     * @ingroup Slideshow
20585     */
20586    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20587
20588    /**
20589     * Set the number of items to cache, on a given slideshow widget,
20590     * <b>before the current item</b>
20591     *
20592     * @param obj The slideshow object
20593     * @param count Number of items to cache before the current one
20594     *
20595     * The default value for this property is @c 2. See
20596     * @ref Slideshow_Caching "slideshow caching" for more details.
20597     *
20598     * @see elm_slideshow_cache_before_get()
20599     *
20600     * @ingroup Slideshow
20601     */
20602    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20603
20604    /**
20605     * Retrieve the number of items to cache, on a given slideshow widget,
20606     * <b>before the current item</b>
20607     *
20608     * @param obj The slideshow object
20609     * @return The number of items set to be cached before the current one
20610     *
20611     * @see elm_slideshow_cache_before_set() for more details
20612     *
20613     * @ingroup Slideshow
20614     */
20615    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20616
20617    /**
20618     * Set the number of items to cache, on a given slideshow widget,
20619     * <b>after the current item</b>
20620     *
20621     * @param obj The slideshow object
20622     * @param count Number of items to cache after the current one
20623     *
20624     * The default value for this property is @c 2. See
20625     * @ref Slideshow_Caching "slideshow caching" for more details.
20626     *
20627     * @see elm_slideshow_cache_after_get()
20628     *
20629     * @ingroup Slideshow
20630     */
20631    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20632
20633    /**
20634     * Retrieve the number of items to cache, on a given slideshow widget,
20635     * <b>after the current item</b>
20636     *
20637     * @param obj The slideshow object
20638     * @return The number of items set to be cached after the current one
20639     *
20640     * @see elm_slideshow_cache_after_set() for more details
20641     *
20642     * @ingroup Slideshow
20643     */
20644    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20645
20646    /**
20647     * Get the number of items stored in a given slideshow widget
20648     *
20649     * @param obj The slideshow object
20650     * @return The number of items on @p obj, at the moment of this call
20651     *
20652     * @ingroup Slideshow
20653     */
20654    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20655
20656    /**
20657     * @}
20658     */
20659
20660    /**
20661     * @defgroup Fileselector File Selector
20662     *
20663     * @image html img/widget/fileselector/preview-00.png
20664     * @image latex img/widget/fileselector/preview-00.eps
20665     *
20666     * A file selector is a widget that allows a user to navigate
20667     * through a file system, reporting file selections back via its
20668     * API.
20669     *
20670     * It contains shortcut buttons for home directory (@c ~) and to
20671     * jump one directory upwards (..), as well as cancel/ok buttons to
20672     * confirm/cancel a given selection. After either one of those two
20673     * former actions, the file selector will issue its @c "done" smart
20674     * callback.
20675     *
20676     * There's a text entry on it, too, showing the name of the current
20677     * selection. There's the possibility of making it editable, so it
20678     * is useful on file saving dialogs on applications, where one
20679     * gives a file name to save contents to, in a given directory in
20680     * the system. This custom file name will be reported on the @c
20681     * "done" smart callback (explained in sequence).
20682     *
20683     * Finally, it has a view to display file system items into in two
20684     * possible forms:
20685     * - list
20686     * - grid
20687     *
20688     * If Elementary is built with support of the Ethumb thumbnailing
20689     * library, the second form of view will display preview thumbnails
20690     * of files which it supports.
20691     *
20692     * Smart callbacks one can register to:
20693     *
20694     * - @c "selected" - the user has clicked on a file (when not in
20695     *      folders-only mode) or directory (when in folders-only mode)
20696     * - @c "directory,open" - the list has been populated with new
20697     *      content (@c event_info is a pointer to the directory's
20698     *      path, a @b stringshared string)
20699     * - @c "done" - the user has clicked on the "ok" or "cancel"
20700     *      buttons (@c event_info is a pointer to the selection's
20701     *      path, a @b stringshared string)
20702     *
20703     * Here is an example on its usage:
20704     * @li @ref fileselector_example
20705     */
20706
20707    /**
20708     * @addtogroup Fileselector
20709     * @{
20710     */
20711
20712    /**
20713     * Defines how a file selector widget is to layout its contents
20714     * (file system entries).
20715     */
20716    typedef enum _Elm_Fileselector_Mode
20717      {
20718         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20719         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20720         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20721      } Elm_Fileselector_Mode;
20722
20723    /**
20724     * Add a new file selector widget to the given parent Elementary
20725     * (container) object
20726     *
20727     * @param parent The parent object
20728     * @return a new file selector widget handle or @c NULL, on errors
20729     *
20730     * This function inserts a new file selector widget on the canvas.
20731     *
20732     * @ingroup Fileselector
20733     */
20734    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20735
20736    /**
20737     * Enable/disable the file name entry box where the user can type
20738     * in a name for a file, in a given file selector widget
20739     *
20740     * @param obj The file selector object
20741     * @param is_save @c EINA_TRUE to make the file selector a "saving
20742     * dialog", @c EINA_FALSE otherwise
20743     *
20744     * Having the entry editable is useful on file saving dialogs on
20745     * applications, where one gives a file name to save contents to,
20746     * in a given directory in the system. This custom file name will
20747     * be reported on the @c "done" smart callback.
20748     *
20749     * @see elm_fileselector_is_save_get()
20750     *
20751     * @ingroup Fileselector
20752     */
20753    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20754
20755    /**
20756     * Get whether the given file selector is in "saving dialog" mode
20757     *
20758     * @param obj The file selector object
20759     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20760     * mode, @c EINA_FALSE otherwise (and on errors)
20761     *
20762     * @see elm_fileselector_is_save_set() for more details
20763     *
20764     * @ingroup Fileselector
20765     */
20766    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20767
20768    /**
20769     * Enable/disable folder-only view for a given file selector widget
20770     *
20771     * @param obj The file selector object
20772     * @param only @c EINA_TRUE to make @p obj only display
20773     * directories, @c EINA_FALSE to make files to be displayed in it
20774     * too
20775     *
20776     * If enabled, the widget's view will only display folder items,
20777     * naturally.
20778     *
20779     * @see elm_fileselector_folder_only_get()
20780     *
20781     * @ingroup Fileselector
20782     */
20783    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20784
20785    /**
20786     * Get whether folder-only view is set for a given file selector
20787     * widget
20788     *
20789     * @param obj The file selector object
20790     * @return only @c EINA_TRUE if @p obj is only displaying
20791     * directories, @c EINA_FALSE if files are being displayed in it
20792     * too (and on errors)
20793     *
20794     * @see elm_fileselector_folder_only_get()
20795     *
20796     * @ingroup Fileselector
20797     */
20798    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20799
20800    /**
20801     * Enable/disable the "ok" and "cancel" buttons on a given file
20802     * selector widget
20803     *
20804     * @param obj The file selector object
20805     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20806     *
20807     * @note A file selector without those buttons will never emit the
20808     * @c "done" smart event, and is only usable if one is just hooking
20809     * to the other two events.
20810     *
20811     * @see elm_fileselector_buttons_ok_cancel_get()
20812     *
20813     * @ingroup Fileselector
20814     */
20815    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20816
20817    /**
20818     * Get whether the "ok" and "cancel" buttons on a given file
20819     * selector widget are being shown.
20820     *
20821     * @param obj The file selector object
20822     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20823     * otherwise (and on errors)
20824     *
20825     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20826     *
20827     * @ingroup Fileselector
20828     */
20829    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20830
20831    /**
20832     * Enable/disable a tree view in the given file selector widget,
20833     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20834     *
20835     * @param obj The file selector object
20836     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20837     * disable
20838     *
20839     * In a tree view, arrows are created on the sides of directories,
20840     * allowing them to expand in place.
20841     *
20842     * @note If it's in other mode, the changes made by this function
20843     * will only be visible when one switches back to "list" mode.
20844     *
20845     * @see elm_fileselector_expandable_get()
20846     *
20847     * @ingroup Fileselector
20848     */
20849    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20850
20851    /**
20852     * Get whether tree view is enabled for the given file selector
20853     * widget
20854     *
20855     * @param obj The file selector object
20856     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20857     * otherwise (and or errors)
20858     *
20859     * @see elm_fileselector_expandable_set() for more details
20860     *
20861     * @ingroup Fileselector
20862     */
20863    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20864
20865    /**
20866     * Set, programmatically, the @b directory that a given file
20867     * selector widget will display contents from
20868     *
20869     * @param obj The file selector object
20870     * @param path The path to display in @p obj
20871     *
20872     * This will change the @b directory that @p obj is displaying. It
20873     * will also clear the text entry area on the @p obj object, which
20874     * displays select files' names.
20875     *
20876     * @see elm_fileselector_path_get()
20877     *
20878     * @ingroup Fileselector
20879     */
20880    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20881
20882    /**
20883     * Get the parent directory's path that a given file selector
20884     * widget is displaying
20885     *
20886     * @param obj The file selector object
20887     * @return The (full) path of the directory the file selector is
20888     * displaying, a @b stringshared string
20889     *
20890     * @see elm_fileselector_path_set()
20891     *
20892     * @ingroup Fileselector
20893     */
20894    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20895
20896    /**
20897     * Set, programmatically, the currently selected file/directory in
20898     * the given file selector widget
20899     *
20900     * @param obj The file selector object
20901     * @param path The (full) path to a file or directory
20902     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20903     * latter case occurs if the directory or file pointed to do not
20904     * exist.
20905     *
20906     * @see elm_fileselector_selected_get()
20907     *
20908     * @ingroup Fileselector
20909     */
20910    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20911
20912    /**
20913     * Get the currently selected item's (full) path, in the given file
20914     * selector widget
20915     *
20916     * @param obj The file selector object
20917     * @return The absolute path of the selected item, a @b
20918     * stringshared string
20919     *
20920     * @note Custom editions on @p obj object's text entry, if made,
20921     * will appear on the return string of this function, naturally.
20922     *
20923     * @see elm_fileselector_selected_set() for more details
20924     *
20925     * @ingroup Fileselector
20926     */
20927    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20928
20929    /**
20930     * Set the mode in which a given file selector widget will display
20931     * (layout) file system entries in its view
20932     *
20933     * @param obj The file selector object
20934     * @param mode The mode of the fileselector, being it one of
20935     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20936     * first one, naturally, will display the files in a list. The
20937     * latter will make the widget to display its entries in a grid
20938     * form.
20939     *
20940     * @note By using elm_fileselector_expandable_set(), the user may
20941     * trigger a tree view for that list.
20942     *
20943     * @note If Elementary is built with support of the Ethumb
20944     * thumbnailing library, the second form of view will display
20945     * preview thumbnails of files which it supports. You must have
20946     * elm_need_ethumb() called in your Elementary for thumbnailing to
20947     * work, though.
20948     *
20949     * @see elm_fileselector_expandable_set().
20950     * @see elm_fileselector_mode_get().
20951     *
20952     * @ingroup Fileselector
20953     */
20954    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20955
20956    /**
20957     * Get the mode in which a given file selector widget is displaying
20958     * (layouting) file system entries in its view
20959     *
20960     * @param obj The fileselector object
20961     * @return The mode in which the fileselector is at
20962     *
20963     * @see elm_fileselector_mode_set() for more details
20964     *
20965     * @ingroup Fileselector
20966     */
20967    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20968
20969    /**
20970     * @}
20971     */
20972
20973    /**
20974     * @defgroup Progressbar Progress bar
20975     *
20976     * The progress bar is a widget for visually representing the
20977     * progress status of a given job/task.
20978     *
20979     * A progress bar may be horizontal or vertical. It may display an
20980     * icon besides it, as well as primary and @b units labels. The
20981     * former is meant to label the widget as a whole, while the
20982     * latter, which is formatted with floating point values (and thus
20983     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20984     * units"</c>), is meant to label the widget's <b>progress
20985     * value</b>. Label, icon and unit strings/objects are @b optional
20986     * for progress bars.
20987     *
20988     * A progress bar may be @b inverted, in which state it gets its
20989     * values inverted, with high values being on the left or top and
20990     * low values on the right or bottom, as opposed to normally have
20991     * the low values on the former and high values on the latter,
20992     * respectively, for horizontal and vertical modes.
20993     *
20994     * The @b span of the progress, as set by
20995     * elm_progressbar_span_size_set(), is its length (horizontally or
20996     * vertically), unless one puts size hints on the widget to expand
20997     * on desired directions, by any container. That length will be
20998     * scaled by the object or applications scaling factor. At any
20999     * point code can query the progress bar for its value with
21000     * elm_progressbar_value_get().
21001     *
21002     * Available widget styles for progress bars:
21003     * - @c "default"
21004     * - @c "wheel" (simple style, no text, no progression, only
21005     *      "pulse" effect is available)
21006     *
21007     * Default contents parts of the progressbar widget that you can use for are:
21008     * @li "elm.swallow.content" - A icon of the progressbar
21009     * 
21010     * Here is an example on its usage:
21011     * @li @ref progressbar_example
21012     */
21013
21014    /**
21015     * Add a new progress bar widget to the given parent Elementary
21016     * (container) object
21017     *
21018     * @param parent The parent object
21019     * @return a new progress bar widget handle or @c NULL, on errors
21020     *
21021     * This function inserts a new progress bar widget on the canvas.
21022     *
21023     * @ingroup Progressbar
21024     */
21025    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21026
21027    /**
21028     * Set whether a given progress bar widget is at "pulsing mode" or
21029     * not.
21030     *
21031     * @param obj The progress bar object
21032     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21033     * @c EINA_FALSE to put it back to its default one
21034     *
21035     * By default, progress bars will display values from the low to
21036     * high value boundaries. There are, though, contexts in which the
21037     * state of progression of a given task is @b unknown.  For those,
21038     * one can set a progress bar widget to a "pulsing state", to give
21039     * the user an idea that some computation is being held, but
21040     * without exact progress values. In the default theme it will
21041     * animate its bar with the contents filling in constantly and back
21042     * to non-filled, in a loop. To start and stop this pulsing
21043     * animation, one has to explicitly call elm_progressbar_pulse().
21044     *
21045     * @see elm_progressbar_pulse_get()
21046     * @see elm_progressbar_pulse()
21047     *
21048     * @ingroup Progressbar
21049     */
21050    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21051
21052    /**
21053     * Get whether a given progress bar widget is at "pulsing mode" or
21054     * not.
21055     *
21056     * @param obj The progress bar object
21057     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21058     * if it's in the default one (and on errors)
21059     *
21060     * @ingroup Progressbar
21061     */
21062    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21063
21064    /**
21065     * Start/stop a given progress bar "pulsing" animation, if its
21066     * under that mode
21067     *
21068     * @param obj The progress bar object
21069     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21070     * @c EINA_FALSE to @b stop it
21071     *
21072     * @note This call won't do anything if @p obj is not under "pulsing mode".
21073     *
21074     * @see elm_progressbar_pulse_set() for more details.
21075     *
21076     * @ingroup Progressbar
21077     */
21078    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21079
21080    /**
21081     * Set the progress value (in percentage) on a given progress bar
21082     * widget
21083     *
21084     * @param obj The progress bar object
21085     * @param val The progress value (@b must be between @c 0.0 and @c
21086     * 1.0)
21087     *
21088     * Use this call to set progress bar levels.
21089     *
21090     * @note If you passes a value out of the specified range for @p
21091     * val, it will be interpreted as the @b closest of the @b boundary
21092     * values in the range.
21093     *
21094     * @ingroup Progressbar
21095     */
21096    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21097
21098    /**
21099     * Get the progress value (in percentage) on a given progress bar
21100     * widget
21101     *
21102     * @param obj The progress bar object
21103     * @return The value of the progressbar
21104     *
21105     * @see elm_progressbar_value_set() for more details
21106     *
21107     * @ingroup Progressbar
21108     */
21109    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21110
21111    /**
21112     * Set the label of a given progress bar widget
21113     *
21114     * @param obj The progress bar object
21115     * @param label The text label string, in UTF-8
21116     *
21117     * @ingroup Progressbar
21118     * @deprecated use elm_object_text_set() instead.
21119     */
21120    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21121
21122    /**
21123     * Get the label of a given progress bar widget
21124     *
21125     * @param obj The progressbar object
21126     * @return The text label string, in UTF-8
21127     *
21128     * @ingroup Progressbar
21129     * @deprecated use elm_object_text_set() instead.
21130     */
21131    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21132
21133    /**
21134     * Set the icon object of a given progress bar widget
21135     *
21136     * @param obj The progress bar object
21137     * @param icon The icon object
21138     *
21139     * Use this call to decorate @p obj with an icon next to it.
21140     *
21141     * @note Once the icon object is set, a previously set one will be
21142     * deleted. If you want to keep that old content object, use the
21143     * elm_progressbar_icon_unset() function.
21144     *
21145     * @see elm_progressbar_icon_get()
21146     * @deprecated use elm_object_content_set() instead.
21147     *
21148     * @ingroup Progressbar
21149     */
21150    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21151
21152    /**
21153     * Retrieve the icon object set for a given progress bar widget
21154     *
21155     * @param obj The progress bar object
21156     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21157     * otherwise (and on errors)
21158     *
21159     * @see elm_progressbar_icon_set() for more details
21160     * @deprecated use elm_object_content_set() instead.
21161     *
21162     * @ingroup Progressbar
21163     */
21164    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21165
21166    /**
21167     * Unset an icon set on a given progress bar widget
21168     *
21169     * @param obj The progress bar object
21170     * @return The icon object that was being used, if any was set, or
21171     * @c NULL, otherwise (and on errors)
21172     *
21173     * This call will unparent and return the icon object which was set
21174     * for this widget, previously, on success.
21175     *
21176     * @see elm_progressbar_icon_set() for more details
21177     * @deprecated use elm_object_content_unset() instead.
21178     *
21179     * @ingroup Progressbar
21180     */
21181    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21182
21183    /**
21184     * Set the (exact) length of the bar region of a given progress bar
21185     * widget
21186     *
21187     * @param obj The progress bar object
21188     * @param size The length of the progress bar's bar region
21189     *
21190     * This sets the minimum width (when in horizontal mode) or height
21191     * (when in vertical mode) of the actual bar area of the progress
21192     * bar @p obj. This in turn affects the object's minimum size. Use
21193     * this when you're not setting other size hints expanding on the
21194     * given direction (like weight and alignment hints) and you would
21195     * like it to have a specific size.
21196     *
21197     * @note Icon, label and unit text around @p obj will require their
21198     * own space, which will make @p obj to require more the @p size,
21199     * actually.
21200     *
21201     * @see elm_progressbar_span_size_get()
21202     *
21203     * @ingroup Progressbar
21204     */
21205    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21206
21207    /**
21208     * Get the length set for the bar region of a given progress bar
21209     * widget
21210     *
21211     * @param obj The progress bar object
21212     * @return The length of the progress bar's bar region
21213     *
21214     * If that size was not set previously, with
21215     * elm_progressbar_span_size_set(), this call will return @c 0.
21216     *
21217     * @ingroup Progressbar
21218     */
21219    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21220
21221    /**
21222     * Set the format string for a given progress bar widget's units
21223     * label
21224     *
21225     * @param obj The progress bar object
21226     * @param format The format string for @p obj's units label
21227     *
21228     * If @c NULL is passed on @p format, it will make @p obj's units
21229     * area to be hidden completely. If not, it'll set the <b>format
21230     * string</b> for the units label's @b text. The units label is
21231     * provided a floating point value, so the units text is up display
21232     * at most one floating point falue. Note that the units label is
21233     * optional. Use a format string such as "%1.2f meters" for
21234     * example.
21235     *
21236     * @note The default format string for a progress bar is an integer
21237     * percentage, as in @c "%.0f %%".
21238     *
21239     * @see elm_progressbar_unit_format_get()
21240     *
21241     * @ingroup Progressbar
21242     */
21243    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21244
21245    /**
21246     * Retrieve the format string set for a given progress bar widget's
21247     * units label
21248     *
21249     * @param obj The progress bar object
21250     * @return The format set string for @p obj's units label or
21251     * @c NULL, if none was set (and on errors)
21252     *
21253     * @see elm_progressbar_unit_format_set() for more details
21254     *
21255     * @ingroup Progressbar
21256     */
21257    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21258
21259    /**
21260     * Set the orientation of a given progress bar widget
21261     *
21262     * @param obj The progress bar object
21263     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21264     * @b horizontal, @c EINA_FALSE to make it @b vertical
21265     *
21266     * Use this function to change how your progress bar is to be
21267     * disposed: vertically or horizontally.
21268     *
21269     * @see elm_progressbar_horizontal_get()
21270     *
21271     * @ingroup Progressbar
21272     */
21273    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21274
21275    /**
21276     * Retrieve the orientation of a given progress bar widget
21277     *
21278     * @param obj The progress bar object
21279     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21280     * @c EINA_FALSE if it's @b vertical (and on errors)
21281     *
21282     * @see elm_progressbar_horizontal_set() for more details
21283     *
21284     * @ingroup Progressbar
21285     */
21286    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21287
21288    /**
21289     * Invert a given progress bar widget's displaying values order
21290     *
21291     * @param obj The progress bar object
21292     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21293     * @c EINA_FALSE to bring it back to default, non-inverted values.
21294     *
21295     * A progress bar may be @b inverted, in which state it gets its
21296     * values inverted, with high values being on the left or top and
21297     * low values on the right or bottom, as opposed to normally have
21298     * the low values on the former and high values on the latter,
21299     * respectively, for horizontal and vertical modes.
21300     *
21301     * @see elm_progressbar_inverted_get()
21302     *
21303     * @ingroup Progressbar
21304     */
21305    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21306
21307    /**
21308     * Get whether a given progress bar widget's displaying values are
21309     * inverted or not
21310     *
21311     * @param obj The progress bar object
21312     * @return @c EINA_TRUE, if @p obj has inverted values,
21313     * @c EINA_FALSE otherwise (and on errors)
21314     *
21315     * @see elm_progressbar_inverted_set() for more details
21316     *
21317     * @ingroup Progressbar
21318     */
21319    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21320
21321    /**
21322     * @defgroup Separator Separator
21323     *
21324     * @brief Separator is a very thin object used to separate other objects.
21325     *
21326     * A separator can be vertical or horizontal.
21327     *
21328     * @ref tutorial_separator is a good example of how to use a separator.
21329     * @{
21330     */
21331    /**
21332     * @brief Add a separator object to @p parent
21333     *
21334     * @param parent The parent object
21335     *
21336     * @return The separator object, or NULL upon failure
21337     */
21338    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21339    /**
21340     * @brief Set the horizontal mode of a separator object
21341     *
21342     * @param obj The separator object
21343     * @param horizontal If true, the separator is horizontal
21344     */
21345    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21346    /**
21347     * @brief Get the horizontal mode of a separator object
21348     *
21349     * @param obj The separator object
21350     * @return If true, the separator is horizontal
21351     *
21352     * @see elm_separator_horizontal_set()
21353     */
21354    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21355    /**
21356     * @}
21357     */
21358
21359    /**
21360     * @defgroup Spinner Spinner
21361     * @ingroup Elementary
21362     *
21363     * @image html img/widget/spinner/preview-00.png
21364     * @image latex img/widget/spinner/preview-00.eps
21365     *
21366     * A spinner is a widget which allows the user to increase or decrease
21367     * numeric values using arrow buttons, or edit values directly, clicking
21368     * over it and typing the new value.
21369     *
21370     * By default the spinner will not wrap and has a label
21371     * of "%.0f" (just showing the integer value of the double).
21372     *
21373     * A spinner has a label that is formatted with floating
21374     * point values and thus accepts a printf-style format string, like
21375     * “%1.2f units”.
21376     *
21377     * It also allows specific values to be replaced by pre-defined labels.
21378     *
21379     * Smart callbacks one can register to:
21380     *
21381     * - "changed" - Whenever the spinner value is changed.
21382     * - "delay,changed" - A short time after the value is changed by the user.
21383     *    This will be called only when the user stops dragging for a very short
21384     *    period or when they release their finger/mouse, so it avoids possibly
21385     *    expensive reactions to the value change.
21386     *
21387     * Available styles for it:
21388     * - @c "default";
21389     * - @c "vertical": up/down buttons at the right side and text left aligned.
21390     *
21391     * Here is an example on its usage:
21392     * @ref spinner_example
21393     */
21394
21395    /**
21396     * @addtogroup Spinner
21397     * @{
21398     */
21399
21400    /**
21401     * Add a new spinner widget to the given parent Elementary
21402     * (container) object.
21403     *
21404     * @param parent The parent object.
21405     * @return a new spinner widget handle or @c NULL, on errors.
21406     *
21407     * This function inserts a new spinner widget on the canvas.
21408     *
21409     * @ingroup Spinner
21410     *
21411     */
21412    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21413
21414    /**
21415     * Set the format string of the displayed label.
21416     *
21417     * @param obj The spinner object.
21418     * @param fmt The format string for the label display.
21419     *
21420     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21421     * string for the label text. The label text is provided a floating point
21422     * value, so the label text can display up to 1 floating point value.
21423     * Note that this is optional.
21424     *
21425     * Use a format string such as "%1.2f meters" for example, and it will
21426     * display values like: "3.14 meters" for a value equal to 3.14159.
21427     *
21428     * Default is "%0.f".
21429     *
21430     * @see elm_spinner_label_format_get()
21431     *
21432     * @ingroup Spinner
21433     */
21434    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21435
21436    /**
21437     * Get the label format of the spinner.
21438     *
21439     * @param obj The spinner object.
21440     * @return The text label format string in UTF-8.
21441     *
21442     * @see elm_spinner_label_format_set() for details.
21443     *
21444     * @ingroup Spinner
21445     */
21446    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21447
21448    /**
21449     * Set the minimum and maximum values for the spinner.
21450     *
21451     * @param obj The spinner object.
21452     * @param min The minimum value.
21453     * @param max The maximum value.
21454     *
21455     * Define the allowed range of values to be selected by the user.
21456     *
21457     * If actual value is less than @p min, it will be updated to @p min. If it
21458     * is bigger then @p max, will be updated to @p max. Actual value can be
21459     * get with elm_spinner_value_get().
21460     *
21461     * By default, min is equal to 0, and max is equal to 100.
21462     *
21463     * @warning Maximum must be greater than minimum.
21464     *
21465     * @see elm_spinner_min_max_get()
21466     *
21467     * @ingroup Spinner
21468     */
21469    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21470
21471    /**
21472     * Get the minimum and maximum values of the spinner.
21473     *
21474     * @param obj The spinner object.
21475     * @param min Pointer where to store the minimum value.
21476     * @param max Pointer where to store the maximum value.
21477     *
21478     * @note If only one value is needed, the other pointer can be passed
21479     * as @c NULL.
21480     *
21481     * @see elm_spinner_min_max_set() for details.
21482     *
21483     * @ingroup Spinner
21484     */
21485    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21486
21487    /**
21488     * Set the step used to increment or decrement the spinner value.
21489     *
21490     * @param obj The spinner object.
21491     * @param step The step value.
21492     *
21493     * This value will be incremented or decremented to the displayed value.
21494     * It will be incremented while the user keep right or top arrow pressed,
21495     * and will be decremented while the user keep left or bottom arrow pressed.
21496     *
21497     * The interval to increment / decrement can be set with
21498     * elm_spinner_interval_set().
21499     *
21500     * By default step value is equal to 1.
21501     *
21502     * @see elm_spinner_step_get()
21503     *
21504     * @ingroup Spinner
21505     */
21506    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21507
21508    /**
21509     * Get the step used to increment or decrement the spinner value.
21510     *
21511     * @param obj The spinner object.
21512     * @return The step value.
21513     *
21514     * @see elm_spinner_step_get() for more details.
21515     *
21516     * @ingroup Spinner
21517     */
21518    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21519
21520    /**
21521     * Set the value the spinner displays.
21522     *
21523     * @param obj The spinner object.
21524     * @param val The value to be displayed.
21525     *
21526     * Value will be presented on the label following format specified with
21527     * elm_spinner_format_set().
21528     *
21529     * @warning The value must to be between min and max values. This values
21530     * are set by elm_spinner_min_max_set().
21531     *
21532     * @see elm_spinner_value_get().
21533     * @see elm_spinner_format_set().
21534     * @see elm_spinner_min_max_set().
21535     *
21536     * @ingroup Spinner
21537     */
21538    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21539
21540    /**
21541     * Get the value displayed by the spinner.
21542     *
21543     * @param obj The spinner object.
21544     * @return The value displayed.
21545     *
21546     * @see elm_spinner_value_set() for details.
21547     *
21548     * @ingroup Spinner
21549     */
21550    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21551
21552    /**
21553     * Set whether the spinner should wrap when it reaches its
21554     * minimum or maximum value.
21555     *
21556     * @param obj The spinner object.
21557     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21558     * disable it.
21559     *
21560     * Disabled by default. If disabled, when the user tries to increment the
21561     * value,
21562     * but displayed value plus step value is bigger than maximum value,
21563     * the spinner
21564     * won't allow it. The same happens when the user tries to decrement it,
21565     * but the value less step is less than minimum value.
21566     *
21567     * When wrap is enabled, in such situations it will allow these changes,
21568     * but will get the value that would be less than minimum and subtracts
21569     * from maximum. Or add the value that would be more than maximum to
21570     * the minimum.
21571     *
21572     * E.g.:
21573     * @li min value = 10
21574     * @li max value = 50
21575     * @li step value = 20
21576     * @li displayed value = 20
21577     *
21578     * When the user decrement value (using left or bottom arrow), it will
21579     * displays @c 40, because max - (min - (displayed - step)) is
21580     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21581     *
21582     * @see elm_spinner_wrap_get().
21583     *
21584     * @ingroup Spinner
21585     */
21586    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21587
21588    /**
21589     * Get whether the spinner should wrap when it reaches its
21590     * minimum or maximum value.
21591     *
21592     * @param obj The spinner object
21593     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21594     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21595     *
21596     * @see elm_spinner_wrap_set() for details.
21597     *
21598     * @ingroup Spinner
21599     */
21600    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21601
21602    /**
21603     * Set whether the spinner can be directly edited by the user or not.
21604     *
21605     * @param obj The spinner object.
21606     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21607     * don't allow users to edit it directly.
21608     *
21609     * Spinner objects can have edition @b disabled, in which state they will
21610     * be changed only by arrows.
21611     * Useful for contexts
21612     * where you don't want your users to interact with it writting the value.
21613     * Specially
21614     * when using special values, the user can see real value instead
21615     * of special label on edition.
21616     *
21617     * It's enabled by default.
21618     *
21619     * @see elm_spinner_editable_get()
21620     *
21621     * @ingroup Spinner
21622     */
21623    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21624
21625    /**
21626     * Get whether the spinner can be directly edited by the user or not.
21627     *
21628     * @param obj The spinner object.
21629     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21630     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21631     *
21632     * @see elm_spinner_editable_set() for details.
21633     *
21634     * @ingroup Spinner
21635     */
21636    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21637
21638    /**
21639     * Set a special string to display in the place of the numerical value.
21640     *
21641     * @param obj The spinner object.
21642     * @param value The value to be replaced.
21643     * @param label The label to be used.
21644     *
21645     * It's useful for cases when a user should select an item that is
21646     * better indicated by a label than a value. For example, weekdays or months.
21647     *
21648     * E.g.:
21649     * @code
21650     * sp = elm_spinner_add(win);
21651     * elm_spinner_min_max_set(sp, 1, 3);
21652     * elm_spinner_special_value_add(sp, 1, "January");
21653     * elm_spinner_special_value_add(sp, 2, "February");
21654     * elm_spinner_special_value_add(sp, 3, "March");
21655     * evas_object_show(sp);
21656     * @endcode
21657     *
21658     * @ingroup Spinner
21659     */
21660    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21661
21662    /**
21663     * Set the interval on time updates for an user mouse button hold
21664     * on spinner widgets' arrows.
21665     *
21666     * @param obj The spinner object.
21667     * @param interval The (first) interval value in seconds.
21668     *
21669     * This interval value is @b decreased while the user holds the
21670     * mouse pointer either incrementing or decrementing spinner's value.
21671     *
21672     * This helps the user to get to a given value distant from the
21673     * current one easier/faster, as it will start to change quicker and
21674     * quicker on mouse button holds.
21675     *
21676     * The calculation for the next change interval value, starting from
21677     * the one set with this call, is the previous interval divided by
21678     * @c 1.05, so it decreases a little bit.
21679     *
21680     * The default starting interval value for automatic changes is
21681     * @c 0.85 seconds.
21682     *
21683     * @see elm_spinner_interval_get()
21684     *
21685     * @ingroup Spinner
21686     */
21687    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21688
21689    /**
21690     * Get the interval on time updates for an user mouse button hold
21691     * on spinner widgets' arrows.
21692     *
21693     * @param obj The spinner object.
21694     * @return The (first) interval value, in seconds, set on it.
21695     *
21696     * @see elm_spinner_interval_set() for more details.
21697     *
21698     * @ingroup Spinner
21699     */
21700    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21701
21702    /**
21703     * @}
21704     */
21705
21706    /**
21707     * @defgroup Index Index
21708     *
21709     * @image html img/widget/index/preview-00.png
21710     * @image latex img/widget/index/preview-00.eps
21711     *
21712     * An index widget gives you an index for fast access to whichever
21713     * group of other UI items one might have. It's a list of text
21714     * items (usually letters, for alphabetically ordered access).
21715     *
21716     * Index widgets are by default hidden and just appear when the
21717     * user clicks over it's reserved area in the canvas. In its
21718     * default theme, it's an area one @ref Fingers "finger" wide on
21719     * the right side of the index widget's container.
21720     *
21721     * When items on the index are selected, smart callbacks get
21722     * called, so that its user can make other container objects to
21723     * show a given area or child object depending on the index item
21724     * selected. You'd probably be using an index together with @ref
21725     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21726     * "general grids".
21727     *
21728     * Smart events one  can add callbacks for are:
21729     * - @c "changed" - When the selected index item changes. @c
21730     *      event_info is the selected item's data pointer.
21731     * - @c "delay,changed" - When the selected index item changes, but
21732     *      after a small idling period. @c event_info is the selected
21733     *      item's data pointer.
21734     * - @c "selected" - When the user releases a mouse button and
21735     *      selects an item. @c event_info is the selected item's data
21736     *      pointer.
21737     * - @c "level,up" - when the user moves a finger from the first
21738     *      level to the second level
21739     * - @c "level,down" - when the user moves a finger from the second
21740     *      level to the first level
21741     *
21742     * The @c "delay,changed" event is so that it'll wait a small time
21743     * before actually reporting those events and, moreover, just the
21744     * last event happening on those time frames will actually be
21745     * reported.
21746     *
21747     * Here are some examples on its usage:
21748     * @li @ref index_example_01
21749     * @li @ref index_example_02
21750     */
21751
21752    /**
21753     * @addtogroup Index
21754     * @{
21755     */
21756
21757    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21758
21759    /**
21760     * Add a new index widget to the given parent Elementary
21761     * (container) object
21762     *
21763     * @param parent The parent object
21764     * @return a new index widget handle or @c NULL, on errors
21765     *
21766     * This function inserts a new index widget on the canvas.
21767     *
21768     * @ingroup Index
21769     */
21770    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21771
21772    /**
21773     * Set whether a given index widget is or not visible,
21774     * programatically.
21775     *
21776     * @param obj The index object
21777     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21778     *
21779     * Not to be confused with visible as in @c evas_object_show() --
21780     * visible with regard to the widget's auto hiding feature.
21781     *
21782     * @see elm_index_active_get()
21783     *
21784     * @ingroup Index
21785     */
21786    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21787
21788    /**
21789     * Get whether a given index widget is currently visible or not.
21790     *
21791     * @param obj The index object
21792     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21793     *
21794     * @see elm_index_active_set() for more details
21795     *
21796     * @ingroup Index
21797     */
21798    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21799
21800    /**
21801     * Set the items level for a given index widget.
21802     *
21803     * @param obj The index object.
21804     * @param level @c 0 or @c 1, the currently implemented levels.
21805     *
21806     * @see elm_index_item_level_get()
21807     *
21808     * @ingroup Index
21809     */
21810    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21811
21812    /**
21813     * Get the items level set for a given index widget.
21814     *
21815     * @param obj The index object.
21816     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21817     *
21818     * @see elm_index_item_level_set() for more information
21819     *
21820     * @ingroup Index
21821     */
21822    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21823
21824    /**
21825     * Returns the last selected item's data, for a given index widget.
21826     *
21827     * @param obj The index object.
21828     * @return The item @b data associated to the last selected item on
21829     * @p obj (or @c NULL, on errors).
21830     *
21831     * @warning The returned value is @b not an #Elm_Index_Item item
21832     * handle, but the data associated to it (see the @c item parameter
21833     * in elm_index_item_append(), as an example).
21834     *
21835     * @ingroup Index
21836     */
21837    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21838
21839    /**
21840     * Append a new item on a given index widget.
21841     *
21842     * @param obj The index object.
21843     * @param letter Letter under which the item should be indexed
21844     * @param item The item data to set for the index's item
21845     *
21846     * Despite the most common usage of the @p letter argument is for
21847     * single char strings, one could use arbitrary strings as index
21848     * entries.
21849     *
21850     * @c item will be the pointer returned back on @c "changed", @c
21851     * "delay,changed" and @c "selected" smart events.
21852     *
21853     * @ingroup Index
21854     */
21855    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21856
21857    /**
21858     * Prepend a new item on a given index widget.
21859     *
21860     * @param obj The index object.
21861     * @param letter Letter under which the item should be indexed
21862     * @param item The item data to set for the index's item
21863     *
21864     * Despite the most common usage of the @p letter argument is for
21865     * single char strings, one could use arbitrary strings as index
21866     * entries.
21867     *
21868     * @c item will be the pointer returned back on @c "changed", @c
21869     * "delay,changed" and @c "selected" smart events.
21870     *
21871     * @ingroup Index
21872     */
21873    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21874
21875    /**
21876     * Append a new item, on a given index widget, <b>after the item
21877     * having @p relative as data</b>.
21878     *
21879     * @param obj The index object.
21880     * @param letter Letter under which the item should be indexed
21881     * @param item The item data to set for the index's item
21882     * @param relative The item data of the index item to be the
21883     * predecessor of this new one
21884     *
21885     * Despite the most common usage of the @p letter argument is for
21886     * single char strings, one could use arbitrary strings as index
21887     * entries.
21888     *
21889     * @c item will be the pointer returned back on @c "changed", @c
21890     * "delay,changed" and @c "selected" smart events.
21891     *
21892     * @note If @p relative is @c NULL or if it's not found to be data
21893     * set on any previous item on @p obj, this function will behave as
21894     * elm_index_item_append().
21895     *
21896     * @ingroup Index
21897     */
21898    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21899
21900    /**
21901     * Prepend a new item, on a given index widget, <b>after the item
21902     * having @p relative as data</b>.
21903     *
21904     * @param obj The index object.
21905     * @param letter Letter under which the item should be indexed
21906     * @param item The item data to set for the index's item
21907     * @param relative The item data of the index item to be the
21908     * successor of this new one
21909     *
21910     * Despite the most common usage of the @p letter argument is for
21911     * single char strings, one could use arbitrary strings as index
21912     * entries.
21913     *
21914     * @c item will be the pointer returned back on @c "changed", @c
21915     * "delay,changed" and @c "selected" smart events.
21916     *
21917     * @note If @p relative is @c NULL or if it's not found to be data
21918     * set on any previous item on @p obj, this function will behave as
21919     * elm_index_item_prepend().
21920     *
21921     * @ingroup Index
21922     */
21923    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21924
21925    /**
21926     * Insert a new item into the given index widget, using @p cmp_func
21927     * function to sort items (by item handles).
21928     *
21929     * @param obj The index object.
21930     * @param letter Letter under which the item should be indexed
21931     * @param item The item data to set for the index's item
21932     * @param cmp_func The comparing function to be used to sort index
21933     * items <b>by #Elm_Index_Item item handles</b>
21934     * @param cmp_data_func A @b fallback function to be called for the
21935     * sorting of index items <b>by item data</b>). It will be used
21936     * when @p cmp_func returns @c 0 (equality), which means an index
21937     * item with provided item data already exists. To decide which
21938     * data item should be pointed to by the index item in question, @p
21939     * cmp_data_func will be used. If @p cmp_data_func returns a
21940     * non-negative value, the previous index item data will be
21941     * replaced by the given @p item pointer. If the previous data need
21942     * to be freed, it should be done by the @p cmp_data_func function,
21943     * because all references to it will be lost. If this function is
21944     * not provided (@c NULL is given), index items will be @b
21945     * duplicated, if @p cmp_func returns @c 0.
21946     *
21947     * Despite the most common usage of the @p letter argument is for
21948     * single char strings, one could use arbitrary strings as index
21949     * entries.
21950     *
21951     * @c item will be the pointer returned back on @c "changed", @c
21952     * "delay,changed" and @c "selected" smart events.
21953     *
21954     * @ingroup Index
21955     */
21956    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);
21957
21958    /**
21959     * Remove an item from a given index widget, <b>to be referenced by
21960     * it's data value</b>.
21961     *
21962     * @param obj The index object
21963     * @param item The item's data pointer for the item to be removed
21964     * from @p obj
21965     *
21966     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21967     * that callback function will be called by this one.
21968     *
21969     * @warning The item to be removed from @p obj will be found via
21970     * its item data pointer, and not by an #Elm_Index_Item handle.
21971     *
21972     * @ingroup Index
21973     */
21974    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21975
21976    /**
21977     * Find a given index widget's item, <b>using item data</b>.
21978     *
21979     * @param obj The index object
21980     * @param item The item data pointed to by the desired index item
21981     * @return The index item handle, if found, or @c NULL otherwise
21982     *
21983     * @ingroup Index
21984     */
21985    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21986
21987    /**
21988     * Removes @b all items from a given index widget.
21989     *
21990     * @param obj The index object.
21991     *
21992     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21993     * that callback function will be called for each item in @p obj.
21994     *
21995     * @ingroup Index
21996     */
21997    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21998
21999    /**
22000     * Go to a given items level on a index widget
22001     *
22002     * @param obj The index object
22003     * @param level The index level (one of @c 0 or @c 1)
22004     *
22005     * @ingroup Index
22006     */
22007    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22008
22009    /**
22010     * Return the data associated with a given index widget item
22011     *
22012     * @param it The index widget item handle
22013     * @return The data associated with @p it
22014     *
22015     * @see elm_index_item_data_set()
22016     *
22017     * @ingroup Index
22018     */
22019    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22020
22021    /**
22022     * Set the data associated with a given index widget item
22023     *
22024     * @param it The index widget item handle
22025     * @param data The new data pointer to set to @p it
22026     *
22027     * This sets new item data on @p it.
22028     *
22029     * @warning The old data pointer won't be touched by this function, so
22030     * the user had better to free that old data himself/herself.
22031     *
22032     * @ingroup Index
22033     */
22034    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22035
22036    /**
22037     * Set the function to be called when a given index widget item is freed.
22038     *
22039     * @param it The item to set the callback on
22040     * @param func The function to call on the item's deletion
22041     *
22042     * When called, @p func will have both @c data and @c event_info
22043     * arguments with the @p it item's data value and, naturally, the
22044     * @c obj argument with a handle to the parent index widget.
22045     *
22046     * @ingroup Index
22047     */
22048    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22049
22050    /**
22051     * Get the letter (string) set on a given index widget item.
22052     *
22053     * @param it The index item handle
22054     * @return The letter string set on @p it
22055     *
22056     * @ingroup Index
22057     */
22058    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22059
22060    /**
22061     */
22062    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22063
22064    /**
22065     * @}
22066     */
22067
22068    /**
22069     * @defgroup Photocam Photocam
22070     *
22071     * @image html img/widget/photocam/preview-00.png
22072     * @image latex img/widget/photocam/preview-00.eps
22073     *
22074     * This is a widget specifically for displaying high-resolution digital
22075     * camera photos giving speedy feedback (fast load), low memory footprint
22076     * and zooming and panning as well as fitting logic. It is entirely focused
22077     * on jpeg images, and takes advantage of properties of the jpeg format (via
22078     * evas loader features in the jpeg loader).
22079     *
22080     * Signals that you can add callbacks for are:
22081     * @li "clicked" - This is called when a user has clicked the photo without
22082     *                 dragging around.
22083     * @li "press" - This is called when a user has pressed down on the photo.
22084     * @li "longpressed" - This is called when a user has pressed down on the
22085     *                     photo for a long time without dragging around.
22086     * @li "clicked,double" - This is called when a user has double-clicked the
22087     *                        photo.
22088     * @li "load" - Photo load begins.
22089     * @li "loaded" - This is called when the image file load is complete for the
22090     *                first view (low resolution blurry version).
22091     * @li "load,detail" - Photo detailed data load begins.
22092     * @li "loaded,detail" - This is called when the image file load is complete
22093     *                      for the detailed image data (full resolution needed).
22094     * @li "zoom,start" - Zoom animation started.
22095     * @li "zoom,stop" - Zoom animation stopped.
22096     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22097     * @li "scroll" - the content has been scrolled (moved)
22098     * @li "scroll,anim,start" - scrolling animation has started
22099     * @li "scroll,anim,stop" - scrolling animation has stopped
22100     * @li "scroll,drag,start" - dragging the contents around has started
22101     * @li "scroll,drag,stop" - dragging the contents around has stopped
22102     *
22103     * @ref tutorial_photocam shows the API in action.
22104     * @{
22105     */
22106    /**
22107     * @brief Types of zoom available.
22108     */
22109    typedef enum _Elm_Photocam_Zoom_Mode
22110      {
22111         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22112         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22113         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22114         ELM_PHOTOCAM_ZOOM_MODE_LAST
22115      } Elm_Photocam_Zoom_Mode;
22116    /**
22117     * @brief Add a new Photocam object
22118     *
22119     * @param parent The parent object
22120     * @return The new object or NULL if it cannot be created
22121     */
22122    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22123    /**
22124     * @brief Set the photo file to be shown
22125     *
22126     * @param obj The photocam object
22127     * @param file The photo file
22128     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22129     *
22130     * This sets (and shows) the specified file (with a relative or absolute
22131     * path) and will return a load error (same error that
22132     * evas_object_image_load_error_get() will return). The image will change and
22133     * adjust its size at this point and begin a background load process for this
22134     * photo that at some time in the future will be displayed at the full
22135     * quality needed.
22136     */
22137    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22138    /**
22139     * @brief Returns the path of the current image file
22140     *
22141     * @param obj The photocam object
22142     * @return Returns the path
22143     *
22144     * @see elm_photocam_file_set()
22145     */
22146    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22147    /**
22148     * @brief Set the zoom level of the photo
22149     *
22150     * @param obj The photocam object
22151     * @param zoom The zoom level to set
22152     *
22153     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22154     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22155     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22156     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22157     * 16, 32, etc.).
22158     */
22159    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22160    /**
22161     * @brief Get the zoom level of the photo
22162     *
22163     * @param obj The photocam object
22164     * @return The current zoom level
22165     *
22166     * This returns the current zoom level of the photocam object. Note that if
22167     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22168     * (which is the default), the zoom level may be changed at any time by the
22169     * photocam object itself to account for photo size and photocam viewpoer
22170     * size.
22171     *
22172     * @see elm_photocam_zoom_set()
22173     * @see elm_photocam_zoom_mode_set()
22174     */
22175    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22176    /**
22177     * @brief Set the zoom mode
22178     *
22179     * @param obj The photocam object
22180     * @param mode The desired mode
22181     *
22182     * This sets the zoom mode to manual or one of several automatic levels.
22183     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22184     * elm_photocam_zoom_set() and will stay at that level until changed by code
22185     * or until zoom mode is changed. This is the default mode. The Automatic
22186     * modes will allow the photocam object to automatically adjust zoom mode
22187     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22188     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22189     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22190     * pixels within the frame are left unfilled.
22191     */
22192    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22193    /**
22194     * @brief Get the zoom mode
22195     *
22196     * @param obj The photocam object
22197     * @return The current zoom mode
22198     *
22199     * This gets the current zoom mode of the photocam object.
22200     *
22201     * @see elm_photocam_zoom_mode_set()
22202     */
22203    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22204    /**
22205     * @brief Get the current image pixel width and height
22206     *
22207     * @param obj The photocam object
22208     * @param w A pointer to the width return
22209     * @param h A pointer to the height return
22210     *
22211     * This gets the current photo pixel width and height (for the original).
22212     * The size will be returned in the integers @p w and @p h that are pointed
22213     * to.
22214     */
22215    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22216    /**
22217     * @brief Get the area of the image that is currently shown
22218     *
22219     * @param obj
22220     * @param x A pointer to the X-coordinate of region
22221     * @param y A pointer to the Y-coordinate of region
22222     * @param w A pointer to the width
22223     * @param h A pointer to the height
22224     *
22225     * @see elm_photocam_image_region_show()
22226     * @see elm_photocam_image_region_bring_in()
22227     */
22228    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22229    /**
22230     * @brief Set the viewed portion of the image
22231     *
22232     * @param obj The photocam object
22233     * @param x X-coordinate of region in image original pixels
22234     * @param y Y-coordinate of region in image original pixels
22235     * @param w Width of region in image original pixels
22236     * @param h Height of region in image original pixels
22237     *
22238     * This shows the region of the image without using animation.
22239     */
22240    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22241    /**
22242     * @brief Bring in the viewed portion of the image
22243     *
22244     * @param obj The photocam object
22245     * @param x X-coordinate of region in image original pixels
22246     * @param y Y-coordinate of region in image original pixels
22247     * @param w Width of region in image original pixels
22248     * @param h Height of region in image original pixels
22249     *
22250     * This shows the region of the image using animation.
22251     */
22252    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22253    /**
22254     * @brief Set the paused state for photocam
22255     *
22256     * @param obj The photocam object
22257     * @param paused The pause state to set
22258     *
22259     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22260     * photocam. The default is off. This will stop zooming using animation on
22261     * zoom levels changes and change instantly. This will stop any existing
22262     * animations that are running.
22263     */
22264    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22265    /**
22266     * @brief Get the paused state for photocam
22267     *
22268     * @param obj The photocam object
22269     * @return The current paused state
22270     *
22271     * This gets the current paused state for the photocam object.
22272     *
22273     * @see elm_photocam_paused_set()
22274     */
22275    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22276    /**
22277     * @brief Get the internal low-res image used for photocam
22278     *
22279     * @param obj The photocam object
22280     * @return The internal image object handle, or NULL if none exists
22281     *
22282     * This gets the internal image object inside photocam. Do not modify it. It
22283     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22284     * deleted at any time as well.
22285     */
22286    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22287    /**
22288     * @brief Set the photocam scrolling bouncing.
22289     *
22290     * @param obj The photocam object
22291     * @param h_bounce bouncing for horizontal
22292     * @param v_bounce bouncing for vertical
22293     */
22294    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22295    /**
22296     * @brief Get the photocam scrolling bouncing.
22297     *
22298     * @param obj The photocam object
22299     * @param h_bounce bouncing for horizontal
22300     * @param v_bounce bouncing for vertical
22301     *
22302     * @see elm_photocam_bounce_set()
22303     */
22304    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22305    /**
22306     * @}
22307     */
22308
22309    /**
22310     * @defgroup Map Map
22311     * @ingroup Elementary
22312     *
22313     * @image html img/widget/map/preview-00.png
22314     * @image latex img/widget/map/preview-00.eps
22315     *
22316     * This is a widget specifically for displaying a map. It uses basically
22317     * OpenStreetMap provider http://www.openstreetmap.org/,
22318     * but custom providers can be added.
22319     *
22320     * It supports some basic but yet nice features:
22321     * @li zoom and scroll
22322     * @li markers with content to be displayed when user clicks over it
22323     * @li group of markers
22324     * @li routes
22325     *
22326     * Smart callbacks one can listen to:
22327     *
22328     * - "clicked" - This is called when a user has clicked the map without
22329     *   dragging around.
22330     * - "press" - This is called when a user has pressed down on the map.
22331     * - "longpressed" - This is called when a user has pressed down on the map
22332     *   for a long time without dragging around.
22333     * - "clicked,double" - This is called when a user has double-clicked
22334     *   the map.
22335     * - "load,detail" - Map detailed data load begins.
22336     * - "loaded,detail" - This is called when all currently visible parts of
22337     *   the map are loaded.
22338     * - "zoom,start" - Zoom animation started.
22339     * - "zoom,stop" - Zoom animation stopped.
22340     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22341     * - "scroll" - the content has been scrolled (moved).
22342     * - "scroll,anim,start" - scrolling animation has started.
22343     * - "scroll,anim,stop" - scrolling animation has stopped.
22344     * - "scroll,drag,start" - dragging the contents around has started.
22345     * - "scroll,drag,stop" - dragging the contents around has stopped.
22346     * - "downloaded" - This is called when all currently required map images
22347     *   are downloaded.
22348     * - "route,load" - This is called when route request begins.
22349     * - "route,loaded" - This is called when route request ends.
22350     * - "name,load" - This is called when name request begins.
22351     * - "name,loaded- This is called when name request ends.
22352     *
22353     * Available style for map widget:
22354     * - @c "default"
22355     *
22356     * Available style for markers:
22357     * - @c "radio"
22358     * - @c "radio2"
22359     * - @c "empty"
22360     *
22361     * Available style for marker bubble:
22362     * - @c "default"
22363     *
22364     * List of examples:
22365     * @li @ref map_example_01
22366     * @li @ref map_example_02
22367     * @li @ref map_example_03
22368     */
22369
22370    /**
22371     * @addtogroup Map
22372     * @{
22373     */
22374
22375    /**
22376     * @enum _Elm_Map_Zoom_Mode
22377     * @typedef Elm_Map_Zoom_Mode
22378     *
22379     * Set map's zoom behavior. It can be set to manual or automatic.
22380     *
22381     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22382     *
22383     * Values <b> don't </b> work as bitmask, only one can be choosen.
22384     *
22385     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22386     * than the scroller view.
22387     *
22388     * @see elm_map_zoom_mode_set()
22389     * @see elm_map_zoom_mode_get()
22390     *
22391     * @ingroup Map
22392     */
22393    typedef enum _Elm_Map_Zoom_Mode
22394      {
22395         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22396         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22397         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22398         ELM_MAP_ZOOM_MODE_LAST
22399      } Elm_Map_Zoom_Mode;
22400
22401    /**
22402     * @enum _Elm_Map_Route_Sources
22403     * @typedef Elm_Map_Route_Sources
22404     *
22405     * Set route service to be used. By default used source is
22406     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22407     *
22408     * @see elm_map_route_source_set()
22409     * @see elm_map_route_source_get()
22410     *
22411     * @ingroup Map
22412     */
22413    typedef enum _Elm_Map_Route_Sources
22414      {
22415         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22416         ELM_MAP_ROUTE_SOURCE_MONAV, /**< MoNav offers exact routing without heuristic assumptions. Its routing core is based on Contraction Hierarchies. It's not working with Map yet. */
22417         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22418         ELM_MAP_ROUTE_SOURCE_LAST
22419      } Elm_Map_Route_Sources;
22420
22421    typedef enum _Elm_Map_Name_Sources
22422      {
22423         ELM_MAP_NAME_SOURCE_NOMINATIM,
22424         ELM_MAP_NAME_SOURCE_LAST
22425      } Elm_Map_Name_Sources;
22426
22427    /**
22428     * @enum _Elm_Map_Route_Type
22429     * @typedef Elm_Map_Route_Type
22430     *
22431     * Set type of transport used on route.
22432     *
22433     * @see elm_map_route_add()
22434     *
22435     * @ingroup Map
22436     */
22437    typedef enum _Elm_Map_Route_Type
22438      {
22439         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22440         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22441         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22442         ELM_MAP_ROUTE_TYPE_LAST
22443      } Elm_Map_Route_Type;
22444
22445    /**
22446     * @enum _Elm_Map_Route_Method
22447     * @typedef Elm_Map_Route_Method
22448     *
22449     * Set the routing method, what should be priorized, time or distance.
22450     *
22451     * @see elm_map_route_add()
22452     *
22453     * @ingroup Map
22454     */
22455    typedef enum _Elm_Map_Route_Method
22456      {
22457         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22458         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22459         ELM_MAP_ROUTE_METHOD_LAST
22460      } Elm_Map_Route_Method;
22461
22462    typedef enum _Elm_Map_Name_Method
22463      {
22464         ELM_MAP_NAME_METHOD_SEARCH,
22465         ELM_MAP_NAME_METHOD_REVERSE,
22466         ELM_MAP_NAME_METHOD_LAST
22467      } Elm_Map_Name_Method;
22468
22469    typedef struct _Elm_Map_Marker          Elm_Map_Marker; /**< A marker to be shown in a specific point of the map. Can be created with elm_map_marker_add() and deleted with elm_map_marker_remove(). */
22470    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class; /**< Each marker must be associated to a class. It's required to add a mark. The class defines the style of the marker when a marker is displayed alone (not grouped). A new class can be created with elm_map_marker_class_new(). */
22471    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class; /**< Each marker must be associated to a group class. It's required to add a mark. The group class defines the style of the marker when a marker is grouped to other markers. Markers with the same group are grouped if they are close. A new group class can be created with elm_map_marker_group_class_new(). */
22472    typedef struct _Elm_Map_Route           Elm_Map_Route; /**< A route to be shown in the map. Can be created with elm_map_route_add() and deleted with elm_map_route_remove(). */
22473    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22474    typedef struct _Elm_Map_Track           Elm_Map_Track;
22475
22476    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Bubble content fetching class function for marker classes. When the user click on a marker, a bubble is displayed with a content. */
22477    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22478    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22479    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22480
22481    typedef char        *(*ElmMapModuleSourceFunc) (void);
22482    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22483    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22484    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22485    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22486    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22487    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22488    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22489    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22490
22491    /**
22492     * Add a new map widget to the given parent Elementary (container) object.
22493     *
22494     * @param parent The parent object.
22495     * @return a new map widget handle or @c NULL, on errors.
22496     *
22497     * This function inserts a new map widget on the canvas.
22498     *
22499     * @ingroup Map
22500     */
22501    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22502
22503    /**
22504     * Set the zoom level of the map.
22505     *
22506     * @param obj The map object.
22507     * @param zoom The zoom level to set.
22508     *
22509     * This sets the zoom level.
22510     *
22511     * It will respect limits defined by elm_map_source_zoom_min_set() and
22512     * elm_map_source_zoom_max_set().
22513     *
22514     * By default these values are 0 (world map) and 18 (maximum zoom).
22515     *
22516     * This function should be used when zoom mode is set to
22517     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22518     * with elm_map_zoom_mode_set().
22519     *
22520     * @see elm_map_zoom_mode_set().
22521     * @see elm_map_zoom_get().
22522     *
22523     * @ingroup Map
22524     */
22525    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22526
22527    /**
22528     * Get the zoom level of the map.
22529     *
22530     * @param obj The map object.
22531     * @return The current zoom level.
22532     *
22533     * This returns the current zoom level of the map object.
22534     *
22535     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22536     * (which is the default), the zoom level may be changed at any time by the
22537     * map object itself to account for map size and map viewport size.
22538     *
22539     * @see elm_map_zoom_set() for details.
22540     *
22541     * @ingroup Map
22542     */
22543    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22544
22545    /**
22546     * Set the zoom mode used by the map object.
22547     *
22548     * @param obj The map object.
22549     * @param mode The zoom mode of the map, being it one of
22550     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22551     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22552     *
22553     * This sets the zoom mode to manual or one of the automatic levels.
22554     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22555     * elm_map_zoom_set() and will stay at that level until changed by code
22556     * or until zoom mode is changed. This is the default mode.
22557     *
22558     * The Automatic modes will allow the map object to automatically
22559     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22560     * adjust zoom so the map fits inside the scroll frame with no pixels
22561     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22562     * ensure no pixels within the frame are left unfilled. Do not forget that
22563     * the valid sizes are 2^zoom, consequently the map may be smaller than
22564     * the scroller view.
22565     *
22566     * @see elm_map_zoom_set()
22567     *
22568     * @ingroup Map
22569     */
22570    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22571
22572    /**
22573     * Get the zoom mode used by the map object.
22574     *
22575     * @param obj The map object.
22576     * @return The zoom mode of the map, being it one of
22577     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22578     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22579     *
22580     * This function returns the current zoom mode used by the map object.
22581     *
22582     * @see elm_map_zoom_mode_set() for more details.
22583     *
22584     * @ingroup Map
22585     */
22586    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22587
22588    /**
22589     * Get the current coordinates of the map.
22590     *
22591     * @param obj The map object.
22592     * @param lon Pointer where to store longitude.
22593     * @param lat Pointer where to store latitude.
22594     *
22595     * This gets the current center coordinates of the map object. It can be
22596     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22597     *
22598     * @see elm_map_geo_region_bring_in()
22599     * @see elm_map_geo_region_show()
22600     *
22601     * @ingroup Map
22602     */
22603    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22604
22605    /**
22606     * Animatedly bring in given coordinates to the center of the map.
22607     *
22608     * @param obj The map object.
22609     * @param lon Longitude to center at.
22610     * @param lat Latitude to center at.
22611     *
22612     * This causes map to jump to the given @p lat and @p lon coordinates
22613     * and show it (by scrolling) in the center of the viewport, if it is not
22614     * already centered. This will use animation to do so and take a period
22615     * of time to complete.
22616     *
22617     * @see elm_map_geo_region_show() for a function to avoid animation.
22618     * @see elm_map_geo_region_get()
22619     *
22620     * @ingroup Map
22621     */
22622    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22623
22624    /**
22625     * Show the given coordinates at the center of the map, @b immediately.
22626     *
22627     * @param obj The map object.
22628     * @param lon Longitude to center at.
22629     * @param lat Latitude to center at.
22630     *
22631     * This causes map to @b redraw its viewport's contents to the
22632     * region contining the given @p lat and @p lon, that will be moved to the
22633     * center of the map.
22634     *
22635     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22636     * @see elm_map_geo_region_get()
22637     *
22638     * @ingroup Map
22639     */
22640    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22641
22642    /**
22643     * Pause or unpause the map.
22644     *
22645     * @param obj The map object.
22646     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22647     * to unpause it.
22648     *
22649     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22650     * for map.
22651     *
22652     * The default is off.
22653     *
22654     * This will stop zooming using animation, changing zoom levels will
22655     * change instantly. This will stop any existing animations that are running.
22656     *
22657     * @see elm_map_paused_get()
22658     *
22659     * @ingroup Map
22660     */
22661    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22662
22663    /**
22664     * Get a value whether map is paused or not.
22665     *
22666     * @param obj The map object.
22667     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22668     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22669     *
22670     * This gets the current paused state for the map object.
22671     *
22672     * @see elm_map_paused_set() for details.
22673     *
22674     * @ingroup Map
22675     */
22676    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22677
22678    /**
22679     * Set to show markers during zoom level changes or not.
22680     *
22681     * @param obj The map object.
22682     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22683     * to show them.
22684     *
22685     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22686     * for map.
22687     *
22688     * The default is off.
22689     *
22690     * This will stop zooming using animation, changing zoom levels will
22691     * change instantly. This will stop any existing animations that are running.
22692     *
22693     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22694     * for the markers.
22695     *
22696     * The default  is off.
22697     *
22698     * Enabling it will force the map to stop displaying the markers during
22699     * zoom level changes. Set to on if you have a large number of markers.
22700     *
22701     * @see elm_map_paused_markers_get()
22702     *
22703     * @ingroup Map
22704     */
22705    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22706
22707    /**
22708     * Get a value whether markers will be displayed on zoom level changes or not
22709     *
22710     * @param obj The map object.
22711     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22712     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22713     *
22714     * This gets the current markers paused state for the map object.
22715     *
22716     * @see elm_map_paused_markers_set() for details.
22717     *
22718     * @ingroup Map
22719     */
22720    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22721
22722    /**
22723     * Get the information of downloading status.
22724     *
22725     * @param obj The map object.
22726     * @param try_num Pointer where to store number of tiles being downloaded.
22727     * @param finish_num Pointer where to store number of tiles successfully
22728     * downloaded.
22729     *
22730     * This gets the current downloading status for the map object, the number
22731     * of tiles being downloaded and the number of tiles already downloaded.
22732     *
22733     * @ingroup Map
22734     */
22735    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22736
22737    /**
22738     * Convert a pixel coordinate (x,y) into a geographic coordinate
22739     * (longitude, latitude).
22740     *
22741     * @param obj The map object.
22742     * @param x the coordinate.
22743     * @param y the coordinate.
22744     * @param size the size in pixels of the map.
22745     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22746     * @param lon Pointer where to store the longitude that correspond to x.
22747     * @param lat Pointer where to store the latitude that correspond to y.
22748     *
22749     * @note Origin pixel point is the top left corner of the viewport.
22750     * Map zoom and size are taken on account.
22751     *
22752     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22753     *
22754     * @ingroup Map
22755     */
22756    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);
22757
22758    /**
22759     * Convert a geographic coordinate (longitude, latitude) into a pixel
22760     * coordinate (x, y).
22761     *
22762     * @param obj The map object.
22763     * @param lon the longitude.
22764     * @param lat the latitude.
22765     * @param size the size in pixels of the map. The map is a square
22766     * and generally his size is : pow(2.0, zoom)*256.
22767     * @param x Pointer where to store the horizontal pixel coordinate that
22768     * correspond to the longitude.
22769     * @param y Pointer where to store the vertical pixel coordinate that
22770     * correspond to the latitude.
22771     *
22772     * @note Origin pixel point is the top left corner of the viewport.
22773     * Map zoom and size are taken on account.
22774     *
22775     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22776     *
22777     * @ingroup Map
22778     */
22779    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);
22780
22781    /**
22782     * Convert a geographic coordinate (longitude, latitude) into a name
22783     * (address).
22784     *
22785     * @param obj The map object.
22786     * @param lon the longitude.
22787     * @param lat the latitude.
22788     * @return name A #Elm_Map_Name handle for this coordinate.
22789     *
22790     * To get the string for this address, elm_map_name_address_get()
22791     * should be used.
22792     *
22793     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22794     *
22795     * @ingroup Map
22796     */
22797    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22798
22799    /**
22800     * Convert a name (address) into a geographic coordinate
22801     * (longitude, latitude).
22802     *
22803     * @param obj The map object.
22804     * @param name The address.
22805     * @return name A #Elm_Map_Name handle for this address.
22806     *
22807     * To get the longitude and latitude, elm_map_name_region_get()
22808     * should be used.
22809     *
22810     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22811     *
22812     * @ingroup Map
22813     */
22814    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22815
22816    /**
22817     * Convert a pixel coordinate into a rotated pixel coordinate.
22818     *
22819     * @param obj The map object.
22820     * @param x horizontal coordinate of the point to rotate.
22821     * @param y vertical coordinate of the point to rotate.
22822     * @param cx rotation's center horizontal position.
22823     * @param cy rotation's center vertical position.
22824     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22825     * @param xx Pointer where to store rotated x.
22826     * @param yy Pointer where to store rotated y.
22827     *
22828     * @ingroup Map
22829     */
22830    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);
22831
22832    /**
22833     * Add a new marker to the map object.
22834     *
22835     * @param obj The map object.
22836     * @param lon The longitude of the marker.
22837     * @param lat The latitude of the marker.
22838     * @param clas The class, to use when marker @b isn't grouped to others.
22839     * @param clas_group The class group, to use when marker is grouped to others
22840     * @param data The data passed to the callbacks.
22841     *
22842     * @return The created marker or @c NULL upon failure.
22843     *
22844     * A marker will be created and shown in a specific point of the map, defined
22845     * by @p lon and @p lat.
22846     *
22847     * It will be displayed using style defined by @p class when this marker
22848     * is displayed alone (not grouped). A new class can be created with
22849     * elm_map_marker_class_new().
22850     *
22851     * If the marker is grouped to other markers, it will be displayed with
22852     * style defined by @p class_group. Markers with the same group are grouped
22853     * if they are close. A new group class can be created with
22854     * elm_map_marker_group_class_new().
22855     *
22856     * Markers created with this method can be deleted with
22857     * elm_map_marker_remove().
22858     *
22859     * A marker can have associated content to be displayed by a bubble,
22860     * when a user click over it, as well as an icon. These objects will
22861     * be fetch using class' callback functions.
22862     *
22863     * @see elm_map_marker_class_new()
22864     * @see elm_map_marker_group_class_new()
22865     * @see elm_map_marker_remove()
22866     *
22867     * @ingroup Map
22868     */
22869    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);
22870
22871    /**
22872     * Set the maximum numbers of markers' content to be displayed in a group.
22873     *
22874     * @param obj The map object.
22875     * @param max The maximum numbers of items displayed in a bubble.
22876     *
22877     * A bubble will be displayed when the user clicks over the group,
22878     * and will place the content of markers that belong to this group
22879     * inside it.
22880     *
22881     * A group can have a long list of markers, consequently the creation
22882     * of the content of the bubble can be very slow.
22883     *
22884     * In order to avoid this, a maximum number of items is displayed
22885     * in a bubble.
22886     *
22887     * By default this number is 30.
22888     *
22889     * Marker with the same group class are grouped if they are close.
22890     *
22891     * @see elm_map_marker_add()
22892     *
22893     * @ingroup Map
22894     */
22895    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22896
22897    /**
22898     * Remove a marker from the map.
22899     *
22900     * @param marker The marker to remove.
22901     *
22902     * @see elm_map_marker_add()
22903     *
22904     * @ingroup Map
22905     */
22906    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22907
22908    /**
22909     * Get the current coordinates of the marker.
22910     *
22911     * @param marker marker.
22912     * @param lat Pointer where to store the marker's latitude.
22913     * @param lon Pointer where to store the marker's longitude.
22914     *
22915     * These values are set when adding markers, with function
22916     * elm_map_marker_add().
22917     *
22918     * @see elm_map_marker_add()
22919     *
22920     * @ingroup Map
22921     */
22922    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22923
22924    /**
22925     * Animatedly bring in given marker to the center of the map.
22926     *
22927     * @param marker The marker to center at.
22928     *
22929     * This causes map to jump to the given @p marker's coordinates
22930     * and show it (by scrolling) in the center of the viewport, if it is not
22931     * already centered. This will use animation to do so and take a period
22932     * of time to complete.
22933     *
22934     * @see elm_map_marker_show() for a function to avoid animation.
22935     * @see elm_map_marker_region_get()
22936     *
22937     * @ingroup Map
22938     */
22939    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22940
22941    /**
22942     * Show the given marker at the center of the map, @b immediately.
22943     *
22944     * @param marker The marker to center at.
22945     *
22946     * This causes map to @b redraw its viewport's contents to the
22947     * region contining the given @p marker's coordinates, that will be
22948     * moved to the center of the map.
22949     *
22950     * @see elm_map_marker_bring_in() for a function to move with animation.
22951     * @see elm_map_markers_list_show() if more than one marker need to be
22952     * displayed.
22953     * @see elm_map_marker_region_get()
22954     *
22955     * @ingroup Map
22956     */
22957    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22958
22959    /**
22960     * Move and zoom the map to display a list of markers.
22961     *
22962     * @param markers A list of #Elm_Map_Marker handles.
22963     *
22964     * The map will be centered on the center point of the markers in the list.
22965     * Then the map will be zoomed in order to fit the markers using the maximum
22966     * zoom which allows display of all the markers.
22967     *
22968     * @warning All the markers should belong to the same map object.
22969     *
22970     * @see elm_map_marker_show() to show a single marker.
22971     * @see elm_map_marker_bring_in()
22972     *
22973     * @ingroup Map
22974     */
22975    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22976
22977    /**
22978     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22979     *
22980     * @param marker The marker wich content should be returned.
22981     * @return Return the evas object if it exists, else @c NULL.
22982     *
22983     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22984     * elm_map_marker_class_get_cb_set() should be used.
22985     *
22986     * This content is what will be inside the bubble that will be displayed
22987     * when an user clicks over the marker.
22988     *
22989     * This returns the actual Evas object used to be placed inside
22990     * the bubble. This may be @c NULL, as it may
22991     * not have been created or may have been deleted, at any time, by
22992     * the map. <b>Do not modify this object</b> (move, resize,
22993     * show, hide, etc.), as the map is controlling it. This
22994     * function is for querying, emitting custom signals or hooking
22995     * lower level callbacks for events on that object. Do not delete
22996     * this object under any circumstances.
22997     *
22998     * @ingroup Map
22999     */
23000    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23001
23002    /**
23003     * Update the marker
23004     *
23005     * @param marker The marker to be updated.
23006     *
23007     * If a content is set to this marker, it will call function to delete it,
23008     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23009     * #ElmMapMarkerGetFunc.
23010     *
23011     * These functions are set for the marker class with
23012     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23013     *
23014     * @ingroup Map
23015     */
23016    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23017
23018    /**
23019     * Close all the bubbles opened by the user.
23020     *
23021     * @param obj The map object.
23022     *
23023     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23024     * when the user clicks on a marker.
23025     *
23026     * This functions is set for the marker class with
23027     * elm_map_marker_class_get_cb_set().
23028     *
23029     * @ingroup Map
23030     */
23031    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23032
23033    /**
23034     * Create a new group class.
23035     *
23036     * @param obj The map object.
23037     * @return Returns the new group class.
23038     *
23039     * Each marker must be associated to a group class. Markers in the same
23040     * group are grouped if they are close.
23041     *
23042     * The group class defines the style of the marker when a marker is grouped
23043     * to others markers. When it is alone, another class will be used.
23044     *
23045     * A group class will need to be provided when creating a marker with
23046     * elm_map_marker_add().
23047     *
23048     * Some properties and functions can be set by class, as:
23049     * - style, with elm_map_group_class_style_set()
23050     * - data - to be associated to the group class. It can be set using
23051     *   elm_map_group_class_data_set().
23052     * - min zoom to display markers, set with
23053     *   elm_map_group_class_zoom_displayed_set().
23054     * - max zoom to group markers, set using
23055     *   elm_map_group_class_zoom_grouped_set().
23056     * - visibility - set if markers will be visible or not, set with
23057     *   elm_map_group_class_hide_set().
23058     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23059     *   It can be set using elm_map_group_class_icon_cb_set().
23060     *
23061     * @see elm_map_marker_add()
23062     * @see elm_map_group_class_style_set()
23063     * @see elm_map_group_class_data_set()
23064     * @see elm_map_group_class_zoom_displayed_set()
23065     * @see elm_map_group_class_zoom_grouped_set()
23066     * @see elm_map_group_class_hide_set()
23067     * @see elm_map_group_class_icon_cb_set()
23068     *
23069     * @ingroup Map
23070     */
23071    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23072
23073    /**
23074     * Set the marker's style of a group class.
23075     *
23076     * @param clas The group class.
23077     * @param style The style to be used by markers.
23078     *
23079     * Each marker must be associated to a group class, and will use the style
23080     * defined by such class when grouped to other markers.
23081     *
23082     * The following styles are provided by default theme:
23083     * @li @c radio - blue circle
23084     * @li @c radio2 - green circle
23085     * @li @c empty
23086     *
23087     * @see elm_map_group_class_new() for more details.
23088     * @see elm_map_marker_add()
23089     *
23090     * @ingroup Map
23091     */
23092    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23093
23094    /**
23095     * Set the icon callback function of a group class.
23096     *
23097     * @param clas The group class.
23098     * @param icon_get The callback function that will return the icon.
23099     *
23100     * Each marker must be associated to a group class, and it can display a
23101     * custom icon. The function @p icon_get must return this icon.
23102     *
23103     * @see elm_map_group_class_new() for more details.
23104     * @see elm_map_marker_add()
23105     *
23106     * @ingroup Map
23107     */
23108    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23109
23110    /**
23111     * Set the data associated to the group class.
23112     *
23113     * @param clas The group class.
23114     * @param data The new user data.
23115     *
23116     * This data will be passed for callback functions, like icon get callback,
23117     * that can be set with elm_map_group_class_icon_cb_set().
23118     *
23119     * If a data was previously set, the object will lose the pointer for it,
23120     * so if needs to be freed, you must do it yourself.
23121     *
23122     * @see elm_map_group_class_new() for more details.
23123     * @see elm_map_group_class_icon_cb_set()
23124     * @see elm_map_marker_add()
23125     *
23126     * @ingroup Map
23127     */
23128    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23129
23130    /**
23131     * Set the minimum zoom from where the markers are displayed.
23132     *
23133     * @param clas The group class.
23134     * @param zoom The minimum zoom.
23135     *
23136     * Markers only will be displayed when the map is displayed at @p zoom
23137     * or bigger.
23138     *
23139     * @see elm_map_group_class_new() for more details.
23140     * @see elm_map_marker_add()
23141     *
23142     * @ingroup Map
23143     */
23144    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23145
23146    /**
23147     * Set the zoom from where the markers are no more grouped.
23148     *
23149     * @param clas The group class.
23150     * @param zoom The maximum zoom.
23151     *
23152     * Markers only will be grouped when the map is displayed at
23153     * less than @p zoom.
23154     *
23155     * @see elm_map_group_class_new() for more details.
23156     * @see elm_map_marker_add()
23157     *
23158     * @ingroup Map
23159     */
23160    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23161
23162    /**
23163     * Set if the markers associated to the group class @clas are hidden or not.
23164     *
23165     * @param clas The group class.
23166     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23167     * to show them.
23168     *
23169     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23170     * is to show them.
23171     *
23172     * @ingroup Map
23173     */
23174    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23175
23176    /**
23177     * Create a new marker class.
23178     *
23179     * @param obj The map object.
23180     * @return Returns the new group class.
23181     *
23182     * Each marker must be associated to a class.
23183     *
23184     * The marker class defines the style of the marker when a marker is
23185     * displayed alone, i.e., not grouped to to others markers. When grouped
23186     * it will use group class style.
23187     *
23188     * A marker class will need to be provided when creating a marker with
23189     * elm_map_marker_add().
23190     *
23191     * Some properties and functions can be set by class, as:
23192     * - style, with elm_map_marker_class_style_set()
23193     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23194     *   It can be set using elm_map_marker_class_icon_cb_set().
23195     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23196     *   Set using elm_map_marker_class_get_cb_set().
23197     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23198     *   Set using elm_map_marker_class_del_cb_set().
23199     *
23200     * @see elm_map_marker_add()
23201     * @see elm_map_marker_class_style_set()
23202     * @see elm_map_marker_class_icon_cb_set()
23203     * @see elm_map_marker_class_get_cb_set()
23204     * @see elm_map_marker_class_del_cb_set()
23205     *
23206     * @ingroup Map
23207     */
23208    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23209
23210    /**
23211     * Set the marker's style of a marker class.
23212     *
23213     * @param clas The marker class.
23214     * @param style The style to be used by markers.
23215     *
23216     * Each marker must be associated to a marker class, and will use the style
23217     * defined by such class when alone, i.e., @b not grouped to other markers.
23218     *
23219     * The following styles are provided by default theme:
23220     * @li @c radio
23221     * @li @c radio2
23222     * @li @c empty
23223     *
23224     * @see elm_map_marker_class_new() for more details.
23225     * @see elm_map_marker_add()
23226     *
23227     * @ingroup Map
23228     */
23229    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23230
23231    /**
23232     * Set the icon callback function of a marker class.
23233     *
23234     * @param clas The marker class.
23235     * @param icon_get The callback function that will return the icon.
23236     *
23237     * Each marker must be associated to a marker class, and it can display a
23238     * custom icon. The function @p icon_get must return this icon.
23239     *
23240     * @see elm_map_marker_class_new() for more details.
23241     * @see elm_map_marker_add()
23242     *
23243     * @ingroup Map
23244     */
23245    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23246
23247    /**
23248     * Set the bubble content callback function of a marker class.
23249     *
23250     * @param clas The marker class.
23251     * @param get The callback function that will return the content.
23252     *
23253     * Each marker must be associated to a marker class, and it can display a
23254     * a content on a bubble that opens when the user click over the marker.
23255     * The function @p get must return this content object.
23256     *
23257     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23258     * can be used.
23259     *
23260     * @see elm_map_marker_class_new() for more details.
23261     * @see elm_map_marker_class_del_cb_set()
23262     * @see elm_map_marker_add()
23263     *
23264     * @ingroup Map
23265     */
23266    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23267
23268    /**
23269     * Set the callback function used to delete bubble content of a marker class.
23270     *
23271     * @param clas The marker class.
23272     * @param del The callback function that will delete the content.
23273     *
23274     * Each marker must be associated to a marker class, and it can display a
23275     * a content on a bubble that opens when the user click over the marker.
23276     * The function to return such content can be set with
23277     * elm_map_marker_class_get_cb_set().
23278     *
23279     * If this content must be freed, a callback function need to be
23280     * set for that task with this function.
23281     *
23282     * If this callback is defined it will have to delete (or not) the
23283     * object inside, but if the callback is not defined the object will be
23284     * destroyed with evas_object_del().
23285     *
23286     * @see elm_map_marker_class_new() for more details.
23287     * @see elm_map_marker_class_get_cb_set()
23288     * @see elm_map_marker_add()
23289     *
23290     * @ingroup Map
23291     */
23292    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23293
23294    /**
23295     * Get the list of available sources.
23296     *
23297     * @param obj The map object.
23298     * @return The source names list.
23299     *
23300     * It will provide a list with all available sources, that can be set as
23301     * current source with elm_map_source_name_set(), or get with
23302     * elm_map_source_name_get().
23303     *
23304     * Available sources:
23305     * @li "Mapnik"
23306     * @li "Osmarender"
23307     * @li "CycleMap"
23308     * @li "Maplint"
23309     *
23310     * @see elm_map_source_name_set() for more details.
23311     * @see elm_map_source_name_get()
23312     *
23313     * @ingroup Map
23314     */
23315    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23316
23317    /**
23318     * Set the source of the map.
23319     *
23320     * @param obj The map object.
23321     * @param source The source to be used.
23322     *
23323     * Map widget retrieves images that composes the map from a web service.
23324     * This web service can be set with this method.
23325     *
23326     * A different service can return a different maps with different
23327     * information and it can use different zoom values.
23328     *
23329     * The @p source_name need to match one of the names provided by
23330     * elm_map_source_names_get().
23331     *
23332     * The current source can be get using elm_map_source_name_get().
23333     *
23334     * @see elm_map_source_names_get()
23335     * @see elm_map_source_name_get()
23336     *
23337     *
23338     * @ingroup Map
23339     */
23340    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23341
23342    /**
23343     * Get the name of currently used source.
23344     *
23345     * @param obj The map object.
23346     * @return Returns the name of the source in use.
23347     *
23348     * @see elm_map_source_name_set() for more details.
23349     *
23350     * @ingroup Map
23351     */
23352    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23353
23354    /**
23355     * Set the source of the route service to be used by the map.
23356     *
23357     * @param obj The map object.
23358     * @param source The route service to be used, being it one of
23359     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23360     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23361     *
23362     * Each one has its own algorithm, so the route retrieved may
23363     * differ depending on the source route. Now, only the default is working.
23364     *
23365     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23366     * http://www.yournavigation.org/.
23367     *
23368     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23369     * assumptions. Its routing core is based on Contraction Hierarchies.
23370     *
23371     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23372     *
23373     * @see elm_map_route_source_get().
23374     *
23375     * @ingroup Map
23376     */
23377    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23378
23379    /**
23380     * Get the current route source.
23381     *
23382     * @param obj The map object.
23383     * @return The source of the route service used by the map.
23384     *
23385     * @see elm_map_route_source_set() for details.
23386     *
23387     * @ingroup Map
23388     */
23389    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23390
23391    /**
23392     * Set the minimum zoom of the source.
23393     *
23394     * @param obj The map object.
23395     * @param zoom New minimum zoom value to be used.
23396     *
23397     * By default, it's 0.
23398     *
23399     * @ingroup Map
23400     */
23401    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23402
23403    /**
23404     * Get the minimum zoom of the source.
23405     *
23406     * @param obj The map object.
23407     * @return Returns the minimum zoom of the source.
23408     *
23409     * @see elm_map_source_zoom_min_set() for details.
23410     *
23411     * @ingroup Map
23412     */
23413    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23414
23415    /**
23416     * Set the maximum zoom of the source.
23417     *
23418     * @param obj The map object.
23419     * @param zoom New maximum zoom value to be used.
23420     *
23421     * By default, it's 18.
23422     *
23423     * @ingroup Map
23424     */
23425    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23426
23427    /**
23428     * Get the maximum zoom of the source.
23429     *
23430     * @param obj The map object.
23431     * @return Returns the maximum zoom of the source.
23432     *
23433     * @see elm_map_source_zoom_min_set() for details.
23434     *
23435     * @ingroup Map
23436     */
23437    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23438
23439    /**
23440     * Set the user agent used by the map object to access routing services.
23441     *
23442     * @param obj The map object.
23443     * @param user_agent The user agent to be used by the map.
23444     *
23445     * User agent is a client application implementing a network protocol used
23446     * in communications within a client–server distributed computing system
23447     *
23448     * The @p user_agent identification string will transmitted in a header
23449     * field @c User-Agent.
23450     *
23451     * @see elm_map_user_agent_get()
23452     *
23453     * @ingroup Map
23454     */
23455    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23456
23457    /**
23458     * Get the user agent used by the map object.
23459     *
23460     * @param obj The map object.
23461     * @return The user agent identification string used by the map.
23462     *
23463     * @see elm_map_user_agent_set() for details.
23464     *
23465     * @ingroup Map
23466     */
23467    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23468
23469    /**
23470     * Add a new route to the map object.
23471     *
23472     * @param obj The map object.
23473     * @param type The type of transport to be considered when tracing a route.
23474     * @param method The routing method, what should be priorized.
23475     * @param flon The start longitude.
23476     * @param flat The start latitude.
23477     * @param tlon The destination longitude.
23478     * @param tlat The destination latitude.
23479     *
23480     * @return The created route or @c NULL upon failure.
23481     *
23482     * A route will be traced by point on coordinates (@p flat, @p flon)
23483     * to point on coordinates (@p tlat, @p tlon), using the route service
23484     * set with elm_map_route_source_set().
23485     *
23486     * It will take @p type on consideration to define the route,
23487     * depending if the user will be walking or driving, the route may vary.
23488     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23489     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23490     *
23491     * Another parameter is what the route should priorize, the minor distance
23492     * or the less time to be spend on the route. So @p method should be one
23493     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23494     *
23495     * Routes created with this method can be deleted with
23496     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23497     * and distance can be get with elm_map_route_distance_get().
23498     *
23499     * @see elm_map_route_remove()
23500     * @see elm_map_route_color_set()
23501     * @see elm_map_route_distance_get()
23502     * @see elm_map_route_source_set()
23503     *
23504     * @ingroup Map
23505     */
23506    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);
23507
23508    /**
23509     * Remove a route from the map.
23510     *
23511     * @param route The route to remove.
23512     *
23513     * @see elm_map_route_add()
23514     *
23515     * @ingroup Map
23516     */
23517    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23518
23519    /**
23520     * Set the route color.
23521     *
23522     * @param route The route object.
23523     * @param r Red channel value, from 0 to 255.
23524     * @param g Green channel value, from 0 to 255.
23525     * @param b Blue channel value, from 0 to 255.
23526     * @param a Alpha channel value, from 0 to 255.
23527     *
23528     * It uses an additive color model, so each color channel represents
23529     * how much of each primary colors must to be used. 0 represents
23530     * ausence of this color, so if all of the three are set to 0,
23531     * the color will be black.
23532     *
23533     * These component values should be integers in the range 0 to 255,
23534     * (single 8-bit byte).
23535     *
23536     * This sets the color used for the route. By default, it is set to
23537     * solid red (r = 255, g = 0, b = 0, a = 255).
23538     *
23539     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23540     *
23541     * @see elm_map_route_color_get()
23542     *
23543     * @ingroup Map
23544     */
23545    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23546
23547    /**
23548     * Get the route color.
23549     *
23550     * @param route The route object.
23551     * @param r Pointer where to store the red channel value.
23552     * @param g Pointer where to store the green channel value.
23553     * @param b Pointer where to store the blue channel value.
23554     * @param a Pointer where to store the alpha channel value.
23555     *
23556     * @see elm_map_route_color_set() for details.
23557     *
23558     * @ingroup Map
23559     */
23560    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23561
23562    /**
23563     * Get the route distance in kilometers.
23564     *
23565     * @param route The route object.
23566     * @return The distance of route (unit : km).
23567     *
23568     * @ingroup Map
23569     */
23570    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23571
23572    /**
23573     * Get the information of route nodes.
23574     *
23575     * @param route The route object.
23576     * @return Returns a string with the nodes of route.
23577     *
23578     * @ingroup Map
23579     */
23580    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23581
23582    /**
23583     * Get the information of route waypoint.
23584     *
23585     * @param route the route object.
23586     * @return Returns a string with information about waypoint of route.
23587     *
23588     * @ingroup Map
23589     */
23590    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23591
23592    /**
23593     * Get the address of the name.
23594     *
23595     * @param name The name handle.
23596     * @return Returns the address string of @p name.
23597     *
23598     * This gets the coordinates of the @p name, created with one of the
23599     * conversion functions.
23600     *
23601     * @see elm_map_utils_convert_name_into_coord()
23602     * @see elm_map_utils_convert_coord_into_name()
23603     *
23604     * @ingroup Map
23605     */
23606    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23607
23608    /**
23609     * Get the current coordinates of the name.
23610     *
23611     * @param name The name handle.
23612     * @param lat Pointer where to store the latitude.
23613     * @param lon Pointer where to store The longitude.
23614     *
23615     * This gets the coordinates of the @p name, created with one of the
23616     * conversion functions.
23617     *
23618     * @see elm_map_utils_convert_name_into_coord()
23619     * @see elm_map_utils_convert_coord_into_name()
23620     *
23621     * @ingroup Map
23622     */
23623    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23624
23625    /**
23626     * Remove a name from the map.
23627     *
23628     * @param name The name to remove.
23629     *
23630     * Basically the struct handled by @p name will be freed, so convertions
23631     * between address and coordinates will be lost.
23632     *
23633     * @see elm_map_utils_convert_name_into_coord()
23634     * @see elm_map_utils_convert_coord_into_name()
23635     *
23636     * @ingroup Map
23637     */
23638    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23639
23640    /**
23641     * Rotate the map.
23642     *
23643     * @param obj The map object.
23644     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23645     * @param cx Rotation's center horizontal position.
23646     * @param cy Rotation's center vertical position.
23647     *
23648     * @see elm_map_rotate_get()
23649     *
23650     * @ingroup Map
23651     */
23652    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23653
23654    /**
23655     * Get the rotate degree of the map
23656     *
23657     * @param obj The map object
23658     * @param degree Pointer where to store degrees from 0.0 to 360.0
23659     * to rotate arount Z axis.
23660     * @param cx Pointer where to store rotation's center horizontal position.
23661     * @param cy Pointer where to store rotation's center vertical position.
23662     *
23663     * @see elm_map_rotate_set() to set map rotation.
23664     *
23665     * @ingroup Map
23666     */
23667    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);
23668
23669    /**
23670     * Enable or disable mouse wheel to be used to zoom in / out the map.
23671     *
23672     * @param obj The map object.
23673     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23674     * to enable it.
23675     *
23676     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23677     *
23678     * It's disabled by default.
23679     *
23680     * @see elm_map_wheel_disabled_get()
23681     *
23682     * @ingroup Map
23683     */
23684    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23685
23686    /**
23687     * Get a value whether mouse wheel is enabled or not.
23688     *
23689     * @param obj The map object.
23690     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23691     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23692     *
23693     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23694     *
23695     * @see elm_map_wheel_disabled_set() for details.
23696     *
23697     * @ingroup Map
23698     */
23699    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23700
23701 #ifdef ELM_EMAP
23702    /**
23703     * Add a track on the map
23704     *
23705     * @param obj The map object.
23706     * @param emap The emap route object.
23707     * @return The route object. This is an elm object of type Route.
23708     *
23709     * @see elm_route_add() for details.
23710     *
23711     * @ingroup Map
23712     */
23713    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23714 #endif
23715
23716    /**
23717     * Remove a track from the map
23718     *
23719     * @param obj The map object.
23720     * @param route The track to remove.
23721     *
23722     * @ingroup Map
23723     */
23724    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23725
23726    /**
23727     * @}
23728     */
23729
23730    /* Route */
23731    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23732 #ifdef ELM_EMAP
23733    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23734 #endif
23735    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23736    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23737    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23738    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23739
23740
23741    /**
23742     * @defgroup Panel Panel
23743     *
23744     * @image html img/widget/panel/preview-00.png
23745     * @image latex img/widget/panel/preview-00.eps
23746     *
23747     * @brief A panel is a type of animated container that contains subobjects.
23748     * It can be expanded or contracted by clicking the button on it's edge.
23749     *
23750     * Orientations are as follows:
23751     * @li ELM_PANEL_ORIENT_TOP
23752     * @li ELM_PANEL_ORIENT_LEFT
23753     * @li ELM_PANEL_ORIENT_RIGHT
23754     *
23755     * To set/get/unset the content of the panel, you can use
23756     * elm_object_content_set/get/unset APIs.
23757     * Once the content object is set, a previously set one will be deleted.
23758     * If you want to keep that old content object, use the
23759     * elm_object_content_unset() function
23760     *
23761     * @ref tutorial_panel shows one way to use this widget.
23762     * @{
23763     */
23764    typedef enum _Elm_Panel_Orient
23765      {
23766         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23767         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23768         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23769         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23770      } Elm_Panel_Orient;
23771    /**
23772     * @brief Adds a panel object
23773     *
23774     * @param parent The parent object
23775     *
23776     * @return The panel object, or NULL on failure
23777     */
23778    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23779    /**
23780     * @brief Sets the orientation of the panel
23781     *
23782     * @param parent The parent object
23783     * @param orient The panel orientation. Can be one of the following:
23784     * @li ELM_PANEL_ORIENT_TOP
23785     * @li ELM_PANEL_ORIENT_LEFT
23786     * @li ELM_PANEL_ORIENT_RIGHT
23787     *
23788     * Sets from where the panel will (dis)appear.
23789     */
23790    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23791    /**
23792     * @brief Get the orientation of the panel.
23793     *
23794     * @param obj The panel object
23795     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23796     */
23797    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23798    /**
23799     * @brief Set the content of the panel.
23800     *
23801     * @param obj The panel object
23802     * @param content The panel content
23803     *
23804     * Once the content object is set, a previously set one will be deleted.
23805     * If you want to keep that old content object, use the
23806     * elm_panel_content_unset() function.
23807     */
23808    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23809    /**
23810     * @brief Get the content of the panel.
23811     *
23812     * @param obj The panel object
23813     * @return The content that is being used
23814     *
23815     * Return the content object which is set for this widget.
23816     *
23817     * @see elm_panel_content_set()
23818     */
23819    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23820    /**
23821     * @brief Unset the content of the panel.
23822     *
23823     * @param obj The panel object
23824     * @return The content that was being used
23825     *
23826     * Unparent and return the content object which was set for this widget.
23827     *
23828     * @see elm_panel_content_set()
23829     */
23830    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23831    /**
23832     * @brief Set the state of the panel.
23833     *
23834     * @param obj The panel object
23835     * @param hidden If true, the panel will run the animation to contract
23836     */
23837    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23838    /**
23839     * @brief Get the state of the panel.
23840     *
23841     * @param obj The panel object
23842     * @param hidden If true, the panel is in the "hide" state
23843     */
23844    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23845    /**
23846     * @brief Toggle the hidden state of the panel from code
23847     *
23848     * @param obj The panel object
23849     */
23850    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23851    /**
23852     * @}
23853     */
23854
23855    /**
23856     * @defgroup Panes Panes
23857     * @ingroup Elementary
23858     *
23859     * @image html img/widget/panes/preview-00.png
23860     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23861     *
23862     * @image html img/panes.png
23863     * @image latex img/panes.eps width=\textwidth
23864     *
23865     * The panes adds a dragable bar between two contents. When dragged
23866     * this bar will resize contents size.
23867     *
23868     * Panes can be displayed vertically or horizontally, and contents
23869     * size proportion can be customized (homogeneous by default).
23870     *
23871     * Smart callbacks one can listen to:
23872     * - "press" - The panes has been pressed (button wasn't released yet).
23873     * - "unpressed" - The panes was released after being pressed.
23874     * - "clicked" - The panes has been clicked>
23875     * - "clicked,double" - The panes has been double clicked
23876     *
23877     * Available styles for it:
23878     * - @c "default"
23879     *
23880     * Default contents parts of the panes widget that you can use for are:
23881     * @li "elm.swallow.left" - A leftside content of the panes
23882     * @li "elm.swallow.right" - A rightside content of the panes
23883     *
23884     * If panes is displayed vertically, left content will be displayed at
23885     * top.
23886     * 
23887     * Here is an example on its usage:
23888     * @li @ref panes_example
23889     */
23890
23891 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23892 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23893
23894    /**
23895     * @addtogroup Panes
23896     * @{
23897     */
23898
23899    /**
23900     * Add a new panes widget to the given parent Elementary
23901     * (container) object.
23902     *
23903     * @param parent The parent object.
23904     * @return a new panes widget handle or @c NULL, on errors.
23905     *
23906     * This function inserts a new panes widget on the canvas.
23907     *
23908     * @ingroup Panes
23909     */
23910    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23911
23912    /**
23913     * Set the left content of the panes widget.
23914     *
23915     * @param obj The panes object.
23916     * @param content The new left content object.
23917     *
23918     * Once the content object is set, a previously set one will be deleted.
23919     * If you want to keep that old content object, use the
23920     * elm_panes_content_left_unset() function.
23921     *
23922     * If panes is displayed vertically, left content will be displayed at
23923     * top.
23924     *
23925     * @see elm_panes_content_left_get()
23926     * @see elm_panes_content_right_set() to set content on the other side.
23927     *
23928     * @ingroup Panes
23929     */
23930    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23931
23932    /**
23933     * Set the right content of the panes widget.
23934     *
23935     * @param obj The panes object.
23936     * @param content The new right content object.
23937     *
23938     * Once the content object is set, a previously set one will be deleted.
23939     * If you want to keep that old content object, use the
23940     * elm_panes_content_right_unset() function.
23941     *
23942     * If panes is displayed vertically, left content will be displayed at
23943     * bottom.
23944     *
23945     * @see elm_panes_content_right_get()
23946     * @see elm_panes_content_left_set() to set content on the other side.
23947     *
23948     * @ingroup Panes
23949     */
23950    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23951
23952    /**
23953     * Get the left content of the panes.
23954     *
23955     * @param obj The panes object.
23956     * @return The left content object that is being used.
23957     *
23958     * Return the left content object which is set for this widget.
23959     *
23960     * @see elm_panes_content_left_set() for details.
23961     *
23962     * @ingroup Panes
23963     */
23964    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23965
23966    /**
23967     * Get the right content of the panes.
23968     *
23969     * @param obj The panes object
23970     * @return The right content object that is being used
23971     *
23972     * Return the right content object which is set for this widget.
23973     *
23974     * @see elm_panes_content_right_set() for details.
23975     *
23976     * @ingroup Panes
23977     */
23978    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23979
23980    /**
23981     * Unset the left content used for the panes.
23982     *
23983     * @param obj The panes object.
23984     * @return The left content object that was being used.
23985     *
23986     * Unparent and return the left content object which was set for this widget.
23987     *
23988     * @see elm_panes_content_left_set() for details.
23989     * @see elm_panes_content_left_get().
23990     *
23991     * @ingroup Panes
23992     */
23993    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23994
23995    /**
23996     * Unset the right content used for the panes.
23997     *
23998     * @param obj The panes object.
23999     * @return The right content object that was being used.
24000     *
24001     * Unparent and return the right content object which was set for this
24002     * widget.
24003     *
24004     * @see elm_panes_content_right_set() for details.
24005     * @see elm_panes_content_right_get().
24006     *
24007     * @ingroup Panes
24008     */
24009    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24010
24011    /**
24012     * Get the size proportion of panes widget's left side.
24013     *
24014     * @param obj The panes object.
24015     * @return float value between 0.0 and 1.0 representing size proportion
24016     * of left side.
24017     *
24018     * @see elm_panes_content_left_size_set() for more details.
24019     *
24020     * @ingroup Panes
24021     */
24022    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24023
24024    /**
24025     * Set the size proportion of panes widget's left side.
24026     *
24027     * @param obj The panes object.
24028     * @param size Value between 0.0 and 1.0 representing size proportion
24029     * of left side.
24030     *
24031     * By default it's homogeneous, i.e., both sides have the same size.
24032     *
24033     * If something different is required, it can be set with this function.
24034     * For example, if the left content should be displayed over
24035     * 75% of the panes size, @p size should be passed as @c 0.75.
24036     * This way, right content will be resized to 25% of panes size.
24037     *
24038     * If displayed vertically, left content is displayed at top, and
24039     * right content at bottom.
24040     *
24041     * @note This proportion will change when user drags the panes bar.
24042     *
24043     * @see elm_panes_content_left_size_get()
24044     *
24045     * @ingroup Panes
24046     */
24047    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24048
24049   /**
24050    * Set the orientation of a given panes widget.
24051    *
24052    * @param obj The panes object.
24053    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24054    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24055    *
24056    * Use this function to change how your panes is to be
24057    * disposed: vertically or horizontally.
24058    *
24059    * By default it's displayed horizontally.
24060    *
24061    * @see elm_panes_horizontal_get()
24062    *
24063    * @ingroup Panes
24064    */
24065    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24066
24067    /**
24068     * Retrieve the orientation of a given panes widget.
24069     *
24070     * @param obj The panes object.
24071     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24072     * @c EINA_FALSE if it's @b vertical (and on errors).
24073     *
24074     * @see elm_panes_horizontal_set() for more details.
24075     *
24076     * @ingroup Panes
24077     */
24078    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24079    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24080    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24081
24082    /**
24083     * @}
24084     */
24085
24086    /**
24087     * @defgroup Flip Flip
24088     *
24089     * @image html img/widget/flip/preview-00.png
24090     * @image latex img/widget/flip/preview-00.eps
24091     *
24092     * This widget holds 2 content objects(Evas_Object): one on the front and one
24093     * on the back. It allows you to flip from front to back and vice-versa using
24094     * various animations.
24095     *
24096     * If either the front or back contents are not set the flip will treat that
24097     * as transparent. So if you wore to set the front content but not the back,
24098     * and then call elm_flip_go() you would see whatever is below the flip.
24099     *
24100     * For a list of supported animations see elm_flip_go().
24101     *
24102     * Signals that you can add callbacks for are:
24103     * "animate,begin" - when a flip animation was started
24104     * "animate,done" - when a flip animation is finished
24105     *
24106     * @ref tutorial_flip show how to use most of the API.
24107     *
24108     * @{
24109     */
24110    typedef enum _Elm_Flip_Mode
24111      {
24112         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24113         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24114         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24115         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24116         ELM_FLIP_CUBE_LEFT,
24117         ELM_FLIP_CUBE_RIGHT,
24118         ELM_FLIP_CUBE_UP,
24119         ELM_FLIP_CUBE_DOWN,
24120         ELM_FLIP_PAGE_LEFT,
24121         ELM_FLIP_PAGE_RIGHT,
24122         ELM_FLIP_PAGE_UP,
24123         ELM_FLIP_PAGE_DOWN
24124      } Elm_Flip_Mode;
24125    typedef enum _Elm_Flip_Interaction
24126      {
24127         ELM_FLIP_INTERACTION_NONE,
24128         ELM_FLIP_INTERACTION_ROTATE,
24129         ELM_FLIP_INTERACTION_CUBE,
24130         ELM_FLIP_INTERACTION_PAGE
24131      } Elm_Flip_Interaction;
24132    typedef enum _Elm_Flip_Direction
24133      {
24134         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24135         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24136         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24137         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24138      } Elm_Flip_Direction;
24139    /**
24140     * @brief Add a new flip to the parent
24141     *
24142     * @param parent The parent object
24143     * @return The new object or NULL if it cannot be created
24144     */
24145    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24146    /**
24147     * @brief Set the front content of the flip widget.
24148     *
24149     * @param obj The flip object
24150     * @param content The new front content object
24151     *
24152     * Once the content object is set, a previously set one will be deleted.
24153     * If you want to keep that old content object, use the
24154     * elm_flip_content_front_unset() function.
24155     */
24156    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24157    /**
24158     * @brief Set the back content of the flip widget.
24159     *
24160     * @param obj The flip object
24161     * @param content The new back content object
24162     *
24163     * Once the content object is set, a previously set one will be deleted.
24164     * If you want to keep that old content object, use the
24165     * elm_flip_content_back_unset() function.
24166     */
24167    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24168    /**
24169     * @brief Get the front content used for the flip
24170     *
24171     * @param obj The flip object
24172     * @return The front content object that is being used
24173     *
24174     * Return the front content object which is set for this widget.
24175     */
24176    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24177    /**
24178     * @brief Get the back content used for the flip
24179     *
24180     * @param obj The flip object
24181     * @return The back content object that is being used
24182     *
24183     * Return the back content object which is set for this widget.
24184     */
24185    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24186    /**
24187     * @brief Unset the front content used for the flip
24188     *
24189     * @param obj The flip object
24190     * @return The front content object that was being used
24191     *
24192     * Unparent and return the front content object which was set for this widget.
24193     */
24194    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24195    /**
24196     * @brief Unset the back content used for the flip
24197     *
24198     * @param obj The flip object
24199     * @return The back content object that was being used
24200     *
24201     * Unparent and return the back content object which was set for this widget.
24202     */
24203    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24204    /**
24205     * @brief Get flip front visibility state
24206     *
24207     * @param obj The flip objct
24208     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24209     * showing.
24210     */
24211    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24212    /**
24213     * @brief Set flip perspective
24214     *
24215     * @param obj The flip object
24216     * @param foc The coordinate to set the focus on
24217     * @param x The X coordinate
24218     * @param y The Y coordinate
24219     *
24220     * @warning This function currently does nothing.
24221     */
24222    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24223    /**
24224     * @brief Runs the flip animation
24225     *
24226     * @param obj The flip object
24227     * @param mode The mode type
24228     *
24229     * Flips the front and back contents using the @p mode animation. This
24230     * efectively hides the currently visible content and shows the hidden one.
24231     *
24232     * There a number of possible animations to use for the flipping:
24233     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24234     * around a horizontal axis in the middle of its height, the other content
24235     * is shown as the other side of the flip.
24236     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24237     * around a vertical axis in the middle of its width, the other content is
24238     * shown as the other side of the flip.
24239     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24240     * around a diagonal axis in the middle of its width, the other content is
24241     * shown as the other side of the flip.
24242     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24243     * around a diagonal axis in the middle of its height, the other content is
24244     * shown as the other side of the flip.
24245     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24246     * as if the flip was a cube, the other content is show as the right face of
24247     * the cube.
24248     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24249     * right as if the flip was a cube, the other content is show as the left
24250     * face of the cube.
24251     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24252     * flip was a cube, the other content is show as the bottom face of the cube.
24253     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24254     * the flip was a cube, the other content is show as the upper face of the
24255     * cube.
24256     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24257     * if the flip was a book, the other content is shown as the page below that.
24258     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24259     * as if the flip was a book, the other content is shown as the page below
24260     * that.
24261     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24262     * flip was a book, the other content is shown as the page below that.
24263     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24264     * flip was a book, the other content is shown as the page below that.
24265     *
24266     * @image html elm_flip.png
24267     * @image latex elm_flip.eps width=\textwidth
24268     */
24269    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24270    /**
24271     * @brief Set the interactive flip mode
24272     *
24273     * @param obj The flip object
24274     * @param mode The interactive flip mode to use
24275     *
24276     * This sets if the flip should be interactive (allow user to click and
24277     * drag a side of the flip to reveal the back page and cause it to flip).
24278     * By default a flip is not interactive. You may also need to set which
24279     * sides of the flip are "active" for flipping and how much space they use
24280     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24281     * and elm_flip_interacton_direction_hitsize_set()
24282     *
24283     * The four avilable mode of interaction are:
24284     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24285     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24286     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24287     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24288     *
24289     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24290     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24291     * happen, those can only be acheived with elm_flip_go();
24292     */
24293    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24294    /**
24295     * @brief Get the interactive flip mode
24296     *
24297     * @param obj The flip object
24298     * @return The interactive flip mode
24299     *
24300     * Returns the interactive flip mode set by elm_flip_interaction_set()
24301     */
24302    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24303    /**
24304     * @brief Set which directions of the flip respond to interactive flip
24305     *
24306     * @param obj The flip object
24307     * @param dir The direction to change
24308     * @param enabled If that direction is enabled or not
24309     *
24310     * By default all directions are disabled, so you may want to enable the
24311     * desired directions for flipping if you need interactive flipping. You must
24312     * call this function once for each direction that should be enabled.
24313     *
24314     * @see elm_flip_interaction_set()
24315     */
24316    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24317    /**
24318     * @brief Get the enabled state of that flip direction
24319     *
24320     * @param obj The flip object
24321     * @param dir The direction to check
24322     * @return If that direction is enabled or not
24323     *
24324     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24325     *
24326     * @see elm_flip_interaction_set()
24327     */
24328    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24329    /**
24330     * @brief Set the amount of the flip that is sensitive to interactive flip
24331     *
24332     * @param obj The flip object
24333     * @param dir The direction to modify
24334     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24335     *
24336     * Set the amount of the flip that is sensitive to interactive flip, with 0
24337     * representing no area in the flip and 1 representing the entire flip. There
24338     * is however a consideration to be made in that the area will never be
24339     * smaller than the finger size set(as set in your Elementary configuration).
24340     *
24341     * @see elm_flip_interaction_set()
24342     */
24343    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24344    /**
24345     * @brief Get the amount of the flip that is sensitive to interactive flip
24346     *
24347     * @param obj The flip object
24348     * @param dir The direction to check
24349     * @return The size set for that direction
24350     *
24351     * Returns the amount os sensitive area set by
24352     * elm_flip_interacton_direction_hitsize_set().
24353     */
24354    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24355    /**
24356     * @}
24357     */
24358
24359    /* scrolledentry */
24360    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24361    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24362    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24363    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24364    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24365    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24366    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24367    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24368    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24369    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24370    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24371    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24372    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24373    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24374    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24375    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24376    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24377    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24378    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24379    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24380    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24381    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24382    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24383    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24384    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24385    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24386    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24387    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24388    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24389    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24390    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24391    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24392    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24393    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24394    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24395    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);
24396    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24397    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24398    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);
24399    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24400    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);
24401    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24402    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24403    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24404    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24405    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24406    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24407    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24408    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24409    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);
24410    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);
24411    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);
24412    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);
24413    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);
24414    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);
24415    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24416    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24417    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24418    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24419    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24420    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24421    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24422    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24423    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24424    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24425    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24426    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24427    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24428
24429    /**
24430     * @defgroup Conformant Conformant
24431     * @ingroup Elementary
24432     *
24433     * @image html img/widget/conformant/preview-00.png
24434     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24435     *
24436     * @image html img/conformant.png
24437     * @image latex img/conformant.eps width=\textwidth
24438     *
24439     * The aim is to provide a widget that can be used in elementary apps to
24440     * account for space taken up by the indicator, virtual keypad & softkey
24441     * windows when running the illume2 module of E17.
24442     *
24443     * So conformant content will be sized and positioned considering the
24444     * space required for such stuff, and when they popup, as a keyboard
24445     * shows when an entry is selected, conformant content won't change.
24446     *
24447     * Available styles for it:
24448     * - @c "default"
24449     *
24450     * Default contents parts of the conformant widget that you can use for are:
24451     * @li "elm.swallow.content" - A content of the conformant
24452     *
24453     * See how to use this widget in this example:
24454     * @ref conformant_example
24455     */
24456
24457    /**
24458     * @addtogroup Conformant
24459     * @{
24460     */
24461
24462    /**
24463     * Add a new conformant widget to the given parent Elementary
24464     * (container) object.
24465     *
24466     * @param parent The parent object.
24467     * @return A new conformant widget handle or @c NULL, on errors.
24468     *
24469     * This function inserts a new conformant widget on the canvas.
24470     *
24471     * @ingroup Conformant
24472     */
24473    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24474
24475    /**
24476     * Set the content of the conformant widget.
24477     *
24478     * @param obj The conformant object.
24479     * @param content The content to be displayed by the conformant.
24480     *
24481     * Content will be sized and positioned considering the space required
24482     * to display a virtual keyboard. So it won't fill all the conformant
24483     * size. This way is possible to be sure that content won't resize
24484     * or be re-positioned after the keyboard is displayed.
24485     *
24486     * Once the content object is set, a previously set one will be deleted.
24487     * If you want to keep that old content object, use the
24488     * elm_object_content_unset() function.
24489     *
24490     * @see elm_object_content_unset()
24491     * @see elm_object_content_get()
24492     *
24493     * @ingroup Conformant
24494     */
24495    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24496
24497    /**
24498     * Get the content of the conformant widget.
24499     *
24500     * @param obj The conformant object.
24501     * @return The content that is being used.
24502     *
24503     * Return the content object which is set for this widget.
24504     * It won't be unparent from conformant. For that, use
24505     * elm_object_content_unset().
24506     *
24507     * @see elm_object_content_set().
24508     * @see elm_object_content_unset()
24509     *
24510     * @ingroup Conformant
24511     */
24512    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24513
24514    /**
24515     * Unset the content of the conformant widget.
24516     *
24517     * @param obj The conformant object.
24518     * @return The content that was being used.
24519     *
24520     * Unparent and return the content object which was set for this widget.
24521     *
24522     * @see elm_object_content_set().
24523     *
24524     * @ingroup Conformant
24525     */
24526    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24527
24528    /**
24529     * Returns the Evas_Object that represents the content area.
24530     *
24531     * @param obj The conformant object.
24532     * @return The content area of the widget.
24533     *
24534     * @ingroup Conformant
24535     */
24536    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24537
24538    /**
24539     * @}
24540     */
24541
24542    /**
24543     * @defgroup Mapbuf Mapbuf
24544     * @ingroup Elementary
24545     *
24546     * @image html img/widget/mapbuf/preview-00.png
24547     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24548     *
24549     * This holds one content object and uses an Evas Map of transformation
24550     * points to be later used with this content. So the content will be
24551     * moved, resized, etc as a single image. So it will improve performance
24552     * when you have a complex interafce, with a lot of elements, and will
24553     * need to resize or move it frequently (the content object and its
24554     * children).
24555     *
24556     * To set/get/unset the content of the mapbuf, you can use 
24557     * elm_object_content_set/get/unset APIs. 
24558     * Once the content object is set, a previously set one will be deleted.
24559     * If you want to keep that old content object, use the
24560     * elm_object_content_unset() function.
24561     *
24562     * To enable map, elm_mapbuf_enabled_set() should be used.
24563     * 
24564     * See how to use this widget in this example:
24565     * @ref mapbuf_example
24566     */
24567
24568    /**
24569     * @addtogroup Mapbuf
24570     * @{
24571     */
24572
24573    /**
24574     * Add a new mapbuf widget to the given parent Elementary
24575     * (container) object.
24576     *
24577     * @param parent The parent object.
24578     * @return A new mapbuf widget handle or @c NULL, on errors.
24579     *
24580     * This function inserts a new mapbuf widget on the canvas.
24581     *
24582     * @ingroup Mapbuf
24583     */
24584    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24585
24586    /**
24587     * Set the content of the mapbuf.
24588     *
24589     * @param obj The mapbuf object.
24590     * @param content The content that will be filled in this mapbuf object.
24591     *
24592     * Once the content object is set, a previously set one will be deleted.
24593     * If you want to keep that old content object, use the
24594     * elm_mapbuf_content_unset() function.
24595     *
24596     * To enable map, elm_mapbuf_enabled_set() should be used.
24597     *
24598     * @ingroup Mapbuf
24599     */
24600    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24601
24602    /**
24603     * Get the content of the mapbuf.
24604     *
24605     * @param obj The mapbuf object.
24606     * @return The content that is being used.
24607     *
24608     * Return the content object which is set for this widget.
24609     *
24610     * @see elm_mapbuf_content_set() for details.
24611     *
24612     * @ingroup Mapbuf
24613     */
24614    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24615
24616    /**
24617     * Unset the content of the mapbuf.
24618     *
24619     * @param obj The mapbuf object.
24620     * @return The content that was being used.
24621     *
24622     * Unparent and return the content object which was set for this widget.
24623     *
24624     * @see elm_mapbuf_content_set() for details.
24625     *
24626     * @ingroup Mapbuf
24627     */
24628    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24629
24630    /**
24631     * Enable or disable the map.
24632     *
24633     * @param obj The mapbuf object.
24634     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24635     *
24636     * This enables the map that is set or disables it. On enable, the object
24637     * geometry will be saved, and the new geometry will change (position and
24638     * size) to reflect the map geometry set.
24639     *
24640     * Also, when enabled, alpha and smooth states will be used, so if the
24641     * content isn't solid, alpha should be enabled, for example, otherwise
24642     * a black retangle will fill the content.
24643     *
24644     * When disabled, the stored map will be freed and geometry prior to
24645     * enabling the map will be restored.
24646     *
24647     * It's disabled by default.
24648     *
24649     * @see elm_mapbuf_alpha_set()
24650     * @see elm_mapbuf_smooth_set()
24651     *
24652     * @ingroup Mapbuf
24653     */
24654    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24655
24656    /**
24657     * Get a value whether map is enabled or not.
24658     *
24659     * @param obj The mapbuf object.
24660     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24661     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24662     *
24663     * @see elm_mapbuf_enabled_set() for details.
24664     *
24665     * @ingroup Mapbuf
24666     */
24667    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24668
24669    /**
24670     * Enable or disable smooth map rendering.
24671     *
24672     * @param obj The mapbuf object.
24673     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24674     * to disable it.
24675     *
24676     * This sets smoothing for map rendering. If the object is a type that has
24677     * its own smoothing settings, then both the smooth settings for this object
24678     * and the map must be turned off.
24679     *
24680     * By default smooth maps are enabled.
24681     *
24682     * @ingroup Mapbuf
24683     */
24684    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24685
24686    /**
24687     * Get a value whether smooth map rendering is enabled or not.
24688     *
24689     * @param obj The mapbuf object.
24690     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24691     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24692     *
24693     * @see elm_mapbuf_smooth_set() for details.
24694     *
24695     * @ingroup Mapbuf
24696     */
24697    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24698
24699    /**
24700     * Set or unset alpha flag for map rendering.
24701     *
24702     * @param obj The mapbuf object.
24703     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24704     * to disable it.
24705     *
24706     * This sets alpha flag for map rendering. If the object is a type that has
24707     * its own alpha settings, then this will take precedence. Only image objects
24708     * have this currently. It stops alpha blending of the map area, and is
24709     * useful if you know the object and/or all sub-objects is 100% solid.
24710     *
24711     * Alpha is enabled by default.
24712     *
24713     * @ingroup Mapbuf
24714     */
24715    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24716
24717    /**
24718     * Get a value whether alpha blending is enabled or not.
24719     *
24720     * @param obj The mapbuf object.
24721     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24722     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24723     *
24724     * @see elm_mapbuf_alpha_set() for details.
24725     *
24726     * @ingroup Mapbuf
24727     */
24728    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24729
24730    /**
24731     * @}
24732     */
24733
24734    /**
24735     * @defgroup Flipselector Flip Selector
24736     *
24737     * @image html img/widget/flipselector/preview-00.png
24738     * @image latex img/widget/flipselector/preview-00.eps
24739     *
24740     * A flip selector is a widget to show a set of @b text items, one
24741     * at a time, with the same sheet switching style as the @ref Clock
24742     * "clock" widget, when one changes the current displaying sheet
24743     * (thus, the "flip" in the name).
24744     *
24745     * User clicks to flip sheets which are @b held for some time will
24746     * make the flip selector to flip continuosly and automatically for
24747     * the user. The interval between flips will keep growing in time,
24748     * so that it helps the user to reach an item which is distant from
24749     * the current selection.
24750     *
24751     * Smart callbacks one can register to:
24752     * - @c "selected" - when the widget's selected text item is changed
24753     * - @c "overflowed" - when the widget's current selection is changed
24754     *   from the first item in its list to the last
24755     * - @c "underflowed" - when the widget's current selection is changed
24756     *   from the last item in its list to the first
24757     *
24758     * Available styles for it:
24759     * - @c "default"
24760     *
24761     * Here is an example on its usage:
24762     * @li @ref flipselector_example
24763     */
24764
24765    /**
24766     * @addtogroup Flipselector
24767     * @{
24768     */
24769
24770    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24771
24772    /**
24773     * Add a new flip selector widget to the given parent Elementary
24774     * (container) widget
24775     *
24776     * @param parent The parent object
24777     * @return a new flip selector widget handle or @c NULL, on errors
24778     *
24779     * This function inserts a new flip selector widget on the canvas.
24780     *
24781     * @ingroup Flipselector
24782     */
24783    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24784
24785    /**
24786     * Programmatically select the next item of a flip selector widget
24787     *
24788     * @param obj The flipselector object
24789     *
24790     * @note The selection will be animated. Also, if it reaches the
24791     * end of its list of member items, it will continue with the first
24792     * one onwards.
24793     *
24794     * @ingroup Flipselector
24795     */
24796    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24797
24798    /**
24799     * Programmatically select the previous item of a flip selector
24800     * widget
24801     *
24802     * @param obj The flipselector object
24803     *
24804     * @note The selection will be animated.  Also, if it reaches the
24805     * beginning of its list of member items, it will continue with the
24806     * last one backwards.
24807     *
24808     * @ingroup Flipselector
24809     */
24810    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24811
24812    /**
24813     * Append a (text) item to a flip selector widget
24814     *
24815     * @param obj The flipselector object
24816     * @param label The (text) label of the new item
24817     * @param func Convenience callback function to take place when
24818     * item is selected
24819     * @param data Data passed to @p func, above
24820     * @return A handle to the item added or @c NULL, on errors
24821     *
24822     * The widget's list of labels to show will be appended with the
24823     * given value. If the user wishes so, a callback function pointer
24824     * can be passed, which will get called when this same item is
24825     * selected.
24826     *
24827     * @note The current selection @b won't be modified by appending an
24828     * element to the list.
24829     *
24830     * @note The maximum length of the text label is going to be
24831     * determined <b>by the widget's theme</b>. Strings larger than
24832     * that value are going to be @b truncated.
24833     *
24834     * @ingroup Flipselector
24835     */
24836    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24837
24838    /**
24839     * Prepend a (text) item to a flip selector widget
24840     *
24841     * @param obj The flipselector object
24842     * @param label The (text) label of the new item
24843     * @param func Convenience callback function to take place when
24844     * item is selected
24845     * @param data Data passed to @p func, above
24846     * @return A handle to the item added or @c NULL, on errors
24847     *
24848     * The widget's list of labels to show will be prepended with the
24849     * given value. If the user wishes so, a callback function pointer
24850     * can be passed, which will get called when this same item is
24851     * selected.
24852     *
24853     * @note The current selection @b won't be modified by prepending
24854     * an element to the list.
24855     *
24856     * @note The maximum length of the text label is going to be
24857     * determined <b>by the widget's theme</b>. Strings larger than
24858     * that value are going to be @b truncated.
24859     *
24860     * @ingroup Flipselector
24861     */
24862    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24863
24864    /**
24865     * Get the internal list of items in a given flip selector widget.
24866     *
24867     * @param obj The flipselector object
24868     * @return The list of items (#Elm_Flipselector_Item as data) or
24869     * @c NULL on errors.
24870     *
24871     * This list is @b not to be modified in any way and must not be
24872     * freed. Use the list members with functions like
24873     * elm_flipselector_item_label_set(),
24874     * elm_flipselector_item_label_get(),
24875     * elm_flipselector_item_del(),
24876     * elm_flipselector_item_selected_get(),
24877     * elm_flipselector_item_selected_set().
24878     *
24879     * @warning This list is only valid until @p obj object's internal
24880     * items list is changed. It should be fetched again with another
24881     * call to this function when changes happen.
24882     *
24883     * @ingroup Flipselector
24884     */
24885    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24886
24887    /**
24888     * Get the first item in the given flip selector widget's list of
24889     * items.
24890     *
24891     * @param obj The flipselector object
24892     * @return The first item or @c NULL, if it has no items (and on
24893     * errors)
24894     *
24895     * @see elm_flipselector_item_append()
24896     * @see elm_flipselector_last_item_get()
24897     *
24898     * @ingroup Flipselector
24899     */
24900    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24901
24902    /**
24903     * Get the last item in the given flip selector widget's list of
24904     * items.
24905     *
24906     * @param obj The flipselector object
24907     * @return The last item or @c NULL, if it has no items (and on
24908     * errors)
24909     *
24910     * @see elm_flipselector_item_prepend()
24911     * @see elm_flipselector_first_item_get()
24912     *
24913     * @ingroup Flipselector
24914     */
24915    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24916
24917    /**
24918     * Get the currently selected item in a flip selector widget.
24919     *
24920     * @param obj The flipselector object
24921     * @return The selected item or @c NULL, if the widget has no items
24922     * (and on erros)
24923     *
24924     * @ingroup Flipselector
24925     */
24926    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24927
24928    /**
24929     * Set whether a given flip selector widget's item should be the
24930     * currently selected one.
24931     *
24932     * @param item The flip selector item
24933     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24934     *
24935     * This sets whether @p item is or not the selected (thus, under
24936     * display) one. If @p item is different than one under display,
24937     * the latter will be unselected. If the @p item is set to be
24938     * unselected, on the other hand, the @b first item in the widget's
24939     * internal members list will be the new selected one.
24940     *
24941     * @see elm_flipselector_item_selected_get()
24942     *
24943     * @ingroup Flipselector
24944     */
24945    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24946
24947    /**
24948     * Get whether a given flip selector widget's item is the currently
24949     * selected one.
24950     *
24951     * @param item The flip selector item
24952     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24953     * (or on errors).
24954     *
24955     * @see elm_flipselector_item_selected_set()
24956     *
24957     * @ingroup Flipselector
24958     */
24959    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24960
24961    /**
24962     * Delete a given item from a flip selector widget.
24963     *
24964     * @param item The item to delete
24965     *
24966     * @ingroup Flipselector
24967     */
24968    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24969
24970    /**
24971     * Get the label of a given flip selector widget's item.
24972     *
24973     * @param item The item to get label from
24974     * @return The text label of @p item or @c NULL, on errors
24975     *
24976     * @see elm_flipselector_item_label_set()
24977     *
24978     * @ingroup Flipselector
24979     */
24980    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24981
24982    /**
24983     * Set the label of a given flip selector widget's item.
24984     *
24985     * @param item The item to set label on
24986     * @param label The text label string, in UTF-8 encoding
24987     *
24988     * @see elm_flipselector_item_label_get()
24989     *
24990     * @ingroup Flipselector
24991     */
24992    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24993
24994    /**
24995     * Gets the item before @p item in a flip selector widget's
24996     * internal list of items.
24997     *
24998     * @param item The item to fetch previous from
24999     * @return The item before the @p item, in its parent's list. If
25000     *         there is no previous item for @p item or there's an
25001     *         error, @c NULL is returned.
25002     *
25003     * @see elm_flipselector_item_next_get()
25004     *
25005     * @ingroup Flipselector
25006     */
25007    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25008
25009    /**
25010     * Gets the item after @p item in a flip selector widget's
25011     * internal list of items.
25012     *
25013     * @param item The item to fetch next from
25014     * @return The item after the @p item, in its parent's list. If
25015     *         there is no next item for @p item or there's an
25016     *         error, @c NULL is returned.
25017     *
25018     * @see elm_flipselector_item_next_get()
25019     *
25020     * @ingroup Flipselector
25021     */
25022    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25023
25024    /**
25025     * Set the interval on time updates for an user mouse button hold
25026     * on a flip selector widget.
25027     *
25028     * @param obj The flip selector object
25029     * @param interval The (first) interval value in seconds
25030     *
25031     * This interval value is @b decreased while the user holds the
25032     * mouse pointer either flipping up or flipping doww a given flip
25033     * selector.
25034     *
25035     * This helps the user to get to a given item distant from the
25036     * current one easier/faster, as it will start to flip quicker and
25037     * quicker on mouse button holds.
25038     *
25039     * The calculation for the next flip interval value, starting from
25040     * the one set with this call, is the previous interval divided by
25041     * 1.05, so it decreases a little bit.
25042     *
25043     * The default starting interval value for automatic flips is
25044     * @b 0.85 seconds.
25045     *
25046     * @see elm_flipselector_interval_get()
25047     *
25048     * @ingroup Flipselector
25049     */
25050    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25051
25052    /**
25053     * Get the interval on time updates for an user mouse button hold
25054     * on a flip selector widget.
25055     *
25056     * @param obj The flip selector object
25057     * @return The (first) interval value, in seconds, set on it
25058     *
25059     * @see elm_flipselector_interval_set() for more details
25060     *
25061     * @ingroup Flipselector
25062     */
25063    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25064
25065    /**
25066     * @}
25067     */
25068
25069    /**
25070     * @addtogroup Animator Animator
25071     * @ingroup Elementary
25072     *
25073     * @brief Functions to ease creation of animations.
25074     *
25075     * elm_animator is designed to provide an easy way to create animations.
25076     * Creating an animation with elm_animator is as simple as setting a
25077     * duration, an operating callback and telling it to run the animation.
25078     * However that is not the full extent of elm_animator's ability, animations
25079     * can be paused and resumed, reversed and the animation need not be linear.
25080     *
25081     * To run an animation you must specify at least a duration and operation
25082     * callback, not setting any other properties will create a linear animation
25083     * that runs once and is not reversed.
25084     *
25085     * @ref elm_animator_example_page_01 "This" example should make all of that
25086     * very clear.
25087     *
25088     * @warning elm_animator is @b not a widget.
25089     * @{
25090     */
25091    /**
25092     * @brief Type of curve desired for animation.
25093     *
25094     * The speed in which an animation happens doesn't have to be linear, some
25095     * animations will look better if they're accelerating or decelerating, so
25096     * elm_animator provides four options in this regard:
25097     * @image html elm_animator_curve_style.png
25098     * @image latex elm_animator_curve_style.eps width=\textwidth
25099     * As can be seen in the image the speed of the animation will be:
25100     * @li ELM_ANIMATOR_CURVE_LINEAR constant
25101     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
25102     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
25103     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
25104     */
25105    typedef enum
25106      {
25107         ELM_ANIMATOR_CURVE_LINEAR,
25108         ELM_ANIMATOR_CURVE_IN_OUT,
25109         ELM_ANIMATOR_CURVE_IN,
25110         ELM_ANIMATOR_CURVE_OUT
25111      } Elm_Animator_Curve_Style;
25112    typedef struct _Elm_Animator Elm_Animator;
25113   /**
25114    * Called back per loop of an elementary animators cycle
25115    * @param data user-data given to elm_animator_operation_callback_set()
25116    * @param animator the animator being run
25117    * @param double the position in the animation
25118    */
25119    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
25120   /**
25121    * Called back when an elementary animator finishes
25122    * @param data user-data given to elm_animator_completion_callback_set()
25123    */
25124    typedef void (*Elm_Animator_Completion_Cb) (void *data);
25125
25126    /**
25127     * @brief Create a new animator.
25128     *
25129     * @param[in] parent Parent object
25130     *
25131     * The @a parent argument can be set to NULL for no parent. If a parent is set
25132     * there is no need to call elm_animator_del(), when the parent is deleted it
25133     * will delete the animator.
25134     * @deprecated Use @ref Transit instead.
25135
25136     */
25137    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
25138    /**
25139     * Deletes the animator freeing any resources it used. If the animator was
25140     * created with a NULL parent this must be called, otherwise it will be
25141     * automatically called when the parent is deleted.
25142     *
25143     * @param[in] animator Animator object
25144     * @deprecated Use @ref Transit instead.
25145     */
25146    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25147    /**
25148     * Set the duration of the animation.
25149     *
25150     * @param[in] animator Animator object
25151     * @param[in] duration Duration in second
25152     * @deprecated Use @ref Transit instead.
25153     */
25154    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
25155    /**
25156     * @brief Set the callback function for animator operation.
25157     *
25158     * @param[in] animator Animator object
25159     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
25160     * @param[in] data Callback function user argument
25161     *
25162     * The @p func callback will be called with a frame value in range [0, 1] which
25163     * indicates how far along the animation should be. It is the job of @p func to
25164     * actually change the state of any object(or objects) that are being animated.
25165     * @deprecated Use @ref Transit instead.
25166     */
25167    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
25168    /**
25169     * Set the callback function for the when the animation ends.
25170     *
25171     * @param[in]  animator Animator object
25172     * @param[in]  func   Callback function pointe
25173     * @param[in]  data Callback function user argument
25174     *
25175     * @warning @a func will not be executed if elm_animator_stop() is called.
25176     * @deprecated Use @ref Transit instead.
25177     */
25178    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
25179    /**
25180     * @brief Stop animator.
25181     *
25182     * @param[in] animator Animator object
25183     *
25184     * If called before elm_animator_animate() it does nothing. If there is an
25185     * animation in progress the animation will be stopped(the operation callback
25186     * will not be executed again) and it can't be restarted using
25187     * elm_animator_resume().
25188     * @deprecated Use @ref Transit instead.
25189     */
25190    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25191    /**
25192     * Set the animator repeat count.
25193     *
25194     * @param[in]  animator Animator object
25195     * @param[in]  repeat_cnt Repeat count
25196     * @deprecated Use @ref Transit instead.
25197     */
25198    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
25199    /**
25200     * @brief Start animation.
25201     *
25202     * @param[in] animator Animator object
25203     *
25204     * This function starts the animation if the nescessary properties(duration
25205     * and operation callback) have been set. Once started the animation will
25206     * run until complete or elm_animator_stop() is called.
25207     * @deprecated Use @ref Transit instead.
25208     */
25209    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25210    /**
25211     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
25212     *
25213     * @param[in] animator Animator object
25214     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
25215     * @deprecated Use @ref Transit instead.
25216     */
25217    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
25218    /**
25219     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
25220     *
25221     * @param[in] animator Animator object
25222     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
25223     * @deprecated Use @ref Transit instead.
25224     */
25225    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25226    /**
25227     * @brief Sets wether the animation should be automatically reversed.
25228     *
25229     * @param[in] animator Animator object
25230     * @param[in] reverse Reverse or not
25231     *
25232     * This controls wether the animation will be run on reverse imediately after
25233     * running forward. When this is set together with repetition the animation
25234     * will run in reverse once for each time it ran forward.@n
25235     * Runnin an animation in reverse is accomplished by calling the operation
25236     * callback with a frame value starting at 1 and diminshing until 0.
25237     * @deprecated Use @ref Transit instead.
25238     */
25239    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25240    /**
25241     * Gets wether the animation will automatically reversed
25242     *
25243     * @param[in] animator Animator object
25244     * @deprecated Use @ref Transit instead.
25245     */
25246    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25247    /**
25248     * Gets the status for the animator operation. The status of the animator @b
25249     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
25250     * only informs if the animation was started and has not ended(either normally
25251     * or through elm_animator_stop()).
25252     *
25253     * @param[in] animator Animator object
25254     * @deprecated Use @ref Transit instead.
25255     */
25256    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25257    /**
25258     * Gets how many times the animation will be repeated
25259     *
25260     * @param[in] animator Animator object
25261     * @deprecated Use @ref Transit instead.
25262     */
25263    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
25264    /**
25265     * Pause the animator.
25266     *
25267     * @param[in]  animator Animator object
25268     *
25269     * This causes the animation to be temporarily stopped(the operation callback
25270     * will not be called). If the animation is not yet running this is a no-op.
25271     * Once an animation has been paused with this function it can be resumed
25272     * using elm_animator_resume().
25273     * @deprecated Use @ref Transit instead.
25274     */
25275    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25276    /**
25277     * @brief Resumes the animator.
25278     *
25279     * @param[in]  animator Animator object
25280     *
25281     * Resumes an animation that was paused using elm_animator_pause(), after
25282     * calling this function calls to the operation callback will happen
25283     * normally. If an animation is stopped by means of elm_animator_stop it
25284     * @b can't be restarted with this function.@n
25285     *
25286     * @warning When an animation is resumed it doesn't start from where it was paused, it
25287     * will go to where it would have been if it had not been paused. If an
25288     * animation with a duration of 3 seconds is paused after 1 second for 1 second
25289     * it will resume as if it had ben animating for 2 seconds, the operating
25290     * callback will be called with a frame value of aproximately 2/3.
25291     * @deprecated Use @ref Transit instead.
25292     */
25293    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
25294    /**
25295     * @}
25296     */
25297
25298    /**
25299     * @addtogroup Calendar
25300     * @{
25301     */
25302
25303    /**
25304     * @enum _Elm_Calendar_Mark_Repeat
25305     * @typedef Elm_Calendar_Mark_Repeat
25306     *
25307     * Event periodicity, used to define if a mark should be repeated
25308     * @b beyond event's day. It's set when a mark is added.
25309     *
25310     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25311     * there will be marks every week after this date. Marks will be displayed
25312     * at 13th, 20th, 27th, 3rd June ...
25313     *
25314     * Values don't work as bitmask, only one can be choosen.
25315     *
25316     * @see elm_calendar_mark_add()
25317     *
25318     * @ingroup Calendar
25319     */
25320    typedef enum _Elm_Calendar_Mark_Repeat
25321      {
25322         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25323         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25324         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25325         ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
25326         ELM_CALENDAR_ANNUALLY /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
25327      } Elm_Calendar_Mark_Repeat;
25328
25329    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */
25330
25331    /**
25332     * Add a new calendar widget to the given parent Elementary
25333     * (container) object.
25334     *
25335     * @param parent The parent object.
25336     * @return a new calendar widget handle or @c NULL, on errors.
25337     *
25338     * This function inserts a new calendar widget on the canvas.
25339     *
25340     * @ref calendar_example_01
25341     *
25342     * @ingroup Calendar
25343     */
25344    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25345
25346    /**
25347     * Get weekdays names displayed by the calendar.
25348     *
25349     * @param obj The calendar object.
25350     * @return Array of seven strings to be used as weekday names.
25351     *
25352     * By default, weekdays abbreviations get from system are displayed:
25353     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25354     * The first string is related to Sunday, the second to Monday...
25355     *
25356     * @see elm_calendar_weekdays_name_set()
25357     *
25358     * @ref calendar_example_05
25359     *
25360     * @ingroup Calendar
25361     */
25362    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25363
25364    /**
25365     * Set weekdays names to be displayed by the calendar.
25366     *
25367     * @param obj The calendar object.
25368     * @param weekdays Array of seven strings to be used as weekday names.
25369     * @warning It must have 7 elements, or it will access invalid memory.
25370     * @warning The strings must be NULL terminated ('@\0').
25371     *
25372     * By default, weekdays abbreviations get from system are displayed:
25373     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25374     *
25375     * The first string should be related to Sunday, the second to Monday...
25376     *
25377     * The usage should be like this:
25378     * @code
25379     *   const char *weekdays[] =
25380     *   {
25381     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25382     *      "Thursday", "Friday", "Saturday"
25383     *   };
25384     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25385     * @endcode
25386     *
25387     * @see elm_calendar_weekdays_name_get()
25388     *
25389     * @ref calendar_example_02
25390     *
25391     * @ingroup Calendar
25392     */
25393    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25394
25395    /**
25396     * Set the minimum and maximum values for the year
25397     *
25398     * @param obj The calendar object
25399     * @param min The minimum year, greater than 1901;
25400     * @param max The maximum year;
25401     *
25402     * Maximum must be greater than minimum, except if you don't wan't to set
25403     * maximum year.
25404     * Default values are 1902 and -1.
25405     *
25406     * If the maximum year is a negative value, it will be limited depending
25407     * on the platform architecture (year 2037 for 32 bits);
25408     *
25409     * @see elm_calendar_min_max_year_get()
25410     *
25411     * @ref calendar_example_03
25412     *
25413     * @ingroup Calendar
25414     */
25415    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25416
25417    /**
25418     * Get the minimum and maximum values for the year
25419     *
25420     * @param obj The calendar object.
25421     * @param min The minimum year.
25422     * @param max The maximum year.
25423     *
25424     * Default values are 1902 and -1.
25425     *
25426     * @see elm_calendar_min_max_year_get() for more details.
25427     *
25428     * @ref calendar_example_05
25429     *
25430     * @ingroup Calendar
25431     */
25432    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25433
25434    /**
25435     * Enable or disable day selection
25436     *
25437     * @param obj The calendar object.
25438     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25439     * disable it.
25440     *
25441     * Enabled by default. If disabled, the user still can select months,
25442     * but not days. Selected days are highlighted on calendar.
25443     * It should be used if you won't need such selection for the widget usage.
25444     *
25445     * When a day is selected, or month is changed, smart callbacks for
25446     * signal "changed" will be called.
25447     *
25448     * @see elm_calendar_day_selection_enable_get()
25449     *
25450     * @ref calendar_example_04
25451     *
25452     * @ingroup Calendar
25453     */
25454    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25455
25456    /**
25457     * Get a value whether day selection is enabled or not.
25458     *
25459     * @see elm_calendar_day_selection_enable_set() for details.
25460     *
25461     * @param obj The calendar object.
25462     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25463     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25464     *
25465     * @ref calendar_example_05
25466     *
25467     * @ingroup Calendar
25468     */
25469    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25470
25471
25472    /**
25473     * Set selected date to be highlighted on calendar.
25474     *
25475     * @param obj The calendar object.
25476     * @param selected_time A @b tm struct to represent the selected date.
25477     *
25478     * Set the selected date, changing the displayed month if needed.
25479     * Selected date changes when the user goes to next/previous month or
25480     * select a day pressing over it on calendar.
25481     *
25482     * @see elm_calendar_selected_time_get()
25483     *
25484     * @ref calendar_example_04
25485     *
25486     * @ingroup Calendar
25487     */
25488    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25489
25490    /**
25491     * Get selected date.
25492     *
25493     * @param obj The calendar object
25494     * @param selected_time A @b tm struct to point to selected date
25495     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25496     * be considered.
25497     *
25498     * Get date selected by the user or set by function
25499     * elm_calendar_selected_time_set().
25500     * Selected date changes when the user goes to next/previous month or
25501     * select a day pressing over it on calendar.
25502     *
25503     * @see elm_calendar_selected_time_get()
25504     *
25505     * @ref calendar_example_05
25506     *
25507     * @ingroup Calendar
25508     */
25509    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25510
25511    /**
25512     * Set a function to format the string that will be used to display
25513     * month and year;
25514     *
25515     * @param obj The calendar object
25516     * @param format_function Function to set the month-year string given
25517     * the selected date
25518     *
25519     * By default it uses strftime with "%B %Y" format string.
25520     * It should allocate the memory that will be used by the string,
25521     * that will be freed by the widget after usage.
25522     * A pointer to the string and a pointer to the time struct will be provided.
25523     *
25524     * Example:
25525     * @code
25526     * static char *
25527     * _format_month_year(struct tm *selected_time)
25528     * {
25529     *    char buf[32];
25530     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25531     *    return strdup(buf);
25532     * }
25533     *
25534     * elm_calendar_format_function_set(calendar, _format_month_year);
25535     * @endcode
25536     *
25537     * @ref calendar_example_02
25538     *
25539     * @ingroup Calendar
25540     */
25541    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25542
25543    /**
25544     * Add a new mark to the calendar
25545     *
25546     * @param obj The calendar object
25547     * @param mark_type A string used to define the type of mark. It will be
25548     * emitted to the theme, that should display a related modification on these
25549     * days representation.
25550     * @param mark_time A time struct to represent the date of inclusion of the
25551     * mark. For marks that repeats it will just be displayed after the inclusion
25552     * date in the calendar.
25553     * @param repeat Repeat the event following this periodicity. Can be a unique
25554     * mark (that don't repeat), daily, weekly, monthly or annually.
25555     * @return The created mark or @p NULL upon failure.
25556     *
25557     * Add a mark that will be drawn in the calendar respecting the insertion
25558     * time and periodicity. It will emit the type as signal to the widget theme.
25559     * Default theme supports "holiday" and "checked", but it can be extended.
25560     *
25561     * It won't immediately update the calendar, drawing the marks.
25562     * For this, call elm_calendar_marks_draw(). However, when user selects
25563     * next or previous month calendar forces marks drawn.
25564     *
25565     * Marks created with this method can be deleted with
25566     * elm_calendar_mark_del().
25567     *
25568     * Example
25569     * @code
25570     * struct tm selected_time;
25571     * time_t current_time;
25572     *
25573     * current_time = time(NULL) + 5 * 84600;
25574     * localtime_r(&current_time, &selected_time);
25575     * elm_calendar_mark_add(cal, "holiday", selected_time,
25576     *     ELM_CALENDAR_ANNUALLY);
25577     *
25578     * current_time = time(NULL) + 1 * 84600;
25579     * localtime_r(&current_time, &selected_time);
25580     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25581     *
25582     * elm_calendar_marks_draw(cal);
25583     * @endcode
25584     *
25585     * @see elm_calendar_marks_draw()
25586     * @see elm_calendar_mark_del()
25587     *
25588     * @ref calendar_example_06
25589     *
25590     * @ingroup Calendar
25591     */
25592    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);
25593
25594    /**
25595     * Delete mark from the calendar.
25596     *
25597     * @param mark The mark to be deleted.
25598     *
25599     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25600     * should be used instead of getting marks list and deleting each one.
25601     *
25602     * @see elm_calendar_mark_add()
25603     *
25604     * @ref calendar_example_06
25605     *
25606     * @ingroup Calendar
25607     */
25608    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25609
25610    /**
25611     * Remove all calendar's marks
25612     *
25613     * @param obj The calendar object.
25614     *
25615     * @see elm_calendar_mark_add()
25616     * @see elm_calendar_mark_del()
25617     *
25618     * @ingroup Calendar
25619     */
25620    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25621
25622
25623    /**
25624     * Get a list of all the calendar marks.
25625     *
25626     * @param obj The calendar object.
25627     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25628     *
25629     * @see elm_calendar_mark_add()
25630     * @see elm_calendar_mark_del()
25631     * @see elm_calendar_marks_clear()
25632     *
25633     * @ingroup Calendar
25634     */
25635    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25636
25637    /**
25638     * Draw calendar marks.
25639     *
25640     * @param obj The calendar object.
25641     *
25642     * Should be used after adding, removing or clearing marks.
25643     * It will go through the entire marks list updating the calendar.
25644     * If lots of marks will be added, add all the marks and then call
25645     * this function.
25646     *
25647     * When the month is changed, i.e. user selects next or previous month,
25648     * marks will be drawed.
25649     *
25650     * @see elm_calendar_mark_add()
25651     * @see elm_calendar_mark_del()
25652     * @see elm_calendar_marks_clear()
25653     *
25654     * @ref calendar_example_06
25655     *
25656     * @ingroup Calendar
25657     */
25658    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25659    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25660    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25661    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25662
25663    /**
25664     * Set a day text color to the same that represents Saturdays.
25665     *
25666     * @param obj The calendar object.
25667     * @param pos The text position. Position is the cell counter, from left
25668     * to right, up to down. It starts on 0 and ends on 41.
25669     *
25670     * @deprecated use elm_calendar_mark_add() instead like:
25671     *
25672     * @code
25673     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25674     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25675     * @endcode
25676     *
25677     * @see elm_calendar_mark_add()
25678     *
25679     * @ingroup Calendar
25680     */
25681    EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25682
25683    /**
25684     * Set a day text color to the same that represents Sundays.
25685     *
25686     * @param obj The calendar object.
25687     * @param pos The text position. Position is the cell counter, from left
25688     * to right, up to down. It starts on 0 and ends on 41.
25689
25690     * @deprecated use elm_calendar_mark_add() instead like:
25691     *
25692     * @code
25693     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25694     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25695     * @endcode
25696     *
25697     * @see elm_calendar_mark_add()
25698     *
25699     * @ingroup Calendar
25700     */
25701    EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25702
25703    /**
25704     * Set a day text color to the same that represents Weekdays.
25705     *
25706     * @param obj The calendar object
25707     * @param pos The text position. Position is the cell counter, from left
25708     * to right, up to down. It starts on 0 and ends on 41.
25709     *
25710     * @deprecated use elm_calendar_mark_add() instead like:
25711     *
25712     * @code
25713     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25714     *
25715     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25716     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25717     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25718     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25719     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25720     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25721     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25722     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25723     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25724     * @endcode
25725     *
25726     * @see elm_calendar_mark_add()
25727     *
25728     * @ingroup Calendar
25729     */
25730    EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25731
25732    /**
25733     * Set the interval on time updates for an user mouse button hold
25734     * on calendar widgets' month selection.
25735     *
25736     * @param obj The calendar object
25737     * @param interval The (first) interval value in seconds
25738     *
25739     * This interval value is @b decreased while the user holds the
25740     * mouse pointer either selecting next or previous month.
25741     *
25742     * This helps the user to get to a given month distant from the
25743     * current one easier/faster, as it will start to change quicker and
25744     * quicker on mouse button holds.
25745     *
25746     * The calculation for the next change interval value, starting from
25747     * the one set with this call, is the previous interval divided by
25748     * 1.05, so it decreases a little bit.
25749     *
25750     * The default starting interval value for automatic changes is
25751     * @b 0.85 seconds.
25752     *
25753     * @see elm_calendar_interval_get()
25754     *
25755     * @ingroup Calendar
25756     */
25757    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25758
25759    /**
25760     * Get the interval on time updates for an user mouse button hold
25761     * on calendar widgets' month selection.
25762     *
25763     * @param obj The calendar object
25764     * @return The (first) interval value, in seconds, set on it
25765     *
25766     * @see elm_calendar_interval_set() for more details
25767     *
25768     * @ingroup Calendar
25769     */
25770    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25771
25772    /**
25773     * @}
25774     */
25775
25776    /**
25777     * @defgroup Diskselector Diskselector
25778     * @ingroup Elementary
25779     *
25780     * @image html img/widget/diskselector/preview-00.png
25781     * @image latex img/widget/diskselector/preview-00.eps
25782     *
25783     * A diskselector is a kind of list widget. It scrolls horizontally,
25784     * and can contain label and icon objects. Three items are displayed
25785     * with the selected one in the middle.
25786     *
25787     * It can act like a circular list with round mode and labels can be
25788     * reduced for a defined length for side items.
25789     *
25790     * Smart callbacks one can listen to:
25791     * - "selected" - when item is selected, i.e. scroller stops.
25792     *
25793     * Available styles for it:
25794     * - @c "default"
25795     *
25796     * List of examples:
25797     * @li @ref diskselector_example_01
25798     * @li @ref diskselector_example_02
25799     */
25800
25801    /**
25802     * @addtogroup Diskselector
25803     * @{
25804     */
25805
25806    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item; /**< Item handle for a diskselector item. Created with elm_diskselector_item_append() and deleted with elm_diskselector_item_del(). */
25807
25808    /**
25809     * Add a new diskselector widget to the given parent Elementary
25810     * (container) object.
25811     *
25812     * @param parent The parent object.
25813     * @return a new diskselector widget handle or @c NULL, on errors.
25814     *
25815     * This function inserts a new diskselector widget on the canvas.
25816     *
25817     * @ingroup Diskselector
25818     */
25819    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25820
25821    /**
25822     * Enable or disable round mode.
25823     *
25824     * @param obj The diskselector object.
25825     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25826     * disable it.
25827     *
25828     * Disabled by default. If round mode is enabled the items list will
25829     * work like a circle list, so when the user reaches the last item,
25830     * the first one will popup.
25831     *
25832     * @see elm_diskselector_round_get()
25833     *
25834     * @ingroup Diskselector
25835     */
25836    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25837
25838    /**
25839     * Get a value whether round mode is enabled or not.
25840     *
25841     * @see elm_diskselector_round_set() for details.
25842     *
25843     * @param obj The diskselector object.
25844     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25845     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25846     *
25847     * @ingroup Diskselector
25848     */
25849    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25850
25851    /**
25852     * Get the side labels max length.
25853     *
25854     * @deprecated use elm_diskselector_side_label_length_get() instead:
25855     *
25856     * @param obj The diskselector object.
25857     * @return The max length defined for side labels, or 0 if not a valid
25858     * diskselector.
25859     *
25860     * @ingroup Diskselector
25861     */
25862    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25863
25864    /**
25865     * Set the side labels max length.
25866     *
25867     * @deprecated use elm_diskselector_side_label_length_set() instead:
25868     *
25869     * @param obj The diskselector object.
25870     * @param len The max length defined for side labels.
25871     *
25872     * @ingroup Diskselector
25873     */
25874    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25875
25876    /**
25877     * Get the side labels max length.
25878     *
25879     * @see elm_diskselector_side_label_length_set() for details.
25880     *
25881     * @param obj The diskselector object.
25882     * @return The max length defined for side labels, or 0 if not a valid
25883     * diskselector.
25884     *
25885     * @ingroup Diskselector
25886     */
25887    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25888
25889    /**
25890     * Set the side labels max length.
25891     *
25892     * @param obj The diskselector object.
25893     * @param len The max length defined for side labels.
25894     *
25895     * Length is the number of characters of items' label that will be
25896     * visible when it's set on side positions. It will just crop
25897     * the string after defined size. E.g.:
25898     *
25899     * An item with label "January" would be displayed on side position as
25900     * "Jan" if max length is set to 3, or "Janu", if this property
25901     * is set to 4.
25902     *
25903     * When it's selected, the entire label will be displayed, except for
25904     * width restrictions. In this case label will be cropped and "..."
25905     * will be concatenated.
25906     *
25907     * Default side label max length is 3.
25908     *
25909     * This property will be applyed over all items, included before or
25910     * later this function call.
25911     *
25912     * @ingroup Diskselector
25913     */
25914    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25915
25916    /**
25917     * Set the number of items to be displayed.
25918     *
25919     * @param obj The diskselector object.
25920     * @param num The number of items the diskselector will display.
25921     *
25922     * Default value is 3, and also it's the minimun. If @p num is less
25923     * than 3, it will be set to 3.
25924     *
25925     * Also, it can be set on theme, using data item @c display_item_num
25926     * on group "elm/diskselector/item/X", where X is style set.
25927     * E.g.:
25928     *
25929     * group { name: "elm/diskselector/item/X";
25930     * data {
25931     *     item: "display_item_num" "5";
25932     *     }
25933     *
25934     * @ingroup Diskselector
25935     */
25936    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25937
25938    /**
25939     * Get the number of items in the diskselector object.
25940     *
25941     * @param obj The diskselector object.
25942     *
25943     * @ingroup Diskselector
25944     */
25945    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25946
25947    /**
25948     * Set bouncing behaviour when the scrolled content reaches an edge.
25949     *
25950     * Tell the internal scroller object whether it should bounce or not
25951     * when it reaches the respective edges for each axis.
25952     *
25953     * @param obj The diskselector object.
25954     * @param h_bounce Whether to bounce or not in the horizontal axis.
25955     * @param v_bounce Whether to bounce or not in the vertical axis.
25956     *
25957     * @see elm_scroller_bounce_set()
25958     *
25959     * @ingroup Diskselector
25960     */
25961    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25962
25963    /**
25964     * Get the bouncing behaviour of the internal scroller.
25965     *
25966     * Get whether the internal scroller should bounce when the edge of each
25967     * axis is reached scrolling.
25968     *
25969     * @param obj The diskselector object.
25970     * @param h_bounce Pointer where to store the bounce state of the horizontal
25971     * axis.
25972     * @param v_bounce Pointer where to store the bounce state of the vertical
25973     * axis.
25974     *
25975     * @see elm_scroller_bounce_get()
25976     * @see elm_diskselector_bounce_set()
25977     *
25978     * @ingroup Diskselector
25979     */
25980    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25981
25982    /**
25983     * Get the scrollbar policy.
25984     *
25985     * @see elm_diskselector_scroller_policy_get() for details.
25986     *
25987     * @param obj The diskselector object.
25988     * @param policy_h Pointer where to store horizontal scrollbar policy.
25989     * @param policy_v Pointer where to store vertical scrollbar policy.
25990     *
25991     * @ingroup Diskselector
25992     */
25993    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);
25994
25995    /**
25996     * Set the scrollbar policy.
25997     *
25998     * @param obj The diskselector object.
25999     * @param policy_h Horizontal scrollbar policy.
26000     * @param policy_v Vertical scrollbar policy.
26001     *
26002     * This sets the scrollbar visibility policy for the given scroller.
26003     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26004     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26005     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26006     * This applies respectively for the horizontal and vertical scrollbars.
26007     *
26008     * The both are disabled by default, i.e., are set to
26009     * #ELM_SCROLLER_POLICY_OFF.
26010     *
26011     * @ingroup Diskselector
26012     */
26013    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26014
26015    /**
26016     * Remove all diskselector's items.
26017     *
26018     * @param obj The diskselector object.
26019     *
26020     * @see elm_diskselector_item_del()
26021     * @see elm_diskselector_item_append()
26022     *
26023     * @ingroup Diskselector
26024     */
26025    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26026
26027    /**
26028     * Get a list of all the diskselector items.
26029     *
26030     * @param obj The diskselector object.
26031     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26032     * or @c NULL on failure.
26033     *
26034     * @see elm_diskselector_item_append()
26035     * @see elm_diskselector_item_del()
26036     * @see elm_diskselector_clear()
26037     *
26038     * @ingroup Diskselector
26039     */
26040    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26041
26042    /**
26043     * Appends a new item to the diskselector object.
26044     *
26045     * @param obj The diskselector object.
26046     * @param label The label of the diskselector item.
26047     * @param icon The icon object to use at left side of the item. An
26048     * icon can be any Evas object, but usually it is an icon created
26049     * with elm_icon_add().
26050     * @param func The function to call when the item is selected.
26051     * @param data The data to associate with the item for related callbacks.
26052     *
26053     * @return The created item or @c NULL upon failure.
26054     *
26055     * A new item will be created and appended to the diskselector, i.e., will
26056     * be set as last item. Also, if there is no selected item, it will
26057     * be selected. This will always happens for the first appended item.
26058     *
26059     * If no icon is set, label will be centered on item position, otherwise
26060     * the icon will be placed at left of the label, that will be shifted
26061     * to the right.
26062     *
26063     * Items created with this method can be deleted with
26064     * elm_diskselector_item_del().
26065     *
26066     * Associated @p data can be properly freed when item is deleted if a
26067     * callback function is set with elm_diskselector_item_del_cb_set().
26068     *
26069     * If a function is passed as argument, it will be called everytime this item
26070     * is selected, i.e., the user stops the diskselector with this
26071     * item on center position. If such function isn't needed, just passing
26072     * @c NULL as @p func is enough. The same should be done for @p data.
26073     *
26074     * Simple example (with no function callback or data associated):
26075     * @code
26076     * disk = elm_diskselector_add(win);
26077     * ic = elm_icon_add(win);
26078     * elm_icon_file_set(ic, "path/to/image", NULL);
26079     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26080     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26081     * @endcode
26082     *
26083     * @see elm_diskselector_item_del()
26084     * @see elm_diskselector_item_del_cb_set()
26085     * @see elm_diskselector_clear()
26086     * @see elm_icon_add()
26087     *
26088     * @ingroup Diskselector
26089     */
26090    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);
26091
26092
26093    /**
26094     * Delete them item from the diskselector.
26095     *
26096     * @param it The item of diskselector to be deleted.
26097     *
26098     * If deleting all diskselector items is required, elm_diskselector_clear()
26099     * should be used instead of getting items list and deleting each one.
26100     *
26101     * @see elm_diskselector_clear()
26102     * @see elm_diskselector_item_append()
26103     * @see elm_diskselector_item_del_cb_set()
26104     *
26105     * @ingroup Diskselector
26106     */
26107    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26108
26109    /**
26110     * Set the function called when a diskselector item is freed.
26111     *
26112     * @param it The item to set the callback on
26113     * @param func The function called
26114     *
26115     * If there is a @p func, then it will be called prior item's memory release.
26116     * That will be called with the following arguments:
26117     * @li item's data;
26118     * @li item's Evas object;
26119     * @li item itself;
26120     *
26121     * This way, a data associated to a diskselector item could be properly
26122     * freed.
26123     *
26124     * @ingroup Diskselector
26125     */
26126    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26127
26128    /**
26129     * Get the data associated to the item.
26130     *
26131     * @param it The diskselector item
26132     * @return The data associated to @p it
26133     *
26134     * The return value is a pointer to data associated to @p item when it was
26135     * created, with function elm_diskselector_item_append(). If no data
26136     * was passed as argument, it will return @c NULL.
26137     *
26138     * @see elm_diskselector_item_append()
26139     *
26140     * @ingroup Diskselector
26141     */
26142    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26143
26144    /**
26145     * Set the icon associated to the item.
26146     *
26147     * @param it The diskselector item
26148     * @param icon The icon object to associate with @p it
26149     *
26150     * The icon object to use at left side of the item. An
26151     * icon can be any Evas object, but usually it is an icon created
26152     * with elm_icon_add().
26153     *
26154     * Once the icon object is set, a previously set one will be deleted.
26155     * @warning Setting the same icon for two items will cause the icon to
26156     * dissapear from the first item.
26157     *
26158     * If an icon was passed as argument on item creation, with function
26159     * elm_diskselector_item_append(), it will be already
26160     * associated to the item.
26161     *
26162     * @see elm_diskselector_item_append()
26163     * @see elm_diskselector_item_icon_get()
26164     *
26165     * @ingroup Diskselector
26166     */
26167    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26168
26169    /**
26170     * Get the icon associated to the item.
26171     *
26172     * @param it The diskselector item
26173     * @return The icon associated to @p it
26174     *
26175     * The return value is a pointer to the icon associated to @p item when it was
26176     * created, with function elm_diskselector_item_append(), or later
26177     * with function elm_diskselector_item_icon_set. If no icon
26178     * was passed as argument, it will return @c NULL.
26179     *
26180     * @see elm_diskselector_item_append()
26181     * @see elm_diskselector_item_icon_set()
26182     *
26183     * @ingroup Diskselector
26184     */
26185    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26186
26187    /**
26188     * Set the label of item.
26189     *
26190     * @param it The item of diskselector.
26191     * @param label The label of item.
26192     *
26193     * The label to be displayed by the item.
26194     *
26195     * If no icon is set, label will be centered on item position, otherwise
26196     * the icon will be placed at left of the label, that will be shifted
26197     * to the right.
26198     *
26199     * An item with label "January" would be displayed on side position as
26200     * "Jan" if max length is set to 3 with function
26201     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26202     * is set to 4.
26203     *
26204     * When this @p item is selected, the entire label will be displayed,
26205     * except for width restrictions.
26206     * In this case label will be cropped and "..." will be concatenated,
26207     * but only for display purposes. It will keep the entire string, so
26208     * if diskselector is resized the remaining characters will be displayed.
26209     *
26210     * If a label was passed as argument on item creation, with function
26211     * elm_diskselector_item_append(), it will be already
26212     * displayed by the item.
26213     *
26214     * @see elm_diskselector_side_label_lenght_set()
26215     * @see elm_diskselector_item_label_get()
26216     * @see elm_diskselector_item_append()
26217     *
26218     * @ingroup Diskselector
26219     */
26220    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26221
26222    /**
26223     * Get the label of item.
26224     *
26225     * @param it The item of diskselector.
26226     * @return The label of item.
26227     *
26228     * The return value is a pointer to the label associated to @p item when it was
26229     * created, with function elm_diskselector_item_append(), or later
26230     * with function elm_diskselector_item_label_set. If no label
26231     * was passed as argument, it will return @c NULL.
26232     *
26233     * @see elm_diskselector_item_label_set() for more details.
26234     * @see elm_diskselector_item_append()
26235     *
26236     * @ingroup Diskselector
26237     */
26238    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26239
26240    /**
26241     * Get the selected item.
26242     *
26243     * @param obj The diskselector object.
26244     * @return The selected diskselector item.
26245     *
26246     * The selected item can be unselected with function
26247     * elm_diskselector_item_selected_set(), and the first item of
26248     * diskselector will be selected.
26249     *
26250     * The selected item always will be centered on diskselector, with
26251     * full label displayed, i.e., max lenght set to side labels won't
26252     * apply on the selected item. More details on
26253     * elm_diskselector_side_label_length_set().
26254     *
26255     * @ingroup Diskselector
26256     */
26257    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26258
26259    /**
26260     * Set the selected state of an item.
26261     *
26262     * @param it The diskselector item
26263     * @param selected The selected state
26264     *
26265     * This sets the selected state of the given item @p it.
26266     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26267     *
26268     * If a new item is selected the previosly selected will be unselected.
26269     * Previoulsy selected item can be get with function
26270     * elm_diskselector_selected_item_get().
26271     *
26272     * If the item @p it is unselected, the first item of diskselector will
26273     * be selected.
26274     *
26275     * Selected items will be visible on center position of diskselector.
26276     * So if it was on another position before selected, or was invisible,
26277     * diskselector will animate items until the selected item reaches center
26278     * position.
26279     *
26280     * @see elm_diskselector_item_selected_get()
26281     * @see elm_diskselector_selected_item_get()
26282     *
26283     * @ingroup Diskselector
26284     */
26285    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26286
26287    /*
26288     * Get whether the @p item is selected or not.
26289     *
26290     * @param it The diskselector item.
26291     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26292     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26293     *
26294     * @see elm_diskselector_selected_item_set() for details.
26295     * @see elm_diskselector_item_selected_get()
26296     *
26297     * @ingroup Diskselector
26298     */
26299    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26300
26301    /**
26302     * Get the first item of the diskselector.
26303     *
26304     * @param obj The diskselector object.
26305     * @return The first item, or @c NULL if none.
26306     *
26307     * The list of items follows append order. So it will return the first
26308     * item appended to the widget that wasn't deleted.
26309     *
26310     * @see elm_diskselector_item_append()
26311     * @see elm_diskselector_items_get()
26312     *
26313     * @ingroup Diskselector
26314     */
26315    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26316
26317    /**
26318     * Get the last item of the diskselector.
26319     *
26320     * @param obj The diskselector object.
26321     * @return The last item, or @c NULL if none.
26322     *
26323     * The list of items follows append order. So it will return last first
26324     * item appended to the widget that wasn't deleted.
26325     *
26326     * @see elm_diskselector_item_append()
26327     * @see elm_diskselector_items_get()
26328     *
26329     * @ingroup Diskselector
26330     */
26331    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26332
26333    /**
26334     * Get the item before @p item in diskselector.
26335     *
26336     * @param it The diskselector item.
26337     * @return The item before @p item, or @c NULL if none or on failure.
26338     *
26339     * The list of items follows append order. So it will return item appended
26340     * just before @p item and that wasn't deleted.
26341     *
26342     * If it is the first item, @c NULL will be returned.
26343     * First item can be get by elm_diskselector_first_item_get().
26344     *
26345     * @see elm_diskselector_item_append()
26346     * @see elm_diskselector_items_get()
26347     *
26348     * @ingroup Diskselector
26349     */
26350    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26351
26352    /**
26353     * Get the item after @p item in diskselector.
26354     *
26355     * @param it The diskselector item.
26356     * @return The item after @p item, or @c NULL if none or on failure.
26357     *
26358     * The list of items follows append order. So it will return item appended
26359     * just after @p item and that wasn't deleted.
26360     *
26361     * If it is the last item, @c NULL will be returned.
26362     * Last item can be get by elm_diskselector_last_item_get().
26363     *
26364     * @see elm_diskselector_item_append()
26365     * @see elm_diskselector_items_get()
26366     *
26367     * @ingroup Diskselector
26368     */
26369    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26370
26371    /**
26372     * Set the text to be shown in the diskselector item.
26373     *
26374     * @param item Target item
26375     * @param text The text to set in the content
26376     *
26377     * Setup the text as tooltip to object. The item can have only one tooltip,
26378     * so any previous tooltip data is removed.
26379     *
26380     * @see elm_object_tooltip_text_set() for more details.
26381     *
26382     * @ingroup Diskselector
26383     */
26384    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26385
26386    /**
26387     * Set the content to be shown in the tooltip item.
26388     *
26389     * Setup the tooltip to item. The item can have only one tooltip,
26390     * so any previous tooltip data is removed. @p func(with @p data) will
26391     * be called every time that need show the tooltip and it should
26392     * return a valid Evas_Object. This object is then managed fully by
26393     * tooltip system and is deleted when the tooltip is gone.
26394     *
26395     * @param item the diskselector item being attached a tooltip.
26396     * @param func the function used to create the tooltip contents.
26397     * @param data what to provide to @a func as callback data/context.
26398     * @param del_cb called when data is not needed anymore, either when
26399     *        another callback replaces @p func, the tooltip is unset with
26400     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26401     *        dies. This callback receives as the first parameter the
26402     *        given @a data, and @c event_info is the item.
26403     *
26404     * @see elm_object_tooltip_content_cb_set() for more details.
26405     *
26406     * @ingroup Diskselector
26407     */
26408    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);
26409
26410    /**
26411     * Unset tooltip from item.
26412     *
26413     * @param item diskselector item to remove previously set tooltip.
26414     *
26415     * Remove tooltip from item. The callback provided as del_cb to
26416     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26417     * it is not used anymore.
26418     *
26419     * @see elm_object_tooltip_unset() for more details.
26420     * @see elm_diskselector_item_tooltip_content_cb_set()
26421     *
26422     * @ingroup Diskselector
26423     */
26424    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26425
26426
26427    /**
26428     * Sets a different style for this item tooltip.
26429     *
26430     * @note before you set a style you should define a tooltip with
26431     *       elm_diskselector_item_tooltip_content_cb_set() or
26432     *       elm_diskselector_item_tooltip_text_set()
26433     *
26434     * @param item diskselector item with tooltip already set.
26435     * @param style the theme style to use (default, transparent, ...)
26436     *
26437     * @see elm_object_tooltip_style_set() for more details.
26438     *
26439     * @ingroup Diskselector
26440     */
26441    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26442
26443    /**
26444     * Get the style for this item tooltip.
26445     *
26446     * @param item diskselector item with tooltip already set.
26447     * @return style the theme style in use, defaults to "default". If the
26448     *         object does not have a tooltip set, then NULL is returned.
26449     *
26450     * @see elm_object_tooltip_style_get() for more details.
26451     * @see elm_diskselector_item_tooltip_style_set()
26452     *
26453     * @ingroup Diskselector
26454     */
26455    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26456
26457    /**
26458     * Set the cursor to be shown when mouse is over the diskselector item
26459     *
26460     * @param item Target item
26461     * @param cursor the cursor name to be used.
26462     *
26463     * @see elm_object_cursor_set() for more details.
26464     *
26465     * @ingroup Diskselector
26466     */
26467    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26468
26469    /**
26470     * Get the cursor to be shown when mouse is over the diskselector item
26471     *
26472     * @param item diskselector item with cursor already set.
26473     * @return the cursor name.
26474     *
26475     * @see elm_object_cursor_get() for more details.
26476     * @see elm_diskselector_cursor_set()
26477     *
26478     * @ingroup Diskselector
26479     */
26480    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26481
26482
26483    /**
26484     * Unset the cursor to be shown when mouse is over the diskselector item
26485     *
26486     * @param item Target item
26487     *
26488     * @see elm_object_cursor_unset() for more details.
26489     * @see elm_diskselector_cursor_set()
26490     *
26491     * @ingroup Diskselector
26492     */
26493    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26494
26495    /**
26496     * Sets a different style for this item cursor.
26497     *
26498     * @note before you set a style you should define a cursor with
26499     *       elm_diskselector_item_cursor_set()
26500     *
26501     * @param item diskselector item with cursor already set.
26502     * @param style the theme style to use (default, transparent, ...)
26503     *
26504     * @see elm_object_cursor_style_set() for more details.
26505     *
26506     * @ingroup Diskselector
26507     */
26508    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26509
26510
26511    /**
26512     * Get the style for this item cursor.
26513     *
26514     * @param item diskselector item with cursor already set.
26515     * @return style the theme style in use, defaults to "default". If the
26516     *         object does not have a cursor set, then @c NULL is returned.
26517     *
26518     * @see elm_object_cursor_style_get() for more details.
26519     * @see elm_diskselector_item_cursor_style_set()
26520     *
26521     * @ingroup Diskselector
26522     */
26523    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26524
26525
26526    /**
26527     * Set if the cursor set should be searched on the theme or should use
26528     * the provided by the engine, only.
26529     *
26530     * @note before you set if should look on theme you should define a cursor
26531     * with elm_diskselector_item_cursor_set().
26532     * By default it will only look for cursors provided by the engine.
26533     *
26534     * @param item widget item with cursor already set.
26535     * @param engine_only boolean to define if cursors set with
26536     * elm_diskselector_item_cursor_set() should be searched only
26537     * between cursors provided by the engine or searched on widget's
26538     * theme as well.
26539     *
26540     * @see elm_object_cursor_engine_only_set() for more details.
26541     *
26542     * @ingroup Diskselector
26543     */
26544    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26545
26546    /**
26547     * Get the cursor engine only usage for this item cursor.
26548     *
26549     * @param item widget item with cursor already set.
26550     * @return engine_only boolean to define it cursors should be looked only
26551     * between the provided by the engine or searched on widget's theme as well.
26552     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26553     *
26554     * @see elm_object_cursor_engine_only_get() for more details.
26555     * @see elm_diskselector_item_cursor_engine_only_set()
26556     *
26557     * @ingroup Diskselector
26558     */
26559    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26560
26561    /**
26562     * @}
26563     */
26564
26565    /**
26566     * @defgroup Colorselector Colorselector
26567     *
26568     * @{
26569     *
26570     * @image html img/widget/colorselector/preview-00.png
26571     * @image latex img/widget/colorselector/preview-00.eps
26572     *
26573     * @brief Widget for user to select a color.
26574     *
26575     * Signals that you can add callbacks for are:
26576     * "changed" - When the color value changes(event_info is NULL).
26577     *
26578     * See @ref tutorial_colorselector.
26579     */
26580    /**
26581     * @brief Add a new colorselector to the parent
26582     *
26583     * @param parent The parent object
26584     * @return The new object or NULL if it cannot be created
26585     *
26586     * @ingroup Colorselector
26587     */
26588    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26589    /**
26590     * Set a color for the colorselector
26591     *
26592     * @param obj   Colorselector object
26593     * @param r     r-value of color
26594     * @param g     g-value of color
26595     * @param b     b-value of color
26596     * @param a     a-value of color
26597     *
26598     * @ingroup Colorselector
26599     */
26600    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26601    /**
26602     * Get a color from the colorselector
26603     *
26604     * @param obj   Colorselector object
26605     * @param r     integer pointer for r-value of color
26606     * @param g     integer pointer for g-value of color
26607     * @param b     integer pointer for b-value of color
26608     * @param a     integer pointer for a-value of color
26609     *
26610     * @ingroup Colorselector
26611     */
26612    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26613    /**
26614     * @}
26615     */
26616
26617    /**
26618     * @defgroup Ctxpopup Ctxpopup
26619     *
26620     * @image html img/widget/ctxpopup/preview-00.png
26621     * @image latex img/widget/ctxpopup/preview-00.eps
26622     *
26623     * @brief Context popup widet.
26624     *
26625     * A ctxpopup is a widget that, when shown, pops up a list of items.
26626     * It automatically chooses an area inside its parent object's view
26627     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26628     * optimally fit into it. In the default theme, it will also point an
26629     * arrow to it's top left position at the time one shows it. Ctxpopup
26630     * items have a label and/or an icon. It is intended for a small
26631     * number of items (hence the use of list, not genlist).
26632     *
26633     * @note Ctxpopup is a especialization of @ref Hover.
26634     *
26635     * Signals that you can add callbacks for are:
26636     * "dismissed" - the ctxpopup was dismissed
26637     *
26638     * Default contents parts of the ctxpopup widget that you can use for are:
26639     * @li "elm.swallow.content" - A content of the ctxpopup
26640     *
26641     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26642     * @{
26643     */
26644    typedef enum _Elm_Ctxpopup_Direction
26645      {
26646         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26647                                           area */
26648         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26649                                            the clicked area */
26650         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26651                                           the clicked area */
26652         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26653                                         area */
26654         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26655      } Elm_Ctxpopup_Direction;
26656 #define Elm_Ctxpopup_Item Elm_Object_Item
26657
26658    /**
26659     * @brief Add a new Ctxpopup object to the parent.
26660     *
26661     * @param parent Parent object
26662     * @return New object or @c NULL, if it cannot be created
26663     */
26664    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26665    /**
26666     * @brief Set the Ctxpopup's parent
26667     *
26668     * @param obj The ctxpopup object
26669     * @param area The parent to use
26670     *
26671     * Set the parent object.
26672     *
26673     * @note elm_ctxpopup_add() will automatically call this function
26674     * with its @c parent argument.
26675     *
26676     * @see elm_ctxpopup_add()
26677     * @see elm_hover_parent_set()
26678     */
26679    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26680    /**
26681     * @brief Get the Ctxpopup's parent
26682     *
26683     * @param obj The ctxpopup object
26684     *
26685     * @see elm_ctxpopup_hover_parent_set() for more information
26686     */
26687    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26688    /**
26689     * @brief Clear all items in the given ctxpopup object.
26690     *
26691     * @param obj Ctxpopup object
26692     */
26693    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26694    /**
26695     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26696     *
26697     * @param obj Ctxpopup object
26698     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26699     */
26700    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26701    /**
26702     * @brief Get the value of current ctxpopup object's orientation.
26703     *
26704     * @param obj Ctxpopup object
26705     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26706     *
26707     * @see elm_ctxpopup_horizontal_set()
26708     */
26709    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26710    /**
26711     * @brief Add a new item to a ctxpopup object.
26712     *
26713     * @param obj Ctxpopup object
26714     * @param icon Icon to be set on new item
26715     * @param label The Label of the new item
26716     * @param func Convenience function called when item selected
26717     * @param data Data passed to @p func
26718     * @return A handle to the item added or @c NULL, on errors
26719     *
26720     * @warning Ctxpopup can't hold both an item list and a content at the same
26721     * time. When an item is added, any previous content will be removed.
26722     *
26723     * @see elm_ctxpopup_content_set()
26724     */
26725    Elm_Object_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);
26726    /**
26727     * @brief Delete the given item in a ctxpopup object.
26728     *
26729     * @param it Ctxpopup item to be deleted
26730     *
26731     * @see elm_ctxpopup_item_append()
26732     */
26733    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26734    /**
26735     * @brief Set the ctxpopup item's state as disabled or enabled.
26736     *
26737     * @param it Ctxpopup item to be enabled/disabled
26738     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26739     *
26740     * When disabled the item is greyed out to indicate it's state.
26741     */
26742    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26743    /**
26744     * @brief Get the ctxpopup item's disabled/enabled state.
26745     *
26746     * @param it Ctxpopup item to be enabled/disabled
26747     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26748     *
26749     * @see elm_ctxpopup_item_disabled_set()
26750     */
26751    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26752    /**
26753     * @brief Get the icon object for the given ctxpopup item.
26754     *
26755     * @param it Ctxpopup item
26756     * @return icon object or @c NULL, if the item does not have icon or an error
26757     * occurred
26758     *
26759     * @see elm_ctxpopup_item_append()
26760     * @see elm_ctxpopup_item_icon_set()
26761     */
26762    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26763    /**
26764     * @brief Sets the side icon associated with the ctxpopup item
26765     *
26766     * @param it Ctxpopup item
26767     * @param icon Icon object to be set
26768     *
26769     * Once the icon object is set, a previously set one will be deleted.
26770     * @warning Setting the same icon for two items will cause the icon to
26771     * dissapear from the first item.
26772     *
26773     * @see elm_ctxpopup_item_append()
26774     */
26775    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26776    /**
26777     * @brief Get the label for the given ctxpopup item.
26778     *
26779     * @param it Ctxpopup item
26780     * @return label string or @c NULL, if the item does not have label or an
26781     * error occured
26782     *
26783     * @see elm_ctxpopup_item_append()
26784     * @see elm_ctxpopup_item_label_set()
26785     */
26786    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26787    /**
26788     * @brief (Re)set the label on the given ctxpopup item.
26789     *
26790     * @param it Ctxpopup item
26791     * @param label String to set as label
26792     */
26793    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26794    /**
26795     * @brief Set an elm widget as the content of the ctxpopup.
26796     *
26797     * @param obj Ctxpopup object
26798     * @param content Content to be swallowed
26799     *
26800     * If the content object is already set, a previous one will bedeleted. If
26801     * you want to keep that old content object, use the
26802     * elm_ctxpopup_content_unset() function.
26803     *
26804     * @deprecated use elm_object_content_set()
26805     *
26806     * @warning Ctxpopup can't hold both a item list and a content at the same
26807     * time. When a content is set, any previous items will be removed.
26808     */
26809    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26810    /**
26811     * @brief Unset the ctxpopup content
26812     *
26813     * @param obj Ctxpopup object
26814     * @return The content that was being used
26815     *
26816     * Unparent and return the content object which was set for this widget.
26817     *
26818     * @deprecated use elm_object_content_unset()
26819     *
26820     * @see elm_ctxpopup_content_set()
26821     */
26822    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26823    /**
26824     * @brief Set the direction priority of a ctxpopup.
26825     *
26826     * @param obj Ctxpopup object
26827     * @param first 1st priority of direction
26828     * @param second 2nd priority of direction
26829     * @param third 3th priority of direction
26830     * @param fourth 4th priority of direction
26831     *
26832     * This functions gives a chance to user to set the priority of ctxpopup
26833     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26834     * requested direction.
26835     *
26836     * @see Elm_Ctxpopup_Direction
26837     */
26838    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);
26839    /**
26840     * @brief Get the direction priority of a ctxpopup.
26841     *
26842     * @param obj Ctxpopup object
26843     * @param first 1st priority of direction to be returned
26844     * @param second 2nd priority of direction to be returned
26845     * @param third 3th priority of direction to be returned
26846     * @param fourth 4th priority of direction to be returned
26847     *
26848     * @see elm_ctxpopup_direction_priority_set() for more information.
26849     */
26850    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);
26851
26852    /**
26853     * @brief Get the current direction of a ctxpopup.
26854     *
26855     * @param obj Ctxpopup object
26856     * @return current direction of a ctxpopup
26857     *
26858     * @warning Once the ctxpopup showed up, the direction would be determined
26859     */
26860    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26861
26862    /**
26863     * @}
26864     */
26865
26866    /* transit */
26867    /**
26868     *
26869     * @defgroup Transit Transit
26870     * @ingroup Elementary
26871     *
26872     * Transit is designed to apply various animated transition effects to @c
26873     * Evas_Object, such like translation, rotation, etc. For using these
26874     * effects, create an @ref Elm_Transit and add the desired transition effects.
26875     *
26876     * Once the effects are added into transit, they will be automatically
26877     * managed (their callback will be called until the duration is ended, and
26878     * they will be deleted on completion).
26879     *
26880     * Example:
26881     * @code
26882     * Elm_Transit *trans = elm_transit_add();
26883     * elm_transit_object_add(trans, obj);
26884     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26885     * elm_transit_duration_set(transit, 1);
26886     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26887     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26888     * elm_transit_repeat_times_set(transit, 3);
26889     * @endcode
26890     *
26891     * Some transition effects are used to change the properties of objects. They
26892     * are:
26893     * @li @ref elm_transit_effect_translation_add
26894     * @li @ref elm_transit_effect_color_add
26895     * @li @ref elm_transit_effect_rotation_add
26896     * @li @ref elm_transit_effect_wipe_add
26897     * @li @ref elm_transit_effect_zoom_add
26898     * @li @ref elm_transit_effect_resizing_add
26899     *
26900     * Other transition effects are used to make one object disappear and another
26901     * object appear on its old place. These effects are:
26902     *
26903     * @li @ref elm_transit_effect_flip_add
26904     * @li @ref elm_transit_effect_resizable_flip_add
26905     * @li @ref elm_transit_effect_fade_add
26906     * @li @ref elm_transit_effect_blend_add
26907     *
26908     * It's also possible to make a transition chain with @ref
26909     * elm_transit_chain_transit_add.
26910     *
26911     * @warning We strongly recommend to use elm_transit just when edje can not do
26912     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26913     * animations can be manipulated inside the theme.
26914     *
26915     * List of examples:
26916     * @li @ref transit_example_01_explained
26917     * @li @ref transit_example_02_explained
26918     * @li @ref transit_example_03_c
26919     * @li @ref transit_example_04_c
26920     *
26921     * @{
26922     */
26923
26924    /**
26925     * @enum Elm_Transit_Tween_Mode
26926     *
26927     * The type of acceleration used in the transition.
26928     */
26929    typedef enum
26930      {
26931         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26932         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26933                                              over time, then decrease again
26934                                              and stop slowly */
26935         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26936                                              speed over time */
26937         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26938                                             over time */
26939      } Elm_Transit_Tween_Mode;
26940
26941    /**
26942     * @enum Elm_Transit_Effect_Flip_Axis
26943     *
26944     * The axis where flip effect should be applied.
26945     */
26946    typedef enum
26947      {
26948         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26949         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26950      } Elm_Transit_Effect_Flip_Axis;
26951    /**
26952     * @enum Elm_Transit_Effect_Wipe_Dir
26953     *
26954     * The direction where the wipe effect should occur.
26955     */
26956    typedef enum
26957      {
26958         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26959         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26960         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26961         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26962      } Elm_Transit_Effect_Wipe_Dir;
26963    /** @enum Elm_Transit_Effect_Wipe_Type
26964     *
26965     * Whether the wipe effect should show or hide the object.
26966     */
26967    typedef enum
26968      {
26969         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26970                                              animation */
26971         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26972                                             animation */
26973      } Elm_Transit_Effect_Wipe_Type;
26974
26975    /**
26976     * @typedef Elm_Transit
26977     *
26978     * The Transit created with elm_transit_add(). This type has the information
26979     * about the objects which the transition will be applied, and the
26980     * transition effects that will be used. It also contains info about
26981     * duration, number of repetitions, auto-reverse, etc.
26982     */
26983    typedef struct _Elm_Transit Elm_Transit;
26984    typedef void Elm_Transit_Effect;
26985    /**
26986     * @typedef Elm_Transit_Effect_Transition_Cb
26987     *
26988     * Transition callback called for this effect on each transition iteration.
26989     */
26990    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26991    /**
26992     * Elm_Transit_Effect_End_Cb
26993     *
26994     * Transition callback called for this effect when the transition is over.
26995     */
26996    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26997
26998    /**
26999     * Elm_Transit_Del_Cb
27000     *
27001     * A callback called when the transit is deleted.
27002     */
27003    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27004
27005    /**
27006     * Add new transit.
27007     *
27008     * @note Is not necessary to delete the transit object, it will be deleted at
27009     * the end of its operation.
27010     * @note The transit will start playing when the program enter in the main loop, is not
27011     * necessary to give a start to the transit.
27012     *
27013     * @return The transit object.
27014     *
27015     * @ingroup Transit
27016     */
27017    EAPI Elm_Transit                *elm_transit_add(void);
27018
27019    /**
27020     * Stops the animation and delete the @p transit object.
27021     *
27022     * Call this function if you wants to stop the animation before the duration
27023     * time. Make sure the @p transit object is still alive with
27024     * elm_transit_del_cb_set() function.
27025     * All added effects will be deleted, calling its repective data_free_cb
27026     * functions. The function setted by elm_transit_del_cb_set() will be called.
27027     *
27028     * @see elm_transit_del_cb_set()
27029     *
27030     * @param transit The transit object to be deleted.
27031     *
27032     * @ingroup Transit
27033     * @warning Just call this function if you are sure the transit is alive.
27034     */
27035    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27036
27037    /**
27038     * Add a new effect to the transit.
27039     *
27040     * @note The cb function and the data are the key to the effect. If you try to
27041     * add an already added effect, nothing is done.
27042     * @note After the first addition of an effect in @p transit, if its
27043     * effect list become empty again, the @p transit will be killed by
27044     * elm_transit_del(transit) function.
27045     *
27046     * Exemple:
27047     * @code
27048     * Elm_Transit *transit = elm_transit_add();
27049     * elm_transit_effect_add(transit,
27050     *                        elm_transit_effect_blend_op,
27051     *                        elm_transit_effect_blend_context_new(),
27052     *                        elm_transit_effect_blend_context_free);
27053     * @endcode
27054     *
27055     * @param transit The transit object.
27056     * @param transition_cb The operation function. It is called when the
27057     * animation begins, it is the function that actually performs the animation.
27058     * It is called with the @p data, @p transit and the time progression of the
27059     * animation (a double value between 0.0 and 1.0).
27060     * @param effect The context data of the effect.
27061     * @param end_cb The function to free the context data, it will be called
27062     * at the end of the effect, it must finalize the animation and free the
27063     * @p data.
27064     *
27065     * @ingroup Transit
27066     * @warning The transit free the context data at the and of the transition with
27067     * the data_free_cb function, do not use the context data in another transit.
27068     */
27069    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);
27070
27071    /**
27072     * Delete an added effect.
27073     *
27074     * This function will remove the effect from the @p transit, calling the
27075     * data_free_cb to free the @p data.
27076     *
27077     * @see elm_transit_effect_add()
27078     *
27079     * @note If the effect is not found, nothing is done.
27080     * @note If the effect list become empty, this function will call
27081     * elm_transit_del(transit), that is, it will kill the @p transit.
27082     *
27083     * @param transit The transit object.
27084     * @param transition_cb The operation function.
27085     * @param effect The context data of the effect.
27086     *
27087     * @ingroup Transit
27088     */
27089    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);
27090
27091    /**
27092     * Add new object to apply the effects.
27093     *
27094     * @note After the first addition of an object in @p transit, if its
27095     * object list become empty again, the @p transit will be killed by
27096     * elm_transit_del(transit) function.
27097     * @note If the @p obj belongs to another transit, the @p obj will be
27098     * removed from it and it will only belong to the @p transit. If the old
27099     * transit stays without objects, it will die.
27100     * @note When you add an object into the @p transit, its state from
27101     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27102     * transit ends, if you change this state whith evas_object_pass_events_set()
27103     * after add the object, this state will change again when @p transit stops to
27104     * run.
27105     *
27106     * @param transit The transit object.
27107     * @param obj Object to be animated.
27108     *
27109     * @ingroup Transit
27110     * @warning It is not allowed to add a new object after transit begins to go.
27111     */
27112    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27113
27114    /**
27115     * Removes an added object from the transit.
27116     *
27117     * @note If the @p obj is not in the @p transit, nothing is done.
27118     * @note If the list become empty, this function will call
27119     * elm_transit_del(transit), that is, it will kill the @p transit.
27120     *
27121     * @param transit The transit object.
27122     * @param obj Object to be removed from @p transit.
27123     *
27124     * @ingroup Transit
27125     * @warning It is not allowed to remove objects after transit begins to go.
27126     */
27127    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27128
27129    /**
27130     * Get the objects of the transit.
27131     *
27132     * @param transit The transit object.
27133     * @return a Eina_List with the objects from the transit.
27134     *
27135     * @ingroup Transit
27136     */
27137    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27138
27139    /**
27140     * Enable/disable keeping up the objects states.
27141     * If it is not kept, the objects states will be reset when transition ends.
27142     *
27143     * @note @p transit can not be NULL.
27144     * @note One state includes geometry, color, map data.
27145     *
27146     * @param transit The transit object.
27147     * @param state_keep Keeping or Non Keeping.
27148     *
27149     * @ingroup Transit
27150     */
27151    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27152
27153    /**
27154     * Get a value whether the objects states will be reset or not.
27155     *
27156     * @note @p transit can not be NULL
27157     *
27158     * @see elm_transit_objects_final_state_keep_set()
27159     *
27160     * @param transit The transit object.
27161     * @return EINA_TRUE means the states of the objects will be reset.
27162     * If @p transit is NULL, EINA_FALSE is returned
27163     *
27164     * @ingroup Transit
27165     */
27166    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27167
27168    /**
27169     * Set the event enabled when transit is operating.
27170     *
27171     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27172     * events from mouse and keyboard during the animation.
27173     * @note When you add an object with elm_transit_object_add(), its state from
27174     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27175     * transit ends, if you change this state with evas_object_pass_events_set()
27176     * after adding the object, this state will change again when @p transit stops
27177     * to run.
27178     *
27179     * @param transit The transit object.
27180     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27181     * ignored otherwise.
27182     *
27183     * @ingroup Transit
27184     */
27185    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27186
27187    /**
27188     * Get the value of event enabled status.
27189     *
27190     * @see elm_transit_event_enabled_set()
27191     *
27192     * @param transit The Transit object
27193     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27194     * EINA_FALSE is returned
27195     *
27196     * @ingroup Transit
27197     */
27198    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27199
27200    /**
27201     * Set the user-callback function when the transit is deleted.
27202     *
27203     * @note Using this function twice will overwrite the first function setted.
27204     * @note the @p transit object will be deleted after call @p cb function.
27205     *
27206     * @param transit The transit object.
27207     * @param cb Callback function pointer. This function will be called before
27208     * the deletion of the transit.
27209     * @param data Callback funtion user data. It is the @p op parameter.
27210     *
27211     * @ingroup Transit
27212     */
27213    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27214
27215    /**
27216     * Set reverse effect automatically.
27217     *
27218     * If auto reverse is setted, after running the effects with the progress
27219     * parameter from 0 to 1, it will call the effecs again with the progress
27220     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27221     * where the duration was setted with the function elm_transit_add and
27222     * the repeat with the function elm_transit_repeat_times_set().
27223     *
27224     * @param transit The transit object.
27225     * @param reverse EINA_TRUE means the auto_reverse is on.
27226     *
27227     * @ingroup Transit
27228     */
27229    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27230
27231    /**
27232     * Get if the auto reverse is on.
27233     *
27234     * @see elm_transit_auto_reverse_set()
27235     *
27236     * @param transit The transit object.
27237     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27238     * EINA_FALSE is returned
27239     *
27240     * @ingroup Transit
27241     */
27242    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27243
27244    /**
27245     * Set the transit repeat count. Effect will be repeated by repeat count.
27246     *
27247     * This function sets the number of repetition the transit will run after
27248     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27249     * If the @p repeat is a negative number, it will repeat infinite times.
27250     *
27251     * @note If this function is called during the transit execution, the transit
27252     * will run @p repeat times, ignoring the times it already performed.
27253     *
27254     * @param transit The transit object
27255     * @param repeat Repeat count
27256     *
27257     * @ingroup Transit
27258     */
27259    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27260
27261    /**
27262     * Get the transit repeat count.
27263     *
27264     * @see elm_transit_repeat_times_set()
27265     *
27266     * @param transit The Transit object.
27267     * @return The repeat count. If @p transit is NULL
27268     * 0 is returned
27269     *
27270     * @ingroup Transit
27271     */
27272    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27273
27274    /**
27275     * Set the transit animation acceleration type.
27276     *
27277     * This function sets the tween mode of the transit that can be:
27278     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27279     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27280     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27281     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27282     *
27283     * @param transit The transit object.
27284     * @param tween_mode The tween type.
27285     *
27286     * @ingroup Transit
27287     */
27288    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27289
27290    /**
27291     * Get the transit animation acceleration type.
27292     *
27293     * @note @p transit can not be NULL
27294     *
27295     * @param transit The transit object.
27296     * @return The tween type. If @p transit is NULL
27297     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27298     *
27299     * @ingroup Transit
27300     */
27301    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27302
27303    /**
27304     * Set the transit animation time
27305     *
27306     * @note @p transit can not be NULL
27307     *
27308     * @param transit The transit object.
27309     * @param duration The animation time.
27310     *
27311     * @ingroup Transit
27312     */
27313    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27314
27315    /**
27316     * Get the transit animation time
27317     *
27318     * @note @p transit can not be NULL
27319     *
27320     * @param transit The transit object.
27321     *
27322     * @return The transit animation time.
27323     *
27324     * @ingroup Transit
27325     */
27326    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27327
27328    /**
27329     * Starts the transition.
27330     * Once this API is called, the transit begins to measure the time.
27331     *
27332     * @note @p transit can not be NULL
27333     *
27334     * @param transit The transit object.
27335     *
27336     * @ingroup Transit
27337     */
27338    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27339
27340    /**
27341     * Pause/Resume the transition.
27342     *
27343     * If you call elm_transit_go again, the transit will be started from the
27344     * beginning, and will be unpaused.
27345     *
27346     * @note @p transit can not be NULL
27347     *
27348     * @param transit The transit object.
27349     * @param paused Whether the transition should be paused or not.
27350     *
27351     * @ingroup Transit
27352     */
27353    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27354
27355    /**
27356     * Get the value of paused status.
27357     *
27358     * @see elm_transit_paused_set()
27359     *
27360     * @note @p transit can not be NULL
27361     *
27362     * @param transit The transit object.
27363     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27364     * EINA_FALSE is returned
27365     *
27366     * @ingroup Transit
27367     */
27368    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27369
27370    /**
27371     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27372     *
27373     * The value returned is a fraction (current time / total time). It
27374     * represents the progression position relative to the total.
27375     *
27376     * @note @p transit can not be NULL
27377     *
27378     * @param transit The transit object.
27379     *
27380     * @return The time progression value. If @p transit is NULL
27381     * 0 is returned
27382     *
27383     * @ingroup Transit
27384     */
27385    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27386
27387    /**
27388     * Makes the chain relationship between two transits.
27389     *
27390     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27391     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27392     *
27393     * @param transit The transit object.
27394     * @param chain_transit The chain transit object. This transit will be operated
27395     *        after transit is done.
27396     *
27397     * This function adds @p chain_transit transition to a chain after the @p
27398     * transit, and will be started as soon as @p transit ends. See @ref
27399     * transit_example_02_explained for a full example.
27400     *
27401     * @ingroup Transit
27402     */
27403    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27404
27405    /**
27406     * Cut off the chain relationship between two transits.
27407     *
27408     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27409     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27410     *
27411     * @param transit The transit object.
27412     * @param chain_transit The chain transit object.
27413     *
27414     * This function remove the @p chain_transit transition from the @p transit.
27415     *
27416     * @ingroup Transit
27417     */
27418    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27419
27420    /**
27421     * Get the current chain transit list.
27422     *
27423     * @note @p transit can not be NULL.
27424     *
27425     * @param transit The transit object.
27426     * @return chain transit list.
27427     *
27428     * @ingroup Transit
27429     */
27430    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27431
27432    /**
27433     * Add the Resizing Effect to Elm_Transit.
27434     *
27435     * @note This API is one of the facades. It creates resizing effect context
27436     * and add it's required APIs to elm_transit_effect_add.
27437     *
27438     * @see elm_transit_effect_add()
27439     *
27440     * @param transit Transit object.
27441     * @param from_w Object width size when effect begins.
27442     * @param from_h Object height size when effect begins.
27443     * @param to_w Object width size when effect ends.
27444     * @param to_h Object height size when effect ends.
27445     * @return Resizing effect context data.
27446     *
27447     * @ingroup Transit
27448     */
27449    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);
27450
27451    /**
27452     * Add the Translation Effect to Elm_Transit.
27453     *
27454     * @note This API is one of the facades. It creates translation effect context
27455     * and add it's required APIs to elm_transit_effect_add.
27456     *
27457     * @see elm_transit_effect_add()
27458     *
27459     * @param transit Transit object.
27460     * @param from_dx X Position variation when effect begins.
27461     * @param from_dy Y Position variation when effect begins.
27462     * @param to_dx X Position variation when effect ends.
27463     * @param to_dy Y Position variation when effect ends.
27464     * @return Translation effect context data.
27465     *
27466     * @ingroup Transit
27467     * @warning It is highly recommended just create a transit with this effect when
27468     * the window that the objects of the transit belongs has already been created.
27469     * This is because this effect needs the geometry information about the objects,
27470     * and if the window was not created yet, it can get a wrong information.
27471     */
27472    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);
27473
27474    /**
27475     * Add the Zoom Effect to Elm_Transit.
27476     *
27477     * @note This API is one of the facades. It creates zoom effect context
27478     * and add it's required APIs to elm_transit_effect_add.
27479     *
27480     * @see elm_transit_effect_add()
27481     *
27482     * @param transit Transit object.
27483     * @param from_rate Scale rate when effect begins (1 is current rate).
27484     * @param to_rate Scale rate when effect ends.
27485     * @return Zoom effect context data.
27486     *
27487     * @ingroup Transit
27488     * @warning It is highly recommended just create a transit with this effect when
27489     * the window that the objects of the transit belongs has already been created.
27490     * This is because this effect needs the geometry information about the objects,
27491     * and if the window was not created yet, it can get a wrong information.
27492     */
27493    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27494
27495    /**
27496     * Add the Flip Effect to Elm_Transit.
27497     *
27498     * @note This API is one of the facades. It creates flip effect context
27499     * and add it's required APIs to elm_transit_effect_add.
27500     * @note This effect is applied to each pair of objects in the order they are listed
27501     * in the transit list of objects. The first object in the pair will be the
27502     * "front" object and the second will be the "back" object.
27503     *
27504     * @see elm_transit_effect_add()
27505     *
27506     * @param transit Transit object.
27507     * @param axis Flipping Axis(X or Y).
27508     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27509     * @return Flip effect context data.
27510     *
27511     * @ingroup Transit
27512     * @warning It is highly recommended just create a transit with this effect when
27513     * the window that the objects of the transit belongs has already been created.
27514     * This is because this effect needs the geometry information about the objects,
27515     * and if the window was not created yet, it can get a wrong information.
27516     */
27517    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27518
27519    /**
27520     * Add the Resizable Flip Effect to Elm_Transit.
27521     *
27522     * @note This API is one of the facades. It creates resizable flip effect context
27523     * and add it's required APIs to elm_transit_effect_add.
27524     * @note This effect is applied to each pair of objects in the order they are listed
27525     * in the transit list of objects. The first object in the pair will be the
27526     * "front" object and the second will be the "back" object.
27527     *
27528     * @see elm_transit_effect_add()
27529     *
27530     * @param transit Transit object.
27531     * @param axis Flipping Axis(X or Y).
27532     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27533     * @return Resizable flip effect context data.
27534     *
27535     * @ingroup Transit
27536     * @warning It is highly recommended just create a transit with this effect when
27537     * the window that the objects of the transit belongs has already been created.
27538     * This is because this effect needs the geometry information about the objects,
27539     * and if the window was not created yet, it can get a wrong information.
27540     */
27541    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27542
27543    /**
27544     * Add the Wipe Effect to Elm_Transit.
27545     *
27546     * @note This API is one of the facades. It creates wipe effect context
27547     * and add it's required APIs to elm_transit_effect_add.
27548     *
27549     * @see elm_transit_effect_add()
27550     *
27551     * @param transit Transit object.
27552     * @param type Wipe type. Hide or show.
27553     * @param dir Wipe Direction.
27554     * @return Wipe effect context data.
27555     *
27556     * @ingroup Transit
27557     * @warning It is highly recommended just create a transit with this effect when
27558     * the window that the objects of the transit belongs has already been created.
27559     * This is because this effect needs the geometry information about the objects,
27560     * and if the window was not created yet, it can get a wrong information.
27561     */
27562    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27563
27564    /**
27565     * Add the Color Effect to Elm_Transit.
27566     *
27567     * @note This API is one of the facades. It creates color effect context
27568     * and add it's required APIs to elm_transit_effect_add.
27569     *
27570     * @see elm_transit_effect_add()
27571     *
27572     * @param transit        Transit object.
27573     * @param  from_r        RGB R when effect begins.
27574     * @param  from_g        RGB G when effect begins.
27575     * @param  from_b        RGB B when effect begins.
27576     * @param  from_a        RGB A when effect begins.
27577     * @param  to_r          RGB R when effect ends.
27578     * @param  to_g          RGB G when effect ends.
27579     * @param  to_b          RGB B when effect ends.
27580     * @param  to_a          RGB A when effect ends.
27581     * @return               Color effect context data.
27582     *
27583     * @ingroup Transit
27584     */
27585    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);
27586
27587    /**
27588     * Add the Fade Effect to Elm_Transit.
27589     *
27590     * @note This API is one of the facades. It creates fade effect context
27591     * and add it's required APIs to elm_transit_effect_add.
27592     * @note This effect is applied to each pair of objects in the order they are listed
27593     * in the transit list of objects. The first object in the pair will be the
27594     * "before" object and the second will be the "after" object.
27595     *
27596     * @see elm_transit_effect_add()
27597     *
27598     * @param transit Transit object.
27599     * @return Fade effect context data.
27600     *
27601     * @ingroup Transit
27602     * @warning It is highly recommended just create a transit with this effect when
27603     * the window that the objects of the transit belongs has already been created.
27604     * This is because this effect needs the color information about the objects,
27605     * and if the window was not created yet, it can get a wrong information.
27606     */
27607    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27608
27609    /**
27610     * Add the Blend Effect to Elm_Transit.
27611     *
27612     * @note This API is one of the facades. It creates blend effect context
27613     * and add it's required APIs to elm_transit_effect_add.
27614     * @note This effect is applied to each pair of objects in the order they are listed
27615     * in the transit list of objects. The first object in the pair will be the
27616     * "before" object and the second will be the "after" object.
27617     *
27618     * @see elm_transit_effect_add()
27619     *
27620     * @param transit Transit object.
27621     * @return Blend effect context data.
27622     *
27623     * @ingroup Transit
27624     * @warning It is highly recommended just create a transit with this effect when
27625     * the window that the objects of the transit belongs has already been created.
27626     * This is because this effect needs the color information about the objects,
27627     * and if the window was not created yet, it can get a wrong information.
27628     */
27629    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27630
27631    /**
27632     * Add the Rotation Effect to Elm_Transit.
27633     *
27634     * @note This API is one of the facades. It creates rotation effect context
27635     * and add it's required APIs to elm_transit_effect_add.
27636     *
27637     * @see elm_transit_effect_add()
27638     *
27639     * @param transit Transit object.
27640     * @param from_degree Degree when effect begins.
27641     * @param to_degree Degree when effect is ends.
27642     * @return Rotation effect context data.
27643     *
27644     * @ingroup Transit
27645     * @warning It is highly recommended just create a transit with this effect when
27646     * the window that the objects of the transit belongs has already been created.
27647     * This is because this effect needs the geometry information about the objects,
27648     * and if the window was not created yet, it can get a wrong information.
27649     */
27650    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27651
27652    /**
27653     * Add the ImageAnimation Effect to Elm_Transit.
27654     *
27655     * @note This API is one of the facades. It creates image animation effect context
27656     * and add it's required APIs to elm_transit_effect_add.
27657     * The @p images parameter is a list images paths. This list and
27658     * its contents will be deleted at the end of the effect by
27659     * elm_transit_effect_image_animation_context_free() function.
27660     *
27661     * Example:
27662     * @code
27663     * char buf[PATH_MAX];
27664     * Eina_List *images = NULL;
27665     * Elm_Transit *transi = elm_transit_add();
27666     *
27667     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27668     * images = eina_list_append(images, eina_stringshare_add(buf));
27669     *
27670     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27671     * images = eina_list_append(images, eina_stringshare_add(buf));
27672     * elm_transit_effect_image_animation_add(transi, images);
27673     *
27674     * @endcode
27675     *
27676     * @see elm_transit_effect_add()
27677     *
27678     * @param transit Transit object.
27679     * @param images Eina_List of images file paths. This list and
27680     * its contents will be deleted at the end of the effect by
27681     * elm_transit_effect_image_animation_context_free() function.
27682     * @return Image Animation effect context data.
27683     *
27684     * @ingroup Transit
27685     */
27686    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27687    /**
27688     * @}
27689     */
27690
27691    /* Store */
27692    typedef struct _Elm_Store                      Elm_Store;
27693    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
27694    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27695    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27696    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
27697    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27698    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27699    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27700    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27701    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27702    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27703    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27704    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27705
27706    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27707    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27708    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27709    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27710    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27711    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27712    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27713
27714    typedef enum
27715      {
27716         ELM_STORE_ITEM_MAPPING_NONE = 0,
27717         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27718         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27719         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27720         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27721         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27722         // can add more here as needed by common apps
27723         ELM_STORE_ITEM_MAPPING_LAST
27724      } Elm_Store_Item_Mapping_Type;
27725
27726    struct _Elm_Store_Item_Mapping_Icon
27727      {
27728         // FIXME: allow edje file icons
27729         int                   w, h;
27730         Elm_Icon_Lookup_Order lookup_order;
27731         Eina_Bool             standard_name : 1;
27732         Eina_Bool             no_scale : 1;
27733         Eina_Bool             smooth : 1;
27734         Eina_Bool             scale_up : 1;
27735         Eina_Bool             scale_down : 1;
27736      };
27737
27738    struct _Elm_Store_Item_Mapping_Empty
27739      {
27740         Eina_Bool             dummy;
27741      };
27742
27743    struct _Elm_Store_Item_Mapping_Photo
27744      {
27745         int                   size;
27746      };
27747
27748    struct _Elm_Store_Item_Mapping_Custom
27749      {
27750         Elm_Store_Item_Mapping_Cb func;
27751      };
27752
27753    struct _Elm_Store_Item_Mapping
27754      {
27755         Elm_Store_Item_Mapping_Type     type;
27756         const char                     *part;
27757         int                             offset;
27758         union
27759           {
27760              Elm_Store_Item_Mapping_Empty  empty;
27761              Elm_Store_Item_Mapping_Icon   icon;
27762              Elm_Store_Item_Mapping_Photo  photo;
27763              Elm_Store_Item_Mapping_Custom custom;
27764              // add more types here
27765           } details;
27766      };
27767
27768    struct _Elm_Store_Item_Info
27769      {
27770         int                           index;
27771         int                           item_type;
27772         int                           group_index;
27773         Eina_Bool                     rec_item;
27774         int                           pre_group_index;
27775
27776         Elm_Genlist_Item_Class       *item_class;
27777         const Elm_Store_Item_Mapping *mapping;
27778         void                         *data;
27779         char                         *sort_id;
27780      };
27781
27782    struct _Elm_Store_Item_Info_Filesystem
27783      {
27784         Elm_Store_Item_Info  base;
27785         char                *path;
27786      };
27787
27788 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27789 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27790
27791    EAPI Elm_Store              *elm_store_dbsystem_new(void);
27792    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27793    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27794    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27795    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27796    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27797    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27798    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27799    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27800    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27801    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27802    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27803    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27804    EAPI void                    elm_store_free(Elm_Store *st);
27805    EAPI Elm_Store              *elm_store_filesystem_new(void);
27806    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27807    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27808    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27809
27810    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27811
27812    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27813    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27814    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27815    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27816    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27817    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27818
27819    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27820    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27821    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27822    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27823    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27824    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27825    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27826
27827    /**
27828     * @defgroup SegmentControl SegmentControl
27829     * @ingroup Elementary
27830     *
27831     * @image html img/widget/segment_control/preview-00.png
27832     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27833     *
27834     * @image html img/segment_control.png
27835     * @image latex img/segment_control.eps width=\textwidth
27836     *
27837     * Segment control widget is a horizontal control made of multiple segment
27838     * items, each segment item functioning similar to discrete two state button.
27839     * A segment control groups the items together and provides compact
27840     * single button with multiple equal size segments.
27841     *
27842     * Segment item size is determined by base widget
27843     * size and the number of items added.
27844     * Only one segment item can be at selected state. A segment item can display
27845     * combination of Text and any Evas_Object like Images or other widget.
27846     *
27847     * Smart callbacks one can listen to:
27848     * - "changed" - When the user clicks on a segment item which is not
27849     *   previously selected and get selected. The event_info parameter is the
27850     *   segment item pointer.
27851     *
27852     * Available styles for it:
27853     * - @c "default"
27854     *
27855     * Here is an example on its usage:
27856     * @li @ref segment_control_example
27857     */
27858
27859    /**
27860     * @addtogroup SegmentControl
27861     * @{
27862     */
27863
27864    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27865
27866    /**
27867     * Add a new segment control widget to the given parent Elementary
27868     * (container) object.
27869     *
27870     * @param parent The parent object.
27871     * @return a new segment control widget handle or @c NULL, on errors.
27872     *
27873     * This function inserts a new segment control widget on the canvas.
27874     *
27875     * @ingroup SegmentControl
27876     */
27877    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27878
27879    /**
27880     * Append a new item to the segment control object.
27881     *
27882     * @param obj The segment control object.
27883     * @param icon The icon object to use for the left side of the item. An
27884     * icon can be any Evas object, but usually it is an icon created
27885     * with elm_icon_add().
27886     * @param label The label of the item.
27887     *        Note that, NULL is different from empty string "".
27888     * @return The created item or @c NULL upon failure.
27889     *
27890     * A new item will be created and appended to the segment control, i.e., will
27891     * be set as @b last item.
27892     *
27893     * If it should be inserted at another position,
27894     * elm_segment_control_item_insert_at() should be used instead.
27895     *
27896     * Items created with this function can be deleted with function
27897     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27898     *
27899     * @note @p label set to @c NULL is different from empty string "".
27900     * If an item
27901     * only has icon, it will be displayed bigger and centered. If it has
27902     * icon and label, even that an empty string, icon will be smaller and
27903     * positioned at left.
27904     *
27905     * Simple example:
27906     * @code
27907     * sc = elm_segment_control_add(win);
27908     * ic = elm_icon_add(win);
27909     * elm_icon_file_set(ic, "path/to/image", NULL);
27910     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27911     * elm_segment_control_item_add(sc, ic, "label");
27912     * evas_object_show(sc);
27913     * @endcode
27914     *
27915     * @see elm_segment_control_item_insert_at()
27916     * @see elm_segment_control_item_del()
27917     *
27918     * @ingroup SegmentControl
27919     */
27920    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27921
27922    /**
27923     * Insert a new item to the segment control object at specified position.
27924     *
27925     * @param obj The segment control object.
27926     * @param icon The icon object to use for the left side of the item. An
27927     * icon can be any Evas object, but usually it is an icon created
27928     * with elm_icon_add().
27929     * @param label The label of the item.
27930     * @param index Item position. Value should be between 0 and items count.
27931     * @return The created item or @c NULL upon failure.
27932
27933     * Index values must be between @c 0, when item will be prepended to
27934     * segment control, and items count, that can be get with
27935     * elm_segment_control_item_count_get(), case when item will be appended
27936     * to segment control, just like elm_segment_control_item_add().
27937     *
27938     * Items created with this function can be deleted with function
27939     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27940     *
27941     * @note @p label set to @c NULL is different from empty string "".
27942     * If an item
27943     * only has icon, it will be displayed bigger and centered. If it has
27944     * icon and label, even that an empty string, icon will be smaller and
27945     * positioned at left.
27946     *
27947     * @see elm_segment_control_item_add()
27948     * @see elm_segment_control_item_count_get()
27949     * @see elm_segment_control_item_del()
27950     *
27951     * @ingroup SegmentControl
27952     */
27953    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);
27954
27955    /**
27956     * Remove a segment control item from its parent, deleting it.
27957     *
27958     * @param it The item to be removed.
27959     *
27960     * Items can be added with elm_segment_control_item_add() or
27961     * elm_segment_control_item_insert_at().
27962     *
27963     * @ingroup SegmentControl
27964     */
27965    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27966
27967    /**
27968     * Remove a segment control item at given index from its parent,
27969     * deleting it.
27970     *
27971     * @param obj The segment control object.
27972     * @param index The position of the segment control item to be deleted.
27973     *
27974     * Items can be added with elm_segment_control_item_add() or
27975     * elm_segment_control_item_insert_at().
27976     *
27977     * @ingroup SegmentControl
27978     */
27979    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27980
27981    /**
27982     * Get the Segment items count from segment control.
27983     *
27984     * @param obj The segment control object.
27985     * @return Segment items count.
27986     *
27987     * It will just return the number of items added to segment control @p obj.
27988     *
27989     * @ingroup SegmentControl
27990     */
27991    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27992
27993    /**
27994     * Get the item placed at specified index.
27995     *
27996     * @param obj The segment control object.
27997     * @param index The index of the segment item.
27998     * @return The segment control item or @c NULL on failure.
27999     *
28000     * Index is the position of an item in segment control widget. Its
28001     * range is from @c 0 to <tt> count - 1 </tt>.
28002     * Count is the number of items, that can be get with
28003     * elm_segment_control_item_count_get().
28004     *
28005     * @ingroup SegmentControl
28006     */
28007    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28008
28009    /**
28010     * Get the label of item.
28011     *
28012     * @param obj The segment control object.
28013     * @param index The index of the segment item.
28014     * @return The label of the item at @p index.
28015     *
28016     * The return value is a pointer to the label associated to the item when
28017     * it was created, with function elm_segment_control_item_add(), or later
28018     * with function elm_segment_control_item_label_set. If no label
28019     * was passed as argument, it will return @c NULL.
28020     *
28021     * @see elm_segment_control_item_label_set() for more details.
28022     * @see elm_segment_control_item_add()
28023     *
28024     * @ingroup SegmentControl
28025     */
28026    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28027
28028    /**
28029     * Set the label of item.
28030     *
28031     * @param it The item of segment control.
28032     * @param text The label of item.
28033     *
28034     * The label to be displayed by the item.
28035     * Label will be at right of the icon (if set).
28036     *
28037     * If a label was passed as argument on item creation, with function
28038     * elm_control_segment_item_add(), it will be already
28039     * displayed by the item.
28040     *
28041     * @see elm_segment_control_item_label_get()
28042     * @see elm_segment_control_item_add()
28043     *
28044     * @ingroup SegmentControl
28045     */
28046    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28047
28048    /**
28049     * Get the icon associated to the item.
28050     *
28051     * @param obj The segment control object.
28052     * @param index The index of the segment item.
28053     * @return The left side icon associated to the item at @p index.
28054     *
28055     * The return value is a pointer to the icon associated to the item when
28056     * it was created, with function elm_segment_control_item_add(), or later
28057     * with function elm_segment_control_item_icon_set(). If no icon
28058     * was passed as argument, it will return @c NULL.
28059     *
28060     * @see elm_segment_control_item_add()
28061     * @see elm_segment_control_item_icon_set()
28062     *
28063     * @ingroup SegmentControl
28064     */
28065    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28066
28067    /**
28068     * Set the icon associated to the item.
28069     *
28070     * @param it The segment control item.
28071     * @param icon The icon object to associate with @p it.
28072     *
28073     * The icon object to use at left side of the item. An
28074     * icon can be any Evas object, but usually it is an icon created
28075     * with elm_icon_add().
28076     *
28077     * Once the icon object is set, a previously set one will be deleted.
28078     * @warning Setting the same icon for two items will cause the icon to
28079     * dissapear from the first item.
28080     *
28081     * If an icon was passed as argument on item creation, with function
28082     * elm_segment_control_item_add(), it will be already
28083     * associated to the item.
28084     *
28085     * @see elm_segment_control_item_add()
28086     * @see elm_segment_control_item_icon_get()
28087     *
28088     * @ingroup SegmentControl
28089     */
28090    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28091
28092    /**
28093     * Get the index of an item.
28094     *
28095     * @param it The segment control item.
28096     * @return The position of item in segment control widget.
28097     *
28098     * Index is the position of an item in segment control widget. Its
28099     * range is from @c 0 to <tt> count - 1 </tt>.
28100     * Count is the number of items, that can be get with
28101     * elm_segment_control_item_count_get().
28102     *
28103     * @ingroup SegmentControl
28104     */
28105    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28106
28107    /**
28108     * Get the base object of the item.
28109     *
28110     * @param it The segment control item.
28111     * @return The base object associated with @p it.
28112     *
28113     * Base object is the @c Evas_Object that represents that item.
28114     *
28115     * @ingroup SegmentControl
28116     */
28117    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28118
28119    /**
28120     * Get the selected item.
28121     *
28122     * @param obj The segment control object.
28123     * @return The selected item or @c NULL if none of segment items is
28124     * selected.
28125     *
28126     * The selected item can be unselected with function
28127     * elm_segment_control_item_selected_set().
28128     *
28129     * The selected item always will be highlighted on segment control.
28130     *
28131     * @ingroup SegmentControl
28132     */
28133    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28134
28135    /**
28136     * Set the selected state of an item.
28137     *
28138     * @param it The segment control item
28139     * @param select The selected state
28140     *
28141     * This sets the selected state of the given item @p it.
28142     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28143     *
28144     * If a new item is selected the previosly selected will be unselected.
28145     * Previoulsy selected item can be get with function
28146     * elm_segment_control_item_selected_get().
28147     *
28148     * The selected item always will be highlighted on segment control.
28149     *
28150     * @see elm_segment_control_item_selected_get()
28151     *
28152     * @ingroup SegmentControl
28153     */
28154    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28155
28156    /**
28157     * @}
28158     */
28159
28160    /**
28161     * @defgroup Grid Grid
28162     *
28163     * The grid is a grid layout widget that lays out a series of children as a
28164     * fixed "grid" of widgets using a given percentage of the grid width and
28165     * height each using the child object.
28166     *
28167     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28168     * widgets size itself. The default is 100 x 100, so that means the
28169     * position and sizes of children will effectively be percentages (0 to 100)
28170     * of the width or height of the grid widget
28171     *
28172     * @{
28173     */
28174
28175    /**
28176     * Add a new grid to the parent
28177     *
28178     * @param parent The parent object
28179     * @return The new object or NULL if it cannot be created
28180     *
28181     * @ingroup Grid
28182     */
28183    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28184
28185    /**
28186     * Set the virtual size of the grid
28187     *
28188     * @param obj The grid object
28189     * @param w The virtual width of the grid
28190     * @param h The virtual height of the grid
28191     *
28192     * @ingroup Grid
28193     */
28194    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28195
28196    /**
28197     * Get the virtual size of the grid
28198     *
28199     * @param obj The grid object
28200     * @param w Pointer to integer to store the virtual width of the grid
28201     * @param h Pointer to integer to store the virtual height of the grid
28202     *
28203     * @ingroup Grid
28204     */
28205    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28206
28207    /**
28208     * Pack child at given position and size
28209     *
28210     * @param obj The grid object
28211     * @param subobj The child to pack
28212     * @param x The virtual x coord at which to pack it
28213     * @param y The virtual y coord at which to pack it
28214     * @param w The virtual width at which to pack it
28215     * @param h The virtual height at which to pack it
28216     *
28217     * @ingroup Grid
28218     */
28219    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28220
28221    /**
28222     * Unpack a child from a grid object
28223     *
28224     * @param obj The grid object
28225     * @param subobj The child to unpack
28226     *
28227     * @ingroup Grid
28228     */
28229    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28230
28231    /**
28232     * Faster way to remove all child objects from a grid object.
28233     *
28234     * @param obj The grid object
28235     * @param clear If true, it will delete just removed children
28236     *
28237     * @ingroup Grid
28238     */
28239    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28240
28241    /**
28242     * Set packing of an existing child at to position and size
28243     *
28244     * @param subobj The child to set packing of
28245     * @param x The virtual x coord at which to pack it
28246     * @param y The virtual y coord at which to pack it
28247     * @param w The virtual width at which to pack it
28248     * @param h The virtual height at which to pack it
28249     *
28250     * @ingroup Grid
28251     */
28252    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28253
28254    /**
28255     * get packing of a child
28256     *
28257     * @param subobj The child to query
28258     * @param x Pointer to integer to store the virtual x coord
28259     * @param y Pointer to integer to store the virtual y coord
28260     * @param w Pointer to integer to store the virtual width
28261     * @param h Pointer to integer to store the virtual height
28262     *
28263     * @ingroup Grid
28264     */
28265    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28266
28267    /**
28268     * @}
28269     */
28270
28271    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28272    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28273    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28274    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28275    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28276    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28277
28278    /**
28279     * @defgroup Video Video
28280     *
28281     * @addtogroup Video
28282     * @{
28283     *
28284     * Elementary comes with two object that help design application that need
28285     * to display video. The main one, Elm_Video, display a video by using Emotion.
28286     * It does embedded the video inside an Edje object, so you can do some
28287     * animation depending on the video state change. It does also implement a
28288     * ressource management policy to remove this burden from the application writer.
28289     *
28290     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28291     * It take care of updating its content according to Emotion event and provide a
28292     * way to theme itself. It also does automatically raise the priority of the
28293     * linked Elm_Video so it will use the video decoder if available. It also does
28294     * activate the remember function on the linked Elm_Video object.
28295     *
28296     * Signals that you can add callback for are :
28297     *
28298     * "forward,clicked" - the user clicked the forward button.
28299     * "info,clicked" - the user clicked the info button.
28300     * "next,clicked" - the user clicked the next button.
28301     * "pause,clicked" - the user clicked the pause button.
28302     * "play,clicked" - the user clicked the play button.
28303     * "prev,clicked" - the user clicked the prev button.
28304     * "rewind,clicked" - the user clicked the rewind button.
28305     * "stop,clicked" - the user clicked the stop button.
28306     * 
28307     * To set the video of the player, you can use elm_object_content_set() API.
28308     * 
28309     */
28310
28311    /**
28312     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28313     *
28314     * @param parent The parent object
28315     * @return a new player widget handle or @c NULL, on errors.
28316     *
28317     * This function inserts a new player widget on the canvas.
28318     *
28319     * @see elm_object_content_set()
28320     *
28321     * @ingroup Video
28322     */
28323    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28324
28325    /**
28326     * @brief Link a Elm_Payer with an Elm_Video object.
28327     *
28328     * @param player the Elm_Player object.
28329     * @param video The Elm_Video object.
28330     *
28331     * This mean that action on the player widget will affect the
28332     * video object and the state of the video will be reflected in
28333     * the player itself.
28334     *
28335     * @see elm_player_add()
28336     * @see elm_video_add()
28337     *
28338     * @ingroup Video
28339     */
28340    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28341
28342    /**
28343     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28344     *
28345     * @param parent The parent object
28346     * @return a new video widget handle or @c NULL, on errors.
28347     *
28348     * This function inserts a new video widget on the canvas.
28349     *
28350     * @seeelm_video_file_set()
28351     * @see elm_video_uri_set()
28352     *
28353     * @ingroup Video
28354     */
28355    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28356
28357    /**
28358     * @brief Define the file that will be the video source.
28359     *
28360     * @param video The video object to define the file for.
28361     * @param filename The file to target.
28362     *
28363     * This function will explicitly define a filename as a source
28364     * for the video of the Elm_Video object.
28365     *
28366     * @see elm_video_uri_set()
28367     * @see elm_video_add()
28368     * @see elm_player_add()
28369     *
28370     * @ingroup Video
28371     */
28372    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28373
28374    /**
28375     * @brief Define the uri that will be the video source.
28376     *
28377     * @param video The video object to define the file for.
28378     * @param uri The uri to target.
28379     *
28380     * This function will define an uri as a source for the video of the
28381     * Elm_Video object. URI could be remote source of video, like http:// or local source
28382     * like for example WebCam who are most of the time v4l2:// (but that depend and
28383     * you should use Emotion API to request and list the available Webcam on your system).
28384     *
28385     * @see elm_video_file_set()
28386     * @see elm_video_add()
28387     * @see elm_player_add()
28388     *
28389     * @ingroup Video
28390     */
28391    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28392
28393    /**
28394     * @brief Get the underlying Emotion object.
28395     *
28396     * @param video The video object to proceed the request on.
28397     * @return the underlying Emotion object.
28398     *
28399     * @ingroup Video
28400     */
28401    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28402
28403    /**
28404     * @brief Start to play the video
28405     *
28406     * @param video The video object to proceed the request on.
28407     *
28408     * Start to play the video and cancel all suspend state.
28409     *
28410     * @ingroup Video
28411     */
28412    EAPI void elm_video_play(Evas_Object *video);
28413
28414    /**
28415     * @brief Pause the video
28416     *
28417     * @param video The video object to proceed the request on.
28418     *
28419     * Pause the video and start a timer to trigger suspend mode.
28420     *
28421     * @ingroup Video
28422     */
28423    EAPI void elm_video_pause(Evas_Object *video);
28424
28425    /**
28426     * @brief Stop the video
28427     *
28428     * @param video The video object to proceed the request on.
28429     *
28430     * Stop the video and put the emotion in deep sleep mode.
28431     *
28432     * @ingroup Video
28433     */
28434    EAPI void elm_video_stop(Evas_Object *video);
28435
28436    /**
28437     * @brief Is the video actually playing.
28438     *
28439     * @param video The video object to proceed the request on.
28440     * @return EINA_TRUE if the video is actually playing.
28441     *
28442     * You should consider watching event on the object instead of polling
28443     * the object state.
28444     *
28445     * @ingroup Video
28446     */
28447    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28448
28449    /**
28450     * @brief Is it possible to seek inside the video.
28451     *
28452     * @param video The video object to proceed the request on.
28453     * @return EINA_TRUE if is possible to seek inside the video.
28454     *
28455     * @ingroup Video
28456     */
28457    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28458
28459    /**
28460     * @brief Is the audio muted.
28461     *
28462     * @param video The video object to proceed the request on.
28463     * @return EINA_TRUE if the audio is muted.
28464     *
28465     * @ingroup Video
28466     */
28467    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28468
28469    /**
28470     * @brief Change the mute state of the Elm_Video object.
28471     *
28472     * @param video The video object to proceed the request on.
28473     * @param mute The new mute state.
28474     *
28475     * @ingroup Video
28476     */
28477    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28478
28479    /**
28480     * @brief Get the audio level of the current video.
28481     *
28482     * @param video The video object to proceed the request on.
28483     * @return the current audio level.
28484     *
28485     * @ingroup Video
28486     */
28487    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28488
28489    /**
28490     * @brief Set the audio level of anElm_Video object.
28491     *
28492     * @param video The video object to proceed the request on.
28493     * @param volume The new audio volume.
28494     *
28495     * @ingroup Video
28496     */
28497    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28498
28499    EAPI double elm_video_play_position_get(const Evas_Object *video);
28500    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28501    EAPI double elm_video_play_length_get(const Evas_Object *video);
28502    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28503    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28504    EAPI const char *elm_video_title_get(const Evas_Object *video);
28505    /**
28506     * @}
28507     */
28508
28509    // FIXME: incomplete - carousel. don't use this until this comment is removed
28510    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28511    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
28512    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28513    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
28514    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
28515    /* smart callbacks called:
28516     * "clicked" - when the user clicks on a carousel item and becomes selected
28517     */
28518
28519    /* datefield */
28520
28521    typedef enum _Elm_Datefield_ItemType
28522      {
28523         ELM_DATEFIELD_YEAR = 0,
28524         ELM_DATEFIELD_MONTH,
28525         ELM_DATEFIELD_DATE,
28526         ELM_DATEFIELD_HOUR,
28527         ELM_DATEFIELD_MINUTE,
28528         ELM_DATEFIELD_AMPM
28529      } Elm_Datefield_ItemType;
28530
28531    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28532    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28533    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
28534    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28535    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28536    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28537    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28538    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28539    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28540    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28541    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28542    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28543    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28544  
28545    /* smart callbacks called:
28546    * "changed" - when datefield value is changed, this signal is sent.
28547    */
28548
28549 ////////////////////// DEPRECATED ///////////////////////////////////
28550
28551    typedef enum _Elm_Datefield_Layout
28552      {
28553         ELM_DATEFIELD_LAYOUT_TIME,
28554         ELM_DATEFIELD_LAYOUT_DATE,
28555         ELM_DATEFIELD_LAYOUT_DATEANDTIME
28556      } Elm_Datefield_Layout;
28557
28558    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28559    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28560    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28561    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
28562    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28563    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
28564    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28565    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28566    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28567    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28568    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28569    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28570    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);
28571    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28572 /////////////////////////////////////////////////////////////////////
28573
28574    /* popup */
28575    typedef enum _Elm_Popup_Response
28576      {
28577         ELM_POPUP_RESPONSE_NONE = -1,
28578         ELM_POPUP_RESPONSE_TIMEOUT = -2,
28579         ELM_POPUP_RESPONSE_OK = -3,
28580         ELM_POPUP_RESPONSE_CANCEL = -4,
28581         ELM_POPUP_RESPONSE_CLOSE = -5
28582      } Elm_Popup_Response;
28583
28584    typedef enum _Elm_Popup_Mode
28585      {
28586         ELM_POPUP_TYPE_NONE = 0,
28587         ELM_POPUP_TYPE_ALERT = (1 << 0)
28588      } Elm_Popup_Mode;
28589
28590    typedef enum _Elm_Popup_Orient
28591      {
28592         ELM_POPUP_ORIENT_TOP,
28593         ELM_POPUP_ORIENT_CENTER,
28594         ELM_POPUP_ORIENT_BOTTOM,
28595         ELM_POPUP_ORIENT_LEFT,
28596         ELM_POPUP_ORIENT_RIGHT,
28597         ELM_POPUP_ORIENT_TOP_LEFT,
28598         ELM_POPUP_ORIENT_TOP_RIGHT,
28599         ELM_POPUP_ORIENT_BOTTOM_LEFT,
28600         ELM_POPUP_ORIENT_BOTTOM_RIGHT
28601      } Elm_Popup_Orient;
28602
28603    /* smart callbacks called:
28604     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28605     */
28606
28607    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28608    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
28609    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
28610    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
28611    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
28612    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28613    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28614    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28615    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28616    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
28617    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, ... );
28618    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
28619    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28620    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
28621    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28622    EAPI int          elm_popup_run(Evas_Object *obj);
28623
28624    /* NavigationBar */
28625    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28626    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28627
28628    typedef enum
28629      {
28630         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28631         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28632         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28633         ELM_NAVIGATIONBAR_BACK_BUTTON
28634      } Elm_Navi_Button_Type;
28635
28636    EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28637    EINA_DEPRECATED    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);
28638    EINA_DEPRECATED    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
28639    EINA_DEPRECATED    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28640    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28641    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28642    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28643    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28644    EINA_DEPRECATED    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28645    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28646    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28647    EINA_DEPRECATED    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28648    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28649    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28650    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28651    EINA_DEPRECATED    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28652    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28653    EINA_DEPRECATED    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28654    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28655    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28656    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28657    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28658
28659    /* NavigationBar */
28660    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28661    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28662
28663    typedef enum
28664      {
28665         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28666         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28667         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28668         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28669         ELM_NAVIGATIONBAR_EX_MAX
28670      } Elm_Navi_ex_Button_Type;
28671    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28672
28673    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28674    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28675    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
28676    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28677    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28678    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28679    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28680    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28681    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28682    EINA_DEPRECATED    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);
28683    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28684    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28685    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28686    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28687    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28688    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28689    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28690    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28691    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28692    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28693    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28694    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28695    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28696    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28697    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28698    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28699    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28700    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28701
28702    /**
28703     * @defgroup Naviframe Naviframe
28704     * @ingroup Elementary
28705     *
28706     * @brief Naviframe is a kind of view manager for the applications.
28707     *
28708     * Naviframe provides functions to switch different pages with stack
28709     * mechanism. It means if one page(item) needs to be changed to the new one,
28710     * then naviframe would push the new page to it's internal stack. Of course,
28711     * it can be back to the previous page by popping the top page. Naviframe
28712     * provides some transition effect while the pages are switching (same as
28713     * pager).
28714     *
28715     * Since each item could keep the different styles, users could keep the
28716     * same look & feel for the pages or different styles for the items in it's
28717     * application.
28718     *
28719     * Signals that you can add callback for are:
28720     * @li "transition,finished" - When the transition is finished in changing
28721     *     the item
28722     * @li "title,clicked" - User clicked title area
28723     *
28724     * Default contents parts of the naviframe items that you can use for are:
28725     * @li "elm.swallow.content" - A main content of the page
28726     * @li "elm.swallow.icon" - A icon in the title area
28727     * @li "elm.swallow.prev_btn" - A button to go to the previous page
28728     * @li "elm.swallow.next_btn" - A button to go to the next page
28729     *
28730     * Default text parts of the naviframe items that you can use for are:
28731     * @li "elm.text.title" - Title label in the title area
28732     * @li "elm.text.subtitle" - Sub-title label in the title area
28733     *
28734     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28735     */
28736
28737   //Available commonly
28738   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28739   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28740   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28741   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28742   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28743   #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28744   #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28745   #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28746   #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28747   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28748   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28749   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28750   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28751
28752    //Available only in a style - "2line"
28753   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28754
28755   //Available only in a style - "segment"
28756   #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28757   #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28758
28759    /**
28760     * @addtogroup Naviframe
28761     * @{
28762     */
28763
28764    /**
28765     * @brief Add a new Naviframe object to the parent.
28766     *
28767     * @param parent Parent object
28768     * @return New object or @c NULL, if it cannot be created
28769     *
28770     * @ingroup Naviframe
28771     */
28772    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28773    /**
28774     * @brief Push a new item to the top of the naviframe stack (and show it).
28775     *
28776     * @param obj The naviframe object
28777     * @param title_label The label in the title area. The name of the title
28778     *        label part is "elm.text.title"
28779     * @param prev_btn The button to go to the previous item. If it is NULL,
28780     *        then naviframe will create a back button automatically. The name of
28781     *        the prev_btn part is "elm.swallow.prev_btn"
28782     * @param next_btn The button to go to the next item. Or It could be just an
28783     *        extra function button. The name of the next_btn part is
28784     *        "elm.swallow.next_btn"
28785     * @param content The main content object. The name of content part is
28786     *        "elm.swallow.content"
28787     * @param item_style The current item style name. @c NULL would be default.
28788     * @return The created item or @c NULL upon failure.
28789     *
28790     * The item pushed becomes one page of the naviframe, this item will be
28791     * deleted when it is popped.
28792     *
28793     * @see also elm_naviframe_item_style_set()
28794     * @see also elm_naviframe_item_insert_before()
28795     * @see also elm_naviframe_item_insert_after()
28796     *
28797     * The following styles are available for this item:
28798     * @li @c "default"
28799     *
28800     * @ingroup Naviframe
28801     */
28802    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);
28803     /**
28804     * @brief Insert a new item into the naviframe before item @p before.
28805     *
28806     * @param before The naviframe item to insert before.
28807     * @param title_label The label in the title area. The name of the title
28808     *        label part is "elm.text.title"
28809     * @param prev_btn The button to go to the previous item. If it is NULL,
28810     *        then naviframe will create a back button automatically. The name of
28811     *        the prev_btn part is "elm.swallow.prev_btn"
28812     * @param next_btn The button to go to the next item. Or It could be just an
28813     *        extra function button. The name of the next_btn part is
28814     *        "elm.swallow.next_btn"
28815     * @param content The main content object. The name of content part is
28816     *        "elm.swallow.content"
28817     * @param item_style The current item style name. @c NULL would be default.
28818     * @return The created item or @c NULL upon failure.
28819     *
28820     * The item is inserted into the naviframe straight away without any
28821     * transition operations. This item will be deleted when it is popped.
28822     *
28823     * @see also elm_naviframe_item_style_set()
28824     * @see also elm_naviframe_item_push()
28825     * @see also elm_naviframe_item_insert_after()
28826     *
28827     * The following styles are available for this item:
28828     * @li @c "default"
28829     *
28830     * @ingroup Naviframe
28831     */
28832    EAPI Elm_Object_Item    *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28833    /**
28834     * @brief Insert a new item into the naviframe after item @p after.
28835     *
28836     * @param after The naviframe item to insert after.
28837     * @param title_label The label in the title area. The name of the title
28838     *        label part is "elm.text.title"
28839     * @param prev_btn The button to go to the previous item. If it is NULL,
28840     *        then naviframe will create a back button automatically. The name of
28841     *        the prev_btn part is "elm.swallow.prev_btn"
28842     * @param next_btn The button to go to the next item. Or It could be just an
28843     *        extra function button. The name of the next_btn part is
28844     *        "elm.swallow.next_btn"
28845     * @param content The main content object. The name of content part is
28846     *        "elm.swallow.content"
28847     * @param item_style The current item style name. @c NULL would be default.
28848     * @return The created item or @c NULL upon failure.
28849     *
28850     * The item is inserted into the naviframe straight away without any
28851     * transition operations. This item will be deleted when it is popped.
28852     *
28853     * @see also elm_naviframe_item_style_set()
28854     * @see also elm_naviframe_item_push()
28855     * @see also elm_naviframe_item_insert_before()
28856     *
28857     * The following styles are available for this item:
28858     * @li @c "default"
28859     *
28860     * @ingroup Naviframe
28861     */
28862    EAPI Elm_Object_Item    *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28863    /**
28864     * @brief Pop an item that is on top of the stack
28865     *
28866     * @param obj The naviframe object
28867     * @return @c NULL or the content object(if the
28868     *         elm_naviframe_content_preserve_on_pop_get is true).
28869     *
28870     * This pops an item that is on the top(visible) of the naviframe, makes it
28871     * disappear, then deletes the item. The item that was underneath it on the
28872     * stack will become visible.
28873     *
28874     * @see also elm_naviframe_content_preserve_on_pop_get()
28875     *
28876     * @ingroup Naviframe
28877     */
28878    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28879    /**
28880     * @brief Pop the items between the top and the above one on the given item.
28881     *
28882     * @param it The naviframe item
28883     *
28884     * @ingroup Naviframe
28885     */
28886    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28887    /**
28888    * Promote an item already in the naviframe stack to the top of the stack
28889    *
28890    * @param it The naviframe item
28891    *
28892    * This will take the indicated item and promote it to the top of the stack
28893    * as if it had been pushed there. The item must already be inside the
28894    * naviframe stack to work.
28895    *
28896    */
28897    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28898    /**
28899     * @brief Delete the given item instantly.
28900     *
28901     * @param it The naviframe item
28902     *
28903     * This just deletes the given item from the naviframe item list instantly.
28904     * So this would not emit any signals for view transitions but just change
28905     * the current view if the given item is a top one.
28906     *
28907     * @ingroup Naviframe
28908     */
28909    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28910    /**
28911     * @brief preserve the content objects when items are popped.
28912     *
28913     * @param obj The naviframe object
28914     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28915     *
28916     * @see also elm_naviframe_content_preserve_on_pop_get()
28917     *
28918     * @ingroup Naviframe
28919     */
28920    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28921    /**
28922     * @brief Get a value whether preserve mode is enabled or not.
28923     *
28924     * @param obj The naviframe object
28925     * @return If @c EINA_TRUE, preserve mode is enabled
28926     *
28927     * @see also elm_naviframe_content_preserve_on_pop_set()
28928     *
28929     * @ingroup Naviframe
28930     */
28931    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28932    /**
28933     * @brief Get a top item on the naviframe stack
28934     *
28935     * @param obj The naviframe object
28936     * @return The top item on the naviframe stack or @c NULL, if the stack is
28937     *         empty
28938     *
28939     * @ingroup Naviframe
28940     */
28941    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28942    /**
28943     * @brief Get a bottom item on the naviframe stack
28944     *
28945     * @param obj The naviframe object
28946     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28947     *         empty
28948     *
28949     * @ingroup Naviframe
28950     */
28951    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28952    /**
28953     * @brief Set an item style
28954     *
28955     * @param obj The naviframe item
28956     * @param item_style The current item style name. @c NULL would be default
28957     *
28958     * The following styles are available for this item:
28959     * @li @c "default"
28960     *
28961     * @see also elm_naviframe_item_style_get()
28962     *
28963     * @ingroup Naviframe
28964     */
28965    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28966    /**
28967     * @brief Get an item style
28968     *
28969     * @param obj The naviframe item
28970     * @return The current item style name
28971     *
28972     * @see also elm_naviframe_item_style_set()
28973     *
28974     * @ingroup Naviframe
28975     */
28976    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28977    /**
28978     * @brief Show/Hide the title area
28979     *
28980     * @param it The naviframe item
28981     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28982     *        otherwise
28983     *
28984     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28985     *
28986     * @see also elm_naviframe_item_title_visible_get()
28987     *
28988     * @ingroup Naviframe
28989     */
28990    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28991    /**
28992     * @brief Get a value whether title area is visible or not.
28993     *
28994     * @param it The naviframe item
28995     * @return If @c EINA_TRUE, title area is visible
28996     *
28997     * @see also elm_naviframe_item_title_visible_set()
28998     *
28999     * @ingroup Naviframe
29000     */
29001    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29002
29003    /**
29004     * @brief Set creating prev button automatically or not
29005     *
29006     * @param obj The naviframe object
29007     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29008     *        be created internally when you pass the @c NULL to the prev_btn
29009     *        parameter in elm_naviframe_item_push
29010     *
29011     * @see also elm_naviframe_item_push()
29012     */
29013    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29014    /**
29015     * @brief Get a value whether prev button(back button) will be auto pushed or
29016     *        not.
29017     *
29018     * @param obj The naviframe object
29019     * @return If @c EINA_TRUE, prev button will be auto pushed.
29020     *
29021     * @see also elm_naviframe_item_push()
29022     *           elm_naviframe_prev_btn_auto_pushed_set()
29023     */
29024    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29025    /**
29026     * @brief Get a list of all the naviframe items.
29027     *
29028     * @param obj The naviframe object
29029     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29030     * or @c NULL on failure.
29031     */
29032    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29033
29034    /**
29035     * @}
29036     */
29037
29038    /* Control Bar */
29039    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29040    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29041    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29042    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29043    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29044    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29045    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29046    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29047    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29048
29049    typedef enum _Elm_Controlbar_Mode_Type
29050      {
29051         ELM_CONTROLBAR_MODE_DEFAULT = 0,
29052         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29053         ELM_CONTROLBAR_MODE_TRANSPARENCY,
29054         ELM_CONTROLBAR_MODE_LARGE,
29055         ELM_CONTROLBAR_MODE_SMALL,
29056         ELM_CONTROLBAR_MODE_LEFT,
29057         ELM_CONTROLBAR_MODE_RIGHT
29058      } Elm_Controlbar_Mode_Type;
29059
29060    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29061    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29062    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29063    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29064    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);
29065    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);
29066    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);
29067    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);
29068    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);
29069    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);
29070    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29071    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29072    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29073    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29074    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29075    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
29076    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
29077    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29078    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29079    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29080    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29081    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29082    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29083    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29084    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29085    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29086    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29087    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29088    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
29089    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29090    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29091    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29092    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29093    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29094    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29095    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
29096    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29097    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29098    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29099
29100    /* SearchBar */
29101    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29102    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29103    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
29104    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29105    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29106    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29107    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29108    EAPI void         elm_searchbar_clear(Evas_Object *obj);
29109    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29110
29111    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29112    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29113    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29114    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29115
29116    /* NoContents */
29117    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29118    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
29119    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
29120    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29121    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29122
29123    /* TickerNoti */
29124    typedef enum
29125      {
29126         ELM_TICKERNOTI_ORIENT_TOP = 0,
29127         ELM_TICKERNOTI_ORIENT_BOTTOM,
29128         ELM_TICKERNOTI_ORIENT_LAST
29129      }  Elm_Tickernoti_Orient;
29130
29131    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
29132    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29133    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29134    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29135    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29136    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29137    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29138    typedef enum
29139     {
29140        ELM_TICKERNOTI_DEFAULT,
29141        ELM_TICKERNOTI_DETAILVIEW
29142     } Elm_Tickernoti_Mode;
29143    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29144    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29145    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29146    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29147    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29148    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29149    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29150    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29151    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29152    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29153    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29154    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29155    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29156    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29157    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29158    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29159    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29160    /* ############################################################################### */
29161    /*
29162     * Parts which can be used with elm_object_text_part_set() and
29163     * elm_object_text_part_get():
29164     *
29165     * @li NULL/"default" - Operates on tickernoti content-text
29166     *
29167     * Parts which can be used with elm_object_content_part_set(),
29168     * elm_object_content_part_get() and elm_object_content_part_unset():
29169     *
29170     * @li "icon" - Operates on tickernoti's icon
29171     * @li "button" - Operates on tickernoti's button
29172     *
29173     * smart callbacks called:
29174     * @li "clicked" - emitted when tickernoti is clicked, except at the
29175     * swallow/button region, if any.
29176     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29177     * any hide animation, this signal is emitted after the animation.
29178     */
29179
29180    /* colorpalette */
29181    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29182
29183    struct _Colorpalette_Color
29184      {
29185         unsigned int r, g, b;
29186      };
29187
29188    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29189    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29190    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29191    /* smart callbacks called:
29192     * "clicked" - when image clicked
29193     */
29194
29195    /* editfield */
29196    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29197    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
29198    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
29199    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29200    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
29201    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29202 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29203    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29204    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29205    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29206    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29207    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29208    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
29209    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29210    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
29211    /* smart callbacks called:
29212     * "clicked" - when an editfield is clicked
29213     * "unfocused" - when an editfield is unfocused
29214     */
29215
29216
29217    /* Sliding Drawer */
29218    typedef enum _Elm_SlidingDrawer_Pos
29219      {
29220         ELM_SLIDINGDRAWER_BOTTOM,
29221         ELM_SLIDINGDRAWER_LEFT,
29222         ELM_SLIDINGDRAWER_RIGHT,
29223         ELM_SLIDINGDRAWER_TOP
29224      } Elm_SlidingDrawer_Pos;
29225
29226    typedef struct _Elm_SlidingDrawer_Drag_Value
29227      {
29228         double x, y;
29229      } Elm_SlidingDrawer_Drag_Value;
29230
29231    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29232    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29233    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29234    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29235    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
29236    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29237
29238    /* multibuttonentry */
29239    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29240    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29241    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
29242    EAPI const char                *elm_multibuttonentry_label_get(Evas_Object *obj);
29243    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29244    EAPI Evas_Object               *elm_multibuttonentry_entry_get(Evas_Object *obj);
29245    EAPI const char *               elm_multibuttonentry_guide_text_get(Evas_Object *obj);
29246    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29247    EAPI int                        elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
29248    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29249    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29250    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29251    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29252    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29253    EAPI const Eina_List           *elm_multibuttonentry_items_get(Evas_Object *obj);
29254    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
29255    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
29256    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
29257    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29258    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29259    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29260    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
29261    EAPI const char                *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
29262    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29263    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29264    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29265    EAPI void                      *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
29266    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29267    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29268    /* smart callback called:
29269     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29270     * "added" - This signal is emitted when a new multibuttonentry item is added.
29271     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29272     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29273     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29274     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29275     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29276     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29277     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29278     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29279     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29280     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29281     */
29282    /* available styles:
29283     * default
29284     */
29285
29286    /* stackedicon */
29287    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29288    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
29289    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29290    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29291    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29292    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
29293    /* smart callback called:
29294     * "expanded" - This signal is emitted when a stackedicon is expanded.
29295     * "clicked" - This signal is emitted when a stackedicon is clicked.
29296     */
29297    /* available styles:
29298     * default
29299     */
29300
29301    /* dialoguegroup */
29302    typedef struct _Dialogue_Item Dialogue_Item;
29303
29304    typedef enum _Elm_Dialoguegourp_Item_Style
29305      {
29306         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29307         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29308         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29309         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29310         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29311         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29312         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29313         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29314         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29315         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29316         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29317      } Elm_Dialoguegroup_Item_Style;
29318
29319    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
29320    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29321    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29322    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29323    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29324    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
29325    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
29326    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29327    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
29328    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29329    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29330    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29331    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29332    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29333    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29334    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29335
29336    /* Dayselector */
29337    typedef enum
29338      {
29339         ELM_DAYSELECTOR_SUN,
29340         ELM_DAYSELECTOR_MON,
29341         ELM_DAYSELECTOR_TUE,
29342         ELM_DAYSELECTOR_WED,
29343         ELM_DAYSELECTOR_THU,
29344         ELM_DAYSELECTOR_FRI,
29345         ELM_DAYSELECTOR_SAT
29346      } Elm_DaySelector_Day;
29347
29348    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29349    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29350    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29351
29352    /* Image Slider */
29353    typedef struct _Imageslider_Item Elm_Imageslider_Item;
29354    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29355    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29356    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);
29357    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);
29358    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);
29359    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29360    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29361    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29362    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29363    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29364    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29365    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29366    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29367    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29368    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29369    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29370 #ifdef __cplusplus
29371 }
29372 #endif
29373
29374 #endif