3486e231b712c7d37c5a47715468d7eefc8143f2
[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 the application has reconfigured elementary settings due
487     * to an external configuration tool asking it to.
488     */
489    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
490
491    /**
492     * Emitted when any Elementary's policy value is changed.
493     */
494    EAPI extern int ELM_EVENT_POLICY_CHANGED;
495
496    /**
497     * @typedef Elm_Event_Policy_Changed
498     *
499     * Data on the event when an Elementary policy has changed
500     */
501     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
502
503    /**
504     * @struct _Elm_Event_Policy_Changed
505     *
506     * Data on the event when an Elementary policy has changed
507     */
508     struct _Elm_Event_Policy_Changed
509      {
510         unsigned int policy; /**< the policy identifier */
511         int          new_value; /**< value the policy had before the change */
512         int          old_value; /**< new value the policy got */
513     };
514
515    /**
516     * Policy identifiers.
517     */
518     typedef enum _Elm_Policy
519     {
520         ELM_POLICY_QUIT, /**< under which circumstances the application
521                           * should quit automatically. @see
522                           * Elm_Policy_Quit.
523                           */
524         ELM_POLICY_LAST
525     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
526  */
527
528    typedef enum _Elm_Policy_Quit
529      {
530         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
531                                    * automatically */
532         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
533                                             * application's last
534                                             * window is closed */
535      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
536
537    typedef enum _Elm_Focus_Direction
538      {
539         ELM_FOCUS_PREVIOUS,
540         ELM_FOCUS_NEXT
541      } Elm_Focus_Direction;
542
543    typedef enum _Elm_Text_Format
544      {
545         ELM_TEXT_FORMAT_PLAIN_UTF8,
546         ELM_TEXT_FORMAT_MARKUP_UTF8
547      } Elm_Text_Format;
548
549    /**
550     * Line wrapping types.
551     */
552    typedef enum _Elm_Wrap_Type
553      {
554         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
555         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
556         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
557         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
558         ELM_WRAP_LAST
559      } Elm_Wrap_Type;
560
561    typedef enum
562      {
563         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
564         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
565         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
566         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
567         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
568         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
569         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
570         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
571         ELM_INPUT_PANEL_LAYOUT_INVALID
572      } Elm_Input_Panel_Layout;
573
574    typedef enum
575      {
576         ELM_AUTOCAPITAL_TYPE_NONE,
577         ELM_AUTOCAPITAL_TYPE_WORD,
578         ELM_AUTOCAPITAL_TYPE_SENTENCE,
579         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
580      } Elm_Autocapital_Type;
581
582    /**
583     * @typedef Elm_Object_Item
584     * An Elementary Object item handle.
585     * @ingroup General
586     */
587    typedef struct _Elm_Object_Item Elm_Object_Item;
588
589
590    /**
591     * Called back when a widget's tooltip is activated and needs content.
592     * @param data user-data given to elm_object_tooltip_content_cb_set()
593     * @param obj owner widget.
594     * @param tooltip The tooltip object (affix content to this!)
595     */
596    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
597
598    /**
599     * Called back when a widget's item tooltip is activated and needs content.
600     * @param data user-data given to elm_object_tooltip_content_cb_set()
601     * @param obj owner widget.
602     * @param tooltip The tooltip object (affix content to this!)
603     * @param item context dependent item. As an example, if tooltip was
604     *        set on Elm_List_Item, then it is of this type.
605     */
606    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
607
608    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
609
610 #ifndef ELM_LIB_QUICKLAUNCH
611 #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 */
612 #else
613 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
614 #endif
615
616 /**************************************************************************/
617    /* General calls */
618
619    /**
620     * Initialize Elementary
621     *
622     * @param[in] argc System's argument count value
623     * @param[in] argv System's pointer to array of argument strings
624     * @return The init counter value.
625     *
626     * This function initializes Elementary and increments a counter of
627     * the number of calls to it. It returns the new counter's value.
628     *
629     * @warning This call is exported only for use by the @c ELM_MAIN()
630     * macro. There is no need to use this if you use this macro (which
631     * is highly advisable). An elm_main() should contain the entry
632     * point code for your application, having the same prototype as
633     * elm_init(), and @b not being static (putting the @c EAPI symbol
634     * in front of its type declaration is advisable). The @c
635     * ELM_MAIN() call should be placed just after it.
636     *
637     * Example:
638     * @dontinclude bg_example_01.c
639     * @skip static void
640     * @until ELM_MAIN
641     *
642     * See the full @ref bg_example_01_c "example".
643     *
644     * @see elm_shutdown().
645     * @ingroup General
646     */
647    EAPI int          elm_init(int argc, char **argv);
648
649    /**
650     * Shut down Elementary
651     *
652     * @return The init counter value.
653     *
654     * This should be called at the end of your application, just
655     * before it ceases to do any more processing. This will clean up
656     * any permanent resources your application may have allocated via
657     * Elementary that would otherwise persist.
658     *
659     * @see elm_init() for an example
660     *
661     * @ingroup General
662     */
663    EAPI int          elm_shutdown(void);
664
665    /**
666     * Run Elementary's main loop
667     *
668     * This call should be issued just after all initialization is
669     * completed. This function will not return until elm_exit() is
670     * called. It will keep looping, running the main
671     * (event/processing) loop for Elementary.
672     *
673     * @see elm_init() for an example
674     *
675     * @ingroup General
676     */
677    EAPI void         elm_run(void);
678
679    /**
680     * Exit Elementary's main loop
681     *
682     * If this call is issued, it will flag the main loop to cease
683     * processing and return back to its parent function (usually your
684     * elm_main() function).
685     *
686     * @see elm_init() for an example. There, just after a request to
687     * close the window comes, the main loop will be left.
688     *
689     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
690     * applications, you'll be able to get this function called automatically for you.
691     *
692     * @ingroup General
693     */
694    EAPI void         elm_exit(void);
695
696    /**
697     * Provide information in order to make Elementary determine the @b
698     * run time location of the software in question, so other data files
699     * such as images, sound files, executable utilities, libraries,
700     * modules and locale files can be found.
701     *
702     * @param mainfunc This is your application's main function name,
703     *        whose binary's location is to be found. Providing @c NULL
704     *        will make Elementary not to use it
705     * @param dom This will be used as the application's "domain", in the
706     *        form of a prefix to any environment variables that may
707     *        override prefix detection and the directory name, inside the
708     *        standard share or data directories, where the software's
709     *        data files will be looked for.
710     * @param checkfile This is an (optional) magic file's path to check
711     *        for existence (and it must be located in the data directory,
712     *        under the share directory provided above). Its presence will
713     *        help determine the prefix found was correct. Pass @c NULL if
714     *        the check is not to be done.
715     *
716     * This function allows one to re-locate the application somewhere
717     * else after compilation, if the developer wishes for easier
718     * distribution of pre-compiled binaries.
719     *
720     * The prefix system is designed to locate where the given software is
721     * installed (under a common path prefix) at run time and then report
722     * specific locations of this prefix and common directories inside
723     * this prefix like the binary, library, data and locale directories,
724     * through the @c elm_app_*_get() family of functions.
725     *
726     * Call elm_app_info_set() early on before you change working
727     * directory or anything about @c argv[0], so it gets accurate
728     * information.
729     *
730     * It will then try and trace back which file @p mainfunc comes from,
731     * if provided, to determine the application's prefix directory.
732     *
733     * The @p dom parameter provides a string prefix to prepend before
734     * environment variables, allowing a fallback to @b specific
735     * environment variables to locate the software. You would most
736     * probably provide a lowercase string there, because it will also
737     * serve as directory domain, explained next. For environment
738     * variables purposes, this string is made uppercase. For example if
739     * @c "myapp" is provided as the prefix, then the program would expect
740     * @c "MYAPP_PREFIX" as a master environment variable to specify the
741     * exact install prefix for the software, or more specific environment
742     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
743     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
744     * the user or scripts before launching. If not provided (@c NULL),
745     * environment variables will not be used to override compiled-in
746     * defaults or auto detections.
747     *
748     * The @p dom string also provides a subdirectory inside the system
749     * shared data directory for data files. For example, if the system
750     * directory is @c /usr/local/share, then this directory name is
751     * appended, creating @c /usr/local/share/myapp, if it @p was @c
752     * "myapp". It is expected that the application installs data files in
753     * this directory.
754     *
755     * The @p checkfile is a file name or path of something inside the
756     * share or data directory to be used to test that the prefix
757     * detection worked. For example, your app will install a wallpaper
758     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
759     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
760     * checkfile string.
761     *
762     * @see elm_app_compile_bin_dir_set()
763     * @see elm_app_compile_lib_dir_set()
764     * @see elm_app_compile_data_dir_set()
765     * @see elm_app_compile_locale_set()
766     * @see elm_app_prefix_dir_get()
767     * @see elm_app_bin_dir_get()
768     * @see elm_app_lib_dir_get()
769     * @see elm_app_data_dir_get()
770     * @see elm_app_locale_dir_get()
771     */
772    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
773
774    /**
775     * Provide information on the @b fallback application's binaries
776     * directory, in scenarios where they get overriden by
777     * elm_app_info_set().
778     *
779     * @param dir The path to the default binaries directory (compile time
780     * one)
781     *
782     * @note Elementary will as well use this path to determine actual
783     * names of binaries' directory paths, maybe changing it to be @c
784     * something/local/bin instead of @c something/bin, only, for
785     * example.
786     *
787     * @warning You should call this function @b before
788     * elm_app_info_set().
789     */
790    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
791
792    /**
793     * Provide information on the @b fallback application's libraries
794     * directory, on scenarios where they get overriden by
795     * elm_app_info_set().
796     *
797     * @param dir The path to the default libraries directory (compile
798     * time one)
799     *
800     * @note Elementary will as well use this path to determine actual
801     * names of libraries' directory paths, maybe changing it to be @c
802     * something/lib32 or @c something/lib64 instead of @c something/lib,
803     * only, for example.
804     *
805     * @warning You should call this function @b before
806     * elm_app_info_set().
807     */
808    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
809
810    /**
811     * Provide information on the @b fallback application's data
812     * directory, on scenarios where they get overriden by
813     * elm_app_info_set().
814     *
815     * @param dir The path to the default data directory (compile time
816     * one)
817     *
818     * @note Elementary will as well use this path to determine actual
819     * names of data directory paths, maybe changing it to be @c
820     * something/local/share instead of @c something/share, only, for
821     * example.
822     *
823     * @warning You should call this function @b before
824     * elm_app_info_set().
825     */
826    EAPI void         elm_app_compile_data_dir_set(const char *dir);
827
828    /**
829     * Provide information on the @b fallback application's locale
830     * directory, on scenarios where they get overriden by
831     * elm_app_info_set().
832     *
833     * @param dir The path to the default locale directory (compile time
834     * one)
835     *
836     * @warning You should call this function @b before
837     * elm_app_info_set().
838     */
839    EAPI void         elm_app_compile_locale_set(const char *dir);
840
841    /**
842     * Retrieve the application's run time prefix directory, as set by
843     * elm_app_info_set() and the way (environment) the application was
844     * run from.
845     *
846     * @return The directory prefix the application is actually using.
847     */
848    EAPI const char  *elm_app_prefix_dir_get(void);
849
850    /**
851     * Retrieve the application's run time binaries prefix directory, as
852     * set by elm_app_info_set() and the way (environment) the application
853     * was run from.
854     *
855     * @return The binaries directory prefix the application is actually
856     * using.
857     */
858    EAPI const char  *elm_app_bin_dir_get(void);
859
860    /**
861     * Retrieve the application's run time libraries prefix directory, as
862     * set by elm_app_info_set() and the way (environment) the application
863     * was run from.
864     *
865     * @return The libraries directory prefix the application is actually
866     * using.
867     */
868    EAPI const char  *elm_app_lib_dir_get(void);
869
870    /**
871     * Retrieve the application's run time data prefix directory, as
872     * set by elm_app_info_set() and the way (environment) the application
873     * was run from.
874     *
875     * @return The data directory prefix the application is actually
876     * using.
877     */
878    EAPI const char  *elm_app_data_dir_get(void);
879
880    /**
881     * Retrieve the application's run time locale prefix directory, as
882     * set by elm_app_info_set() and the way (environment) the application
883     * was run from.
884     *
885     * @return The locale directory prefix the application is actually
886     * using.
887     */
888    EAPI const char  *elm_app_locale_dir_get(void);
889
890    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
891    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
892    EAPI int          elm_quicklaunch_init(int argc, char **argv);
893    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
894    EAPI int          elm_quicklaunch_sub_shutdown(void);
895    EAPI int          elm_quicklaunch_shutdown(void);
896    EAPI void         elm_quicklaunch_seed(void);
897    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
898    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
899    EAPI void         elm_quicklaunch_cleanup(void);
900    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
901    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
902
903    EAPI Eina_Bool    elm_need_efreet(void);
904    EAPI Eina_Bool    elm_need_e_dbus(void);
905
906    /**
907     * This must be called before any other function that deals with
908     * elm_thumb objects or ethumb_client instances.
909     *
910     * @ingroup Thumb
911     */
912    EAPI Eina_Bool    elm_need_ethumb(void);
913
914    /**
915     * This must be called before any other function that deals with
916     * elm_web objects or ewk_view instances.
917     *
918     * @ingroup Web
919     */
920    EAPI Eina_Bool    elm_need_web(void);
921
922    /**
923     * Set a new policy's value (for a given policy group/identifier).
924     *
925     * @param policy policy identifier, as in @ref Elm_Policy.
926     * @param value policy value, which depends on the identifier
927     *
928     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
929     *
930     * Elementary policies define applications' behavior,
931     * somehow. These behaviors are divided in policy groups (see
932     * #Elm_Policy enumeration). This call will emit the Ecore event
933     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
934     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
935     * then.
936     *
937     * @note Currently, we have only one policy identifier/group
938     * (#ELM_POLICY_QUIT), which has two possible values.
939     *
940     * @ingroup General
941     */
942    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
943
944    /**
945     * Gets the policy value for given policy identifier.
946     *
947     * @param policy policy identifier, as in #Elm_Policy.
948     * @return The currently set policy value, for that
949     * identifier. Will be @c 0 if @p policy passed is invalid.
950     *
951     * @ingroup General
952     */
953    EAPI int          elm_policy_get(unsigned int policy);
954
955    /**
956     * Change the language of the current application
957     *
958     * The @p lang passed must be the full name of the locale to use, for
959     * example "en_US.utf8" or "es_ES@euro".
960     *
961     * Changing language with this function will make Elementary run through
962     * all its widgets, translating strings set with
963     * elm_object_domain_translatable_text_part_set(). This way, an entire
964     * UI can have its language changed without having to restart the program.
965     *
966     * For more complex cases, like having formatted strings that need
967     * translation, widgets will also emit a "language,changed" signal that
968     * the user can listen to to manually translate the text.
969     *
970     * @param lang Language to set, must be the full name of the locale
971     *
972     * @ingroup General
973     */
974    EAPI void         elm_language_set(const char *lang);
975
976    /**
977     * Set a label of an object
978     *
979     * @param obj The Elementary object
980     * @param part The text part name to set (NULL for the default label)
981     * @param label The new text of the label
982     *
983     * @note Elementary objects may have many labels (e.g. Action Slider)
984     *
985     * @ingroup General
986     */
987    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
988
989 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
990
991    /**
992     * Get a label of an object
993     *
994     * @param obj The Elementary object
995     * @param part The text part name to get (NULL for the default label)
996     * @return text of the label or NULL for any error
997     *
998     * @note Elementary objects may have many labels (e.g. Action Slider)
999     *
1000     * @ingroup General
1001     */
1002    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1003
1004 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1005
1006    /**
1007     * Set the text for an objects' part, marking it as translatable.
1008     *
1009     * The string to set as @p text must be the original one. Do not pass the
1010     * return of @c gettext() here. Elementary will translate the string
1011     * internally and set it on the object using elm_object_text_part_set(),
1012     * also storing the original string so that it can be automatically
1013     * translated when the language is changed with elm_language_set().
1014     *
1015     * The @p domain will be stored along to find the translation in the
1016     * correct catalog. It can be NULL, in which case it will use whatever
1017     * domain was set by the application with @c textdomain(). This is useful
1018     * in case you are building a library on top of Elementary that will have
1019     * its own translatable strings, that should not be mixed with those of
1020     * programs using the library.
1021     *
1022     * @param obj The object containing the text part
1023     * @param part The name of the part to set
1024     * @param domain The translation domain to use
1025     * @param text The original, non-translated text to set
1026     *
1027     * @ingroup General
1028     */
1029    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1030
1031 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1032
1033 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1034
1035    /**
1036     * Gets the original string set as translatable for an object
1037     *
1038     * When setting translated strings, the function elm_object_text_part_get()
1039     * will return the translation returned by @c gettext(). To get the
1040     * original string use this function.
1041     *
1042     * @param obj The object
1043     * @param part The name of the part that was set
1044     *
1045     * @return The original, untranslated string
1046     *
1047     * @ingroup General
1048     */
1049    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1050
1051 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1052
1053    /**
1054     * Set a content of an object
1055     *
1056     * @param obj The Elementary object
1057     * @param part The content part name to set (NULL for the default content)
1058     * @param content The new content of the object
1059     *
1060     * @note Elementary objects may have many contents
1061     *
1062     * @ingroup General
1063     */
1064    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1065
1066 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1067
1068    /**
1069     * Get a content of an object
1070     *
1071     * @param obj The Elementary object
1072     * @param item The content part name to get (NULL for the default content)
1073     * @return content of the object or NULL for any error
1074     *
1075     * @note Elementary objects may have many contents
1076     *
1077     * @ingroup General
1078     */
1079    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1080
1081 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1082
1083    /**
1084     * Unset a content of an object
1085     *
1086     * @param obj The Elementary object
1087     * @param item The content part name to unset (NULL for the default content)
1088     *
1089     * @note Elementary objects may have many contents
1090     *
1091     * @ingroup General
1092     */
1093    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1094
1095 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1096
1097    /**
1098     * Get the widget object's handle which contains a given item
1099     *
1100     * @param item The Elementary object item
1101     * @return The widget object
1102     *
1103     * @note This returns the widget object itself that an item belongs to.
1104     *
1105     * @ingroup General
1106     */
1107    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1108
1109    /**
1110     * Set a content of an object item
1111     *
1112     * @param it The Elementary object item
1113     * @param part The content part name to set (NULL for the default content)
1114     * @param content The new content of the object item
1115     *
1116     * @note Elementary object items may have many contents
1117     *
1118     * @ingroup General
1119     */
1120    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1121
1122 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1123
1124    /**
1125     * Get a content of an object item
1126     *
1127     * @param it The Elementary object item
1128     * @param part The content part name to unset (NULL for the default content)
1129     * @return content of the object item or NULL for any error
1130     *
1131     * @note Elementary object items may have many contents
1132     *
1133     * @ingroup General
1134     */
1135    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1136
1137 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1138
1139    /**
1140     * Unset a content of an object item
1141     *
1142     * @param it The Elementary object item
1143     * @param part The content part name to unset (NULL for the default content)
1144     *
1145     * @note Elementary object items may have many contents
1146     *
1147     * @ingroup General
1148     */
1149    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1150
1151 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1152
1153    /**
1154     * Set a label of an object item
1155     *
1156     * @param it The Elementary object item
1157     * @param part The text part name to set (NULL for the default label)
1158     * @param label The new text of the label
1159     *
1160     * @note Elementary object items may have many labels
1161     *
1162     * @ingroup General
1163     */
1164    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1165
1166 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1167
1168    /**
1169     * Get a label of an object item
1170     *
1171     * @param it The Elementary object item
1172     * @param part The text part name to get (NULL for the default label)
1173     * @return text of the label or NULL for any error
1174     *
1175     * @note Elementary object items may have many labels
1176     *
1177     * @ingroup General
1178     */
1179    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1180
1181 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1182
1183    /**
1184     * Set the text to read out when in accessibility mode
1185     *
1186     * @param obj The object which is to be described
1187     * @param txt The text that describes the widget to people with poor or no vision
1188     *
1189     * @ingroup General
1190     */
1191    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1192
1193    /**
1194     * Set the text to read out when in accessibility mode
1195     *
1196     * @param it The object item which is to be described
1197     * @param txt The text that describes the widget to people with poor or no vision
1198     *
1199     * @ingroup General
1200     */
1201    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1202
1203    /**
1204     * Get the data associated with an object item
1205     * @param it The object item
1206     * @return The data associated with @p it
1207     *
1208     * @ingroup General
1209     */
1210    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1211
1212    /**
1213     * Set the data associated with an object item
1214     * @param it The object item
1215     * @param data The data to be associated with @p it
1216     *
1217     * @ingroup General
1218     */
1219    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1220
1221    /**
1222     * Send a signal to the edje object of the widget item.
1223     *
1224     * This function sends a signal to the edje object of the obj item. An
1225     * edje program can respond to a signal by specifying matching
1226     * 'signal' and 'source' fields.
1227     *
1228     * @param it The Elementary object item
1229     * @param emission The signal's name.
1230     * @param source The signal's source.
1231     * @ingroup General
1232     */
1233    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1234
1235    /**
1236     * @}
1237     */
1238
1239    /**
1240     * @defgroup Caches Caches
1241     *
1242     * These are functions which let one fine-tune some cache values for
1243     * Elementary applications, thus allowing for performance adjustments.
1244     *
1245     * @{
1246     */
1247
1248    /**
1249     * @brief Flush all caches.
1250     *
1251     * Frees all data that was in cache and is not currently being used to reduce
1252     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1253     * to calling all of the following functions:
1254     * @li edje_file_cache_flush()
1255     * @li edje_collection_cache_flush()
1256     * @li eet_clearcache()
1257     * @li evas_image_cache_flush()
1258     * @li evas_font_cache_flush()
1259     * @li evas_render_dump()
1260     * @note Evas caches are flushed for every canvas associated with a window.
1261     *
1262     * @ingroup Caches
1263     */
1264    EAPI void         elm_all_flush(void);
1265
1266    /**
1267     * Get the configured cache flush interval time
1268     *
1269     * This gets the globally configured cache flush interval time, in
1270     * ticks
1271     *
1272     * @return The cache flush interval time
1273     * @ingroup Caches
1274     *
1275     * @see elm_all_flush()
1276     */
1277    EAPI int          elm_cache_flush_interval_get(void);
1278
1279    /**
1280     * Set the configured cache flush interval time
1281     *
1282     * This sets the globally configured cache flush interval time, in ticks
1283     *
1284     * @param size The cache flush interval time
1285     * @ingroup Caches
1286     *
1287     * @see elm_all_flush()
1288     */
1289    EAPI void         elm_cache_flush_interval_set(int size);
1290
1291    /**
1292     * Set the configured cache flush interval time for all applications on the
1293     * display
1294     *
1295     * This sets the globally configured cache flush interval time -- in ticks
1296     * -- for all applications on the display.
1297     *
1298     * @param size The cache flush interval time
1299     * @ingroup Caches
1300     */
1301    EAPI void         elm_cache_flush_interval_all_set(int size);
1302
1303    /**
1304     * Get the configured cache flush enabled state
1305     *
1306     * This gets the globally configured cache flush state - if it is enabled
1307     * or not. When cache flushing is enabled, elementary will regularly
1308     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1309     * memory and allow usage to re-seed caches and data in memory where it
1310     * can do so. An idle application will thus minimise its memory usage as
1311     * data will be freed from memory and not be re-loaded as it is idle and
1312     * not rendering or doing anything graphically right now.
1313     *
1314     * @return The cache flush state
1315     * @ingroup Caches
1316     *
1317     * @see elm_all_flush()
1318     */
1319    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1320
1321    /**
1322     * Set the configured cache flush enabled state
1323     *
1324     * This sets the globally configured cache flush enabled state.
1325     *
1326     * @param size The cache flush enabled state
1327     * @ingroup Caches
1328     *
1329     * @see elm_all_flush()
1330     */
1331    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1332
1333    /**
1334     * Set the configured cache flush enabled state for all applications on the
1335     * display
1336     *
1337     * This sets the globally configured cache flush enabled state for all
1338     * applications on the display.
1339     *
1340     * @param size The cache flush enabled state
1341     * @ingroup Caches
1342     */
1343    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1344
1345    /**
1346     * Get the configured font cache size
1347     *
1348     * This gets the globally configured font cache size, in bytes.
1349     *
1350     * @return The font cache size
1351     * @ingroup Caches
1352     */
1353    EAPI int          elm_font_cache_get(void);
1354
1355    /**
1356     * Set the configured font cache size
1357     *
1358     * This sets the globally configured font cache size, in bytes
1359     *
1360     * @param size The font cache size
1361     * @ingroup Caches
1362     */
1363    EAPI void         elm_font_cache_set(int size);
1364
1365    /**
1366     * Set the configured font cache size for all applications on the
1367     * display
1368     *
1369     * This sets the globally configured font cache size -- in bytes
1370     * -- for all applications on the display.
1371     *
1372     * @param size The font cache size
1373     * @ingroup Caches
1374     */
1375    EAPI void         elm_font_cache_all_set(int size);
1376
1377    /**
1378     * Get the configured image cache size
1379     *
1380     * This gets the globally configured image cache size, in bytes
1381     *
1382     * @return The image cache size
1383     * @ingroup Caches
1384     */
1385    EAPI int          elm_image_cache_get(void);
1386
1387    /**
1388     * Set the configured image cache size
1389     *
1390     * This sets the globally configured image cache size, in bytes
1391     *
1392     * @param size The image cache size
1393     * @ingroup Caches
1394     */
1395    EAPI void         elm_image_cache_set(int size);
1396
1397    /**
1398     * Set the configured image cache size for all applications on the
1399     * display
1400     *
1401     * This sets the globally configured image cache size -- in bytes
1402     * -- for all applications on the display.
1403     *
1404     * @param size The image cache size
1405     * @ingroup Caches
1406     */
1407    EAPI void         elm_image_cache_all_set(int size);
1408
1409    /**
1410     * Get the configured edje file cache size.
1411     *
1412     * This gets the globally configured edje file cache size, in number
1413     * of files.
1414     *
1415     * @return The edje file cache size
1416     * @ingroup Caches
1417     */
1418    EAPI int          elm_edje_file_cache_get(void);
1419
1420    /**
1421     * Set the configured edje file cache size
1422     *
1423     * This sets the globally configured edje file cache size, in number
1424     * of files.
1425     *
1426     * @param size The edje file cache size
1427     * @ingroup Caches
1428     */
1429    EAPI void         elm_edje_file_cache_set(int size);
1430
1431    /**
1432     * Set the configured edje file cache size for all applications on the
1433     * display
1434     *
1435     * This sets the globally configured edje file cache size -- in number
1436     * of files -- for all applications on the display.
1437     *
1438     * @param size The edje file cache size
1439     * @ingroup Caches
1440     */
1441    EAPI void         elm_edje_file_cache_all_set(int size);
1442
1443    /**
1444     * Get the configured edje collections (groups) cache size.
1445     *
1446     * This gets the globally configured edje collections cache size, in
1447     * number of collections.
1448     *
1449     * @return The edje collections cache size
1450     * @ingroup Caches
1451     */
1452    EAPI int          elm_edje_collection_cache_get(void);
1453
1454    /**
1455     * Set the configured edje collections (groups) cache size
1456     *
1457     * This sets the globally configured edje collections cache size, in
1458     * number of collections.
1459     *
1460     * @param size The edje collections cache size
1461     * @ingroup Caches
1462     */
1463    EAPI void         elm_edje_collection_cache_set(int size);
1464
1465    /**
1466     * Set the configured edje collections (groups) cache size for all
1467     * applications on the display
1468     *
1469     * This sets the globally configured edje collections cache size -- in
1470     * number of collections -- for all applications on the display.
1471     *
1472     * @param size The edje collections cache size
1473     * @ingroup Caches
1474     */
1475    EAPI void         elm_edje_collection_cache_all_set(int size);
1476
1477    /**
1478     * @}
1479     */
1480
1481    /**
1482     * @defgroup Scaling Widget Scaling
1483     *
1484     * Different widgets can be scaled independently. These functions
1485     * allow you to manipulate this scaling on a per-widget basis. The
1486     * object and all its children get their scaling factors multiplied
1487     * by the scale factor set. This is multiplicative, in that if a
1488     * child also has a scale size set it is in turn multiplied by its
1489     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1490     * double size, @c 0.5 is half, etc.
1491     *
1492     * @ref general_functions_example_page "This" example contemplates
1493     * some of these functions.
1494     */
1495
1496    /**
1497     * Get the global scaling factor
1498     *
1499     * This gets the globally configured scaling factor that is applied to all
1500     * objects.
1501     *
1502     * @return The scaling factor
1503     * @ingroup Scaling
1504     */
1505    EAPI double       elm_scale_get(void);
1506
1507    /**
1508     * Set the global scaling factor
1509     *
1510     * This sets the globally configured scaling factor that is applied to all
1511     * objects.
1512     *
1513     * @param scale The scaling factor to set
1514     * @ingroup Scaling
1515     */
1516    EAPI void         elm_scale_set(double scale);
1517
1518    /**
1519     * Set the global scaling factor for all applications on the display
1520     *
1521     * This sets the globally configured scaling factor that is applied to all
1522     * objects for all applications.
1523     * @param scale The scaling factor to set
1524     * @ingroup Scaling
1525     */
1526    EAPI void         elm_scale_all_set(double scale);
1527
1528    /**
1529     * Set the scaling factor for a given Elementary object
1530     *
1531     * @param obj The Elementary to operate on
1532     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1533     * no scaling)
1534     *
1535     * @ingroup Scaling
1536     */
1537    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1538
1539    /**
1540     * Get the scaling factor for a given Elementary object
1541     *
1542     * @param obj The object
1543     * @return The scaling factor set by elm_object_scale_set()
1544     *
1545     * @ingroup Scaling
1546     */
1547    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1548
1549    /**
1550     * @defgroup Password_last_show Password last input show
1551     *
1552     * Last show feature of password mode enables user to view
1553     * the last input entered for few seconds before masking it.
1554     * These functions allow to set this feature in password mode
1555     * of entry widget and also allow to manipulate the duration
1556     * for which the input has to be visible.
1557     *
1558     * @{
1559     */
1560
1561    /**
1562     * Get show last setting of password mode.
1563     *
1564     * This gets the show last input setting of password mode which might be
1565     * enabled or disabled.
1566     *
1567     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1568     *            if it's disabled.
1569     * @ingroup Password_last_show
1570     */
1571    EAPI Eina_Bool elm_password_show_last_get(void);
1572
1573    /**
1574     * Set show last setting in password mode.
1575     *
1576     * This enables or disables show last setting of password mode.
1577     *
1578     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1579     * @see elm_password_show_last_timeout_set()
1580     * @ingroup Password_last_show
1581     */
1582    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1583
1584    /**
1585     * Get's the timeout value in last show password mode.
1586     *
1587     * This gets the time out value for which the last input entered in password
1588     * mode will be visible.
1589     *
1590     * @return The timeout value of last show password mode.
1591     * @ingroup Password_last_show
1592     */
1593    EAPI double elm_password_show_last_timeout_get(void);
1594
1595    /**
1596     * Set's the timeout value in last show password mode.
1597     *
1598     * This sets the time out value for which the last input entered in password
1599     * mode will be visible.
1600     *
1601     * @param password_show_last_timeout The timeout value.
1602     * @see elm_password_show_last_set()
1603     * @ingroup Password_last_show
1604     */
1605    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1606
1607    /**
1608     * @}
1609     */
1610
1611    /**
1612     * @defgroup UI-Mirroring Selective Widget mirroring
1613     *
1614     * These functions allow you to set ui-mirroring on specific
1615     * widgets or the whole interface. Widgets can be in one of two
1616     * modes, automatic and manual.  Automatic means they'll be changed
1617     * according to the system mirroring mode and manual means only
1618     * explicit changes will matter. You are not supposed to change
1619     * mirroring state of a widget set to automatic, will mostly work,
1620     * but the behavior is not really defined.
1621     *
1622     * @{
1623     */
1624
1625    EAPI Eina_Bool    elm_mirrored_get(void);
1626    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1627
1628    /**
1629     * Get the system mirrored mode. This determines the default mirrored mode
1630     * of widgets.
1631     *
1632     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1633     */
1634    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1635
1636    /**
1637     * Set the system mirrored mode. This determines the default mirrored mode
1638     * of widgets.
1639     *
1640     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1641     */
1642    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1643
1644    /**
1645     * Returns the widget's mirrored mode setting.
1646     *
1647     * @param obj The widget.
1648     * @return mirrored mode setting of the object.
1649     *
1650     **/
1651    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1652
1653    /**
1654     * Sets the widget's mirrored mode setting.
1655     * When widget in automatic mode, it follows the system mirrored mode set by
1656     * elm_mirrored_set().
1657     * @param obj The widget.
1658     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1659     */
1660    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1661
1662    /**
1663     * @}
1664     */
1665
1666    /**
1667     * Set the style to use by a widget
1668     *
1669     * Sets the style name that will define the appearance of a widget. Styles
1670     * vary from widget to widget and may also be defined by other themes
1671     * by means of extensions and overlays.
1672     *
1673     * @param obj The Elementary widget to style
1674     * @param style The style name to use
1675     *
1676     * @see elm_theme_extension_add()
1677     * @see elm_theme_extension_del()
1678     * @see elm_theme_overlay_add()
1679     * @see elm_theme_overlay_del()
1680     *
1681     * @ingroup Styles
1682     */
1683    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1684    /**
1685     * Get the style used by the widget
1686     *
1687     * This gets the style being used for that widget. Note that the string
1688     * pointer is only valid as longas the object is valid and the style doesn't
1689     * change.
1690     *
1691     * @param obj The Elementary widget to query for its style
1692     * @return The style name used
1693     *
1694     * @see elm_object_style_set()
1695     *
1696     * @ingroup Styles
1697     */
1698    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1699
1700    /**
1701     * @defgroup Styles Styles
1702     *
1703     * Widgets can have different styles of look. These generic API's
1704     * set styles of widgets, if they support them (and if the theme(s)
1705     * do).
1706     *
1707     * @ref general_functions_example_page "This" example contemplates
1708     * some of these functions.
1709     */
1710
1711    /**
1712     * Set the disabled state of an Elementary object.
1713     *
1714     * @param obj The Elementary object to operate on
1715     * @param disabled The state to put in in: @c EINA_TRUE for
1716     *        disabled, @c EINA_FALSE for enabled
1717     *
1718     * Elementary objects can be @b disabled, in which state they won't
1719     * receive input and, in general, will be themed differently from
1720     * their normal state, usually greyed out. Useful for contexts
1721     * where you don't want your users to interact with some of the
1722     * parts of you interface.
1723     *
1724     * This sets the state for the widget, either disabling it or
1725     * enabling it back.
1726     *
1727     * @ingroup Styles
1728     */
1729    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1730
1731    /**
1732     * Get the disabled state of an Elementary object.
1733     *
1734     * @param obj The Elementary object to operate on
1735     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1736     *            if it's enabled (or on errors)
1737     *
1738     * This gets the state of the widget, which might be enabled or disabled.
1739     *
1740     * @ingroup Styles
1741     */
1742    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1743
1744    /**
1745     * @defgroup WidgetNavigation Widget Tree Navigation.
1746     *
1747     * How to check if an Evas Object is an Elementary widget? How to
1748     * get the first elementary widget that is parent of the given
1749     * object?  These are all covered in widget tree navigation.
1750     *
1751     * @ref general_functions_example_page "This" example contemplates
1752     * some of these functions.
1753     */
1754
1755    /**
1756     * Check if the given Evas Object is an Elementary widget.
1757     *
1758     * @param obj the object to query.
1759     * @return @c EINA_TRUE if it is an elementary widget variant,
1760     *         @c EINA_FALSE otherwise
1761     * @ingroup WidgetNavigation
1762     */
1763    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1764
1765    /**
1766     * Get the first parent of the given object that is an Elementary
1767     * widget.
1768     *
1769     * @param obj the Elementary object to query parent from.
1770     * @return the parent object that is an Elementary widget, or @c
1771     *         NULL, if it was not found.
1772     *
1773     * Use this to query for an object's parent widget.
1774     *
1775     * @note Most of Elementary users wouldn't be mixing non-Elementary
1776     * smart objects in the objects tree of an application, as this is
1777     * an advanced usage of Elementary with Evas. So, except for the
1778     * application's window, which is the root of that tree, all other
1779     * objects would have valid Elementary widget parents.
1780     *
1781     * @ingroup WidgetNavigation
1782     */
1783    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1784
1785    /**
1786     * Get the top level parent of an Elementary widget.
1787     *
1788     * @param obj The object to query.
1789     * @return The top level Elementary widget, or @c NULL if parent cannot be
1790     * found.
1791     * @ingroup WidgetNavigation
1792     */
1793    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1794
1795    /**
1796     * Get the string that represents this Elementary widget.
1797     *
1798     * @note Elementary is weird and exposes itself as a single
1799     *       Evas_Object_Smart_Class of type "elm_widget", so
1800     *       evas_object_type_get() always return that, making debug and
1801     *       language bindings hard. This function tries to mitigate this
1802     *       problem, but the solution is to change Elementary to use
1803     *       proper inheritance.
1804     *
1805     * @param obj the object to query.
1806     * @return Elementary widget name, or @c NULL if not a valid widget.
1807     * @ingroup WidgetNavigation
1808     */
1809    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1810
1811    /**
1812     * @defgroup Config Elementary Config
1813     *
1814     * Elementary configuration is formed by a set options bounded to a
1815     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1816     * "finger size", etc. These are functions with which one syncronizes
1817     * changes made to those values to the configuration storing files, de
1818     * facto. You most probably don't want to use the functions in this
1819     * group unlees you're writing an elementary configuration manager.
1820     *
1821     * @{
1822     */
1823
1824    /**
1825     * Save back Elementary's configuration, so that it will persist on
1826     * future sessions.
1827     *
1828     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1829     * @ingroup Config
1830     *
1831     * This function will take effect -- thus, do I/O -- immediately. Use
1832     * it when you want to apply all configuration changes at once. The
1833     * current configuration set will get saved onto the current profile
1834     * configuration file.
1835     *
1836     */
1837    EAPI Eina_Bool    elm_config_save(void);
1838
1839    /**
1840     * Reload Elementary's configuration, bounded to current selected
1841     * profile.
1842     *
1843     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1844     * @ingroup Config
1845     *
1846     * Useful when you want to force reloading of configuration values for
1847     * a profile. If one removes user custom configuration directories,
1848     * for example, it will force a reload with system values insted.
1849     *
1850     */
1851    EAPI void         elm_config_reload(void);
1852
1853    /**
1854     * @}
1855     */
1856
1857    /**
1858     * @defgroup Profile Elementary Profile
1859     *
1860     * Profiles are pre-set options that affect the whole look-and-feel of
1861     * Elementary-based applications. There are, for example, profiles
1862     * aimed at desktop computer applications and others aimed at mobile,
1863     * touchscreen-based ones. You most probably don't want to use the
1864     * functions in this group unlees you're writing an elementary
1865     * configuration manager.
1866     *
1867     * @{
1868     */
1869
1870    /**
1871     * Get Elementary's profile in use.
1872     *
1873     * This gets the global profile that is applied to all Elementary
1874     * applications.
1875     *
1876     * @return The profile's name
1877     * @ingroup Profile
1878     */
1879    EAPI const char  *elm_profile_current_get(void);
1880
1881    /**
1882     * Get an Elementary's profile directory path in the filesystem. One
1883     * may want to fetch a system profile's dir or an user one (fetched
1884     * inside $HOME).
1885     *
1886     * @param profile The profile's name
1887     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1888     *                or a system one (@c EINA_FALSE)
1889     * @return The profile's directory path.
1890     * @ingroup Profile
1891     *
1892     * @note You must free it with elm_profile_dir_free().
1893     */
1894    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1895
1896    /**
1897     * Free an Elementary's profile directory path, as returned by
1898     * elm_profile_dir_get().
1899     *
1900     * @param p_dir The profile's path
1901     * @ingroup Profile
1902     *
1903     */
1904    EAPI void         elm_profile_dir_free(const char *p_dir);
1905
1906    /**
1907     * Get Elementary's list of available profiles.
1908     *
1909     * @return The profiles list. List node data are the profile name
1910     *         strings.
1911     * @ingroup Profile
1912     *
1913     * @note One must free this list, after usage, with the function
1914     *       elm_profile_list_free().
1915     */
1916    EAPI Eina_List   *elm_profile_list_get(void);
1917
1918    /**
1919     * Free Elementary's list of available profiles.
1920     *
1921     * @param l The profiles list, as returned by elm_profile_list_get().
1922     * @ingroup Profile
1923     *
1924     */
1925    EAPI void         elm_profile_list_free(Eina_List *l);
1926
1927    /**
1928     * Set Elementary's profile.
1929     *
1930     * This sets the global profile that is applied to Elementary
1931     * applications. Just the process the call comes from will be
1932     * affected.
1933     *
1934     * @param profile The profile's name
1935     * @ingroup Profile
1936     *
1937     */
1938    EAPI void         elm_profile_set(const char *profile);
1939
1940    /**
1941     * Set Elementary's profile.
1942     *
1943     * This sets the global profile that is applied to all Elementary
1944     * applications. All running Elementary windows will be affected.
1945     *
1946     * @param profile The profile's name
1947     * @ingroup Profile
1948     *
1949     */
1950    EAPI void         elm_profile_all_set(const char *profile);
1951
1952    /**
1953     * @}
1954     */
1955
1956    /**
1957     * @defgroup Engine Elementary Engine
1958     *
1959     * These are functions setting and querying which rendering engine
1960     * Elementary will use for drawing its windows' pixels.
1961     *
1962     * The following are the available engines:
1963     * @li "software_x11"
1964     * @li "fb"
1965     * @li "directfb"
1966     * @li "software_16_x11"
1967     * @li "software_8_x11"
1968     * @li "xrender_x11"
1969     * @li "opengl_x11"
1970     * @li "software_gdi"
1971     * @li "software_16_wince_gdi"
1972     * @li "sdl"
1973     * @li "software_16_sdl"
1974     * @li "opengl_sdl"
1975     * @li "buffer"
1976     * @li "ews"
1977     *
1978     * @{
1979     */
1980
1981    /**
1982     * @brief Get Elementary's rendering engine in use.
1983     *
1984     * @return The rendering engine's name
1985     * @note there's no need to free the returned string, here.
1986     *
1987     * This gets the global rendering engine that is applied to all Elementary
1988     * applications.
1989     *
1990     * @see elm_engine_set()
1991     */
1992    EAPI const char  *elm_engine_current_get(void);
1993
1994    /**
1995     * @brief Set Elementary's rendering engine for use.
1996     *
1997     * @param engine The rendering engine's name
1998     *
1999     * This sets global rendering engine that is applied to all Elementary
2000     * applications. Note that it will take effect only to Elementary windows
2001     * created after this is called.
2002     *
2003     * @see elm_win_add()
2004     */
2005    EAPI void         elm_engine_set(const char *engine);
2006
2007    /**
2008     * @}
2009     */
2010
2011    /**
2012     * @defgroup Fonts Elementary Fonts
2013     *
2014     * These are functions dealing with font rendering, selection and the
2015     * like for Elementary applications. One might fetch which system
2016     * fonts are there to use and set custom fonts for individual classes
2017     * of UI items containing text (text classes).
2018     *
2019     * @{
2020     */
2021
2022   typedef struct _Elm_Text_Class
2023     {
2024        const char *name;
2025        const char *desc;
2026     } Elm_Text_Class;
2027
2028   typedef struct _Elm_Font_Overlay
2029     {
2030        const char     *text_class;
2031        const char     *font;
2032        Evas_Font_Size  size;
2033     } Elm_Font_Overlay;
2034
2035   typedef struct _Elm_Font_Properties
2036     {
2037        const char *name;
2038        Eina_List  *styles;
2039     } Elm_Font_Properties;
2040
2041    /**
2042     * Get Elementary's list of supported text classes.
2043     *
2044     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2045     * @ingroup Fonts
2046     *
2047     * Release the list with elm_text_classes_list_free().
2048     */
2049    EAPI const Eina_List     *elm_text_classes_list_get(void);
2050
2051    /**
2052     * Free Elementary's list of supported text classes.
2053     *
2054     * @ingroup Fonts
2055     *
2056     * @see elm_text_classes_list_get().
2057     */
2058    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2059
2060    /**
2061     * Get Elementary's list of font overlays, set with
2062     * elm_font_overlay_set().
2063     *
2064     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2065     * data.
2066     *
2067     * @ingroup Fonts
2068     *
2069     * For each text class, one can set a <b>font overlay</b> for it,
2070     * overriding the default font properties for that class coming from
2071     * the theme in use. There is no need to free this list.
2072     *
2073     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2074     */
2075    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2076
2077    /**
2078     * Set a font overlay for a given Elementary text class.
2079     *
2080     * @param text_class Text class name
2081     * @param font Font name and style string
2082     * @param size Font size
2083     *
2084     * @ingroup Fonts
2085     *
2086     * @p font has to be in the format returned by
2087     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2088     * and elm_font_overlay_unset().
2089     */
2090    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2091
2092    /**
2093     * Unset a font overlay for a given Elementary text class.
2094     *
2095     * @param text_class Text class name
2096     *
2097     * @ingroup Fonts
2098     *
2099     * This will bring back text elements belonging to text class
2100     * @p text_class back to their default font settings.
2101     */
2102    EAPI void                 elm_font_overlay_unset(const char *text_class);
2103
2104    /**
2105     * Apply the changes made with elm_font_overlay_set() and
2106     * elm_font_overlay_unset() on the current Elementary window.
2107     *
2108     * @ingroup Fonts
2109     *
2110     * This applies all font overlays set to all objects in the UI.
2111     */
2112    EAPI void                 elm_font_overlay_apply(void);
2113
2114    /**
2115     * Apply the changes made with elm_font_overlay_set() and
2116     * elm_font_overlay_unset() on all Elementary application windows.
2117     *
2118     * @ingroup Fonts
2119     *
2120     * This applies all font overlays set to all objects in the UI.
2121     */
2122    EAPI void                 elm_font_overlay_all_apply(void);
2123
2124    /**
2125     * Translate a font (family) name string in fontconfig's font names
2126     * syntax into an @c Elm_Font_Properties struct.
2127     *
2128     * @param font The font name and styles string
2129     * @return the font properties struct
2130     *
2131     * @ingroup Fonts
2132     *
2133     * @note The reverse translation can be achived with
2134     * elm_font_fontconfig_name_get(), for one style only (single font
2135     * instance, not family).
2136     */
2137    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2138
2139    /**
2140     * Free font properties return by elm_font_properties_get().
2141     *
2142     * @param efp the font properties struct
2143     *
2144     * @ingroup Fonts
2145     */
2146    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2147
2148    /**
2149     * Translate a font name, bound to a style, into fontconfig's font names
2150     * syntax.
2151     *
2152     * @param name The font (family) name
2153     * @param style The given style (may be @c NULL)
2154     *
2155     * @return the font name and style string
2156     *
2157     * @ingroup Fonts
2158     *
2159     * @note The reverse translation can be achived with
2160     * elm_font_properties_get(), for one style only (single font
2161     * instance, not family).
2162     */
2163    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2164
2165    /**
2166     * Free the font string return by elm_font_fontconfig_name_get().
2167     *
2168     * @param efp the font properties struct
2169     *
2170     * @ingroup Fonts
2171     */
2172    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2173
2174    /**
2175     * Create a font hash table of available system fonts.
2176     *
2177     * One must call it with @p list being the return value of
2178     * evas_font_available_list(). The hash will be indexed by font
2179     * (family) names, being its values @c Elm_Font_Properties blobs.
2180     *
2181     * @param list The list of available system fonts, as returned by
2182     * evas_font_available_list().
2183     * @return the font hash.
2184     *
2185     * @ingroup Fonts
2186     *
2187     * @note The user is supposed to get it populated at least with 3
2188     * default font families (Sans, Serif, Monospace), which should be
2189     * present on most systems.
2190     */
2191    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2192
2193    /**
2194     * Free the hash return by elm_font_available_hash_add().
2195     *
2196     * @param hash the hash to be freed.
2197     *
2198     * @ingroup Fonts
2199     */
2200    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2201
2202    /**
2203     * @}
2204     */
2205
2206    /**
2207     * @defgroup Fingers Fingers
2208     *
2209     * Elementary is designed to be finger-friendly for touchscreens,
2210     * and so in addition to scaling for display resolution, it can
2211     * also scale based on finger "resolution" (or size). You can then
2212     * customize the granularity of the areas meant to receive clicks
2213     * on touchscreens.
2214     *
2215     * Different profiles may have pre-set values for finger sizes.
2216     *
2217     * @ref general_functions_example_page "This" example contemplates
2218     * some of these functions.
2219     *
2220     * @{
2221     */
2222
2223    /**
2224     * Get the configured "finger size"
2225     *
2226     * @return The finger size
2227     *
2228     * This gets the globally configured finger size, <b>in pixels</b>
2229     *
2230     * @ingroup Fingers
2231     */
2232    EAPI Evas_Coord       elm_finger_size_get(void);
2233
2234    /**
2235     * Set the configured finger size
2236     *
2237     * This sets the globally configured finger size in pixels
2238     *
2239     * @param size The finger size
2240     * @ingroup Fingers
2241     */
2242    EAPI void             elm_finger_size_set(Evas_Coord size);
2243
2244    /**
2245     * Set the configured finger size for all applications on the display
2246     *
2247     * This sets the globally configured finger size in pixels for all
2248     * applications on the display
2249     *
2250     * @param size The finger size
2251     * @ingroup Fingers
2252     */
2253    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2254
2255    /**
2256     * @}
2257     */
2258
2259    /**
2260     * @defgroup Focus Focus
2261     *
2262     * An Elementary application has, at all times, one (and only one)
2263     * @b focused object. This is what determines where the input
2264     * events go to within the application's window. Also, focused
2265     * objects can be decorated differently, in order to signal to the
2266     * user where the input is, at a given moment.
2267     *
2268     * Elementary applications also have the concept of <b>focus
2269     * chain</b>: one can cycle through all the windows' focusable
2270     * objects by input (tab key) or programmatically. The default
2271     * focus chain for an application is the one define by the order in
2272     * which the widgets where added in code. One will cycle through
2273     * top level widgets, and, for each one containg sub-objects, cycle
2274     * through them all, before returning to the level
2275     * above. Elementary also allows one to set @b custom focus chains
2276     * for their applications.
2277     *
2278     * Besides the focused decoration a widget may exhibit, when it
2279     * gets focus, Elementary has a @b global focus highlight object
2280     * that can be enabled for a window. If one chooses to do so, this
2281     * extra highlight effect will surround the current focused object,
2282     * too.
2283     *
2284     * @note Some Elementary widgets are @b unfocusable, after
2285     * creation, by their very nature: they are not meant to be
2286     * interacted with input events, but are there just for visual
2287     * purposes.
2288     *
2289     * @ref general_functions_example_page "This" example contemplates
2290     * some of these functions.
2291     */
2292
2293    /**
2294     * Get the enable status of the focus highlight
2295     *
2296     * This gets whether the highlight on focused objects is enabled or not
2297     * @ingroup Focus
2298     */
2299    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2300
2301    /**
2302     * Set the enable status of the focus highlight
2303     *
2304     * Set whether to show or not the highlight on focused objects
2305     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2306     * @ingroup Focus
2307     */
2308    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2309
2310    /**
2311     * Get the enable status of the highlight animation
2312     *
2313     * Get whether the focus highlight, if enabled, will animate its switch from
2314     * one object to the next
2315     * @ingroup Focus
2316     */
2317    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2318
2319    /**
2320     * Set the enable status of the highlight animation
2321     *
2322     * Set whether the focus highlight, if enabled, will animate its switch from
2323     * one object to the next
2324     * @param animate Enable animation if EINA_TRUE, disable otherwise
2325     * @ingroup Focus
2326     */
2327    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2328
2329    /**
2330     * Get the whether an Elementary object has the focus or not.
2331     *
2332     * @param obj The Elementary object to get the information from
2333     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2334     *            not (and on errors).
2335     *
2336     * @see elm_object_focus_set()
2337     *
2338     * @ingroup Focus
2339     */
2340    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2341
2342    /**
2343     * Set/unset focus to a given Elementary object.
2344     *
2345     * @param obj The Elementary object to operate on.
2346     * @param enable @c EINA_TRUE Set focus to a given object,
2347     *               @c EINA_FALSE Unset focus to a given object.
2348     *
2349     * @note When you set focus to this object, if it can handle focus, will
2350     * take the focus away from the one who had it previously and will, for
2351     * now on, be the one receiving input events. Unsetting focus will remove
2352     * the focus from @p obj, passing it back to the previous element in the
2353     * focus chain list.
2354     *
2355     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2356     *
2357     * @ingroup Focus
2358     */
2359    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2360
2361    /**
2362     * Make a given Elementary object the focused one.
2363     *
2364     * @param obj The Elementary object to make focused.
2365     *
2366     * @note This object, if it can handle focus, will take the focus
2367     * away from the one who had it previously and will, for now on, be
2368     * the one receiving input events.
2369     *
2370     * @see elm_object_focus_get()
2371     * @deprecated use elm_object_focus_set() instead.
2372     *
2373     * @ingroup Focus
2374     */
2375    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2376
2377    /**
2378     * Remove the focus from an Elementary object
2379     *
2380     * @param obj The Elementary to take focus from
2381     *
2382     * This removes the focus from @p obj, passing it back to the
2383     * previous element in the focus chain list.
2384     *
2385     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2386     * @deprecated use elm_object_focus_set() instead.
2387     *
2388     * @ingroup Focus
2389     */
2390    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2391
2392    /**
2393     * Set the ability for an Element object to be focused
2394     *
2395     * @param obj The Elementary object to operate on
2396     * @param enable @c EINA_TRUE if the object can be focused, @c
2397     *        EINA_FALSE if not (and on errors)
2398     *
2399     * This sets whether the object @p obj is able to take focus or
2400     * not. Unfocusable objects do nothing when programmatically
2401     * focused, being the nearest focusable parent object the one
2402     * really getting focus. Also, when they receive mouse input, they
2403     * will get the event, but not take away the focus from where it
2404     * was previously.
2405     *
2406     * @ingroup Focus
2407     */
2408    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2409
2410    /**
2411     * Get whether an Elementary object is focusable or not
2412     *
2413     * @param obj The Elementary object to operate on
2414     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2415     *             EINA_FALSE if not (and on errors)
2416     *
2417     * @note Objects which are meant to be interacted with by input
2418     * events are created able to be focused, by default. All the
2419     * others are not.
2420     *
2421     * @ingroup Focus
2422     */
2423    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2424
2425    /**
2426     * Set custom focus chain.
2427     *
2428     * This function overwrites any previous custom focus chain within
2429     * the list of objects. The previous list will be deleted and this list
2430     * will be managed by elementary. After it is set, don't modify it.
2431     *
2432     * @note On focus cycle, only will be evaluated children of this container.
2433     *
2434     * @param obj The container object
2435     * @param objs Chain of objects to pass focus
2436     * @ingroup Focus
2437     */
2438    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2439
2440    /**
2441     * Unset a custom focus chain on a given Elementary widget
2442     *
2443     * @param obj The container object to remove focus chain from
2444     *
2445     * Any focus chain previously set on @p obj (for its child objects)
2446     * is removed entirely after this call.
2447     *
2448     * @ingroup Focus
2449     */
2450    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2451
2452    /**
2453     * Get custom focus chain
2454     *
2455     * @param obj The container object
2456     * @ingroup Focus
2457     */
2458    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2459
2460    /**
2461     * Append object to custom focus chain.
2462     *
2463     * @note If relative_child equal to NULL or not in custom chain, the object
2464     * will be added in end.
2465     *
2466     * @note On focus cycle, only will be evaluated children of this container.
2467     *
2468     * @param obj The container object
2469     * @param child The child to be added in custom chain
2470     * @param relative_child The relative object to position the child
2471     * @ingroup Focus
2472     */
2473    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2474
2475    /**
2476     * Prepend object to custom focus chain.
2477     *
2478     * @note If relative_child equal to NULL or not in custom chain, the object
2479     * will be added in begin.
2480     *
2481     * @note On focus cycle, only will be evaluated children of this container.
2482     *
2483     * @param obj The container object
2484     * @param child The child to be added in custom chain
2485     * @param relative_child The relative object to position the child
2486     * @ingroup Focus
2487     */
2488    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2489
2490    /**
2491     * Give focus to next object in object tree.
2492     *
2493     * Give focus to next object in focus chain of one object sub-tree.
2494     * If the last object of chain already have focus, the focus will go to the
2495     * first object of chain.
2496     *
2497     * @param obj The object root of sub-tree
2498     * @param dir Direction to cycle the focus
2499     *
2500     * @ingroup Focus
2501     */
2502    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2503
2504    /**
2505     * Give focus to near object in one direction.
2506     *
2507     * Give focus to near object in direction of one object.
2508     * If none focusable object in given direction, the focus will not change.
2509     *
2510     * @param obj The reference object
2511     * @param x Horizontal component of direction to focus
2512     * @param y Vertical component of direction to focus
2513     *
2514     * @ingroup Focus
2515     */
2516    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2517
2518    /**
2519     * Make the elementary object and its children to be unfocusable
2520     * (or focusable).
2521     *
2522     * @param obj The Elementary object to operate on
2523     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2524     *        @c EINA_FALSE for focusable.
2525     *
2526     * This sets whether the object @p obj and its children objects
2527     * are able to take focus or not. If the tree is set as unfocusable,
2528     * newest focused object which is not in this tree will get focus.
2529     * This API can be helpful for an object to be deleted.
2530     * When an object will be deleted soon, it and its children may not
2531     * want to get focus (by focus reverting or by other focus controls).
2532     * Then, just use this API before deleting.
2533     *
2534     * @see elm_object_tree_unfocusable_get()
2535     *
2536     * @ingroup Focus
2537     */
2538    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2539
2540    /**
2541     * Get whether an Elementary object and its children are unfocusable or not.
2542     *
2543     * @param obj The Elementary object to get the information from
2544     * @return @c EINA_TRUE, if the tree is unfocussable,
2545     *         @c EINA_FALSE if not (and on errors).
2546     *
2547     * @see elm_object_tree_unfocusable_set()
2548     *
2549     * @ingroup Focus
2550     */
2551    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2552
2553    /**
2554     * @defgroup Scrolling Scrolling
2555     *
2556     * These are functions setting how scrollable views in Elementary
2557     * widgets should behave on user interaction.
2558     *
2559     * @{
2560     */
2561
2562    /**
2563     * Get whether scrollers should bounce when they reach their
2564     * viewport's edge during a scroll.
2565     *
2566     * @return the thumb scroll bouncing state
2567     *
2568     * This is the default behavior for touch screens, in general.
2569     * @ingroup Scrolling
2570     */
2571    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2572
2573    /**
2574     * Set whether scrollers should bounce when they reach their
2575     * viewport's edge during a scroll.
2576     *
2577     * @param enabled the thumb scroll bouncing state
2578     *
2579     * @see elm_thumbscroll_bounce_enabled_get()
2580     * @ingroup Scrolling
2581     */
2582    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2583
2584    /**
2585     * Set whether scrollers should bounce when they reach their
2586     * viewport's edge during a scroll, for all Elementary application
2587     * windows.
2588     *
2589     * @param enabled the thumb scroll bouncing state
2590     *
2591     * @see elm_thumbscroll_bounce_enabled_get()
2592     * @ingroup Scrolling
2593     */
2594    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2595
2596    /**
2597     * Get the amount of inertia a scroller will impose at bounce
2598     * animations.
2599     *
2600     * @return the thumb scroll bounce friction
2601     *
2602     * @ingroup Scrolling
2603     */
2604    EAPI double           elm_scroll_bounce_friction_get(void);
2605
2606    /**
2607     * Set the amount of inertia a scroller will impose at bounce
2608     * animations.
2609     *
2610     * @param friction the thumb scroll bounce friction
2611     *
2612     * @see elm_thumbscroll_bounce_friction_get()
2613     * @ingroup Scrolling
2614     */
2615    EAPI void             elm_scroll_bounce_friction_set(double friction);
2616
2617    /**
2618     * Set the amount of inertia a scroller will impose at bounce
2619     * animations, for all Elementary application windows.
2620     *
2621     * @param friction the thumb scroll bounce friction
2622     *
2623     * @see elm_thumbscroll_bounce_friction_get()
2624     * @ingroup Scrolling
2625     */
2626    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2627
2628    /**
2629     * Get the amount of inertia a <b>paged</b> scroller will impose at
2630     * page fitting animations.
2631     *
2632     * @return the page scroll friction
2633     *
2634     * @ingroup Scrolling
2635     */
2636    EAPI double           elm_scroll_page_scroll_friction_get(void);
2637
2638    /**
2639     * Set the amount of inertia a <b>paged</b> scroller will impose at
2640     * page fitting animations.
2641     *
2642     * @param friction the page scroll friction
2643     *
2644     * @see elm_thumbscroll_page_scroll_friction_get()
2645     * @ingroup Scrolling
2646     */
2647    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2648
2649    /**
2650     * Set the amount of inertia a <b>paged</b> scroller will impose at
2651     * page fitting animations, for all Elementary application windows.
2652     *
2653     * @param friction the page scroll friction
2654     *
2655     * @see elm_thumbscroll_page_scroll_friction_get()
2656     * @ingroup Scrolling
2657     */
2658    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2659
2660    /**
2661     * Get the amount of inertia a scroller will impose at region bring
2662     * animations.
2663     *
2664     * @return the bring in scroll friction
2665     *
2666     * @ingroup Scrolling
2667     */
2668    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2669
2670    /**
2671     * Set the amount of inertia a scroller will impose at region bring
2672     * animations.
2673     *
2674     * @param friction the bring in scroll friction
2675     *
2676     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2677     * @ingroup Scrolling
2678     */
2679    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2680
2681    /**
2682     * Set the amount of inertia a scroller will impose at region bring
2683     * animations, for all Elementary application windows.
2684     *
2685     * @param friction the bring in scroll friction
2686     *
2687     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2688     * @ingroup Scrolling
2689     */
2690    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2691
2692    /**
2693     * Get the amount of inertia scrollers will impose at animations
2694     * triggered by Elementary widgets' zooming API.
2695     *
2696     * @return the zoom friction
2697     *
2698     * @ingroup Scrolling
2699     */
2700    EAPI double           elm_scroll_zoom_friction_get(void);
2701
2702    /**
2703     * Set the amount of inertia scrollers will impose at animations
2704     * triggered by Elementary widgets' zooming API.
2705     *
2706     * @param friction the zoom friction
2707     *
2708     * @see elm_thumbscroll_zoom_friction_get()
2709     * @ingroup Scrolling
2710     */
2711    EAPI void             elm_scroll_zoom_friction_set(double friction);
2712
2713    /**
2714     * Set the amount of inertia scrollers will impose at animations
2715     * triggered by Elementary widgets' zooming API, for all Elementary
2716     * application windows.
2717     *
2718     * @param friction the zoom friction
2719     *
2720     * @see elm_thumbscroll_zoom_friction_get()
2721     * @ingroup Scrolling
2722     */
2723    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2724
2725    /**
2726     * Get whether scrollers should be draggable from any point in their
2727     * views.
2728     *
2729     * @return the thumb scroll state
2730     *
2731     * @note This is the default behavior for touch screens, in general.
2732     * @note All other functions namespaced with "thumbscroll" will only
2733     *       have effect if this mode is enabled.
2734     *
2735     * @ingroup Scrolling
2736     */
2737    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2738
2739    /**
2740     * Set whether scrollers should be draggable from any point in their
2741     * views.
2742     *
2743     * @param enabled the thumb scroll state
2744     *
2745     * @see elm_thumbscroll_enabled_get()
2746     * @ingroup Scrolling
2747     */
2748    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2749
2750    /**
2751     * Set whether scrollers should be draggable from any point in their
2752     * views, for all Elementary application windows.
2753     *
2754     * @param enabled the thumb scroll state
2755     *
2756     * @see elm_thumbscroll_enabled_get()
2757     * @ingroup Scrolling
2758     */
2759    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2760
2761    /**
2762     * Get the number of pixels one should travel while dragging a
2763     * scroller's view to actually trigger scrolling.
2764     *
2765     * @return the thumb scroll threshould
2766     *
2767     * One would use higher values for touch screens, in general, because
2768     * of their inherent imprecision.
2769     * @ingroup Scrolling
2770     */
2771    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2772
2773    /**
2774     * Set the number of pixels one should travel while dragging a
2775     * scroller's view to actually trigger scrolling.
2776     *
2777     * @param threshold the thumb scroll threshould
2778     *
2779     * @see elm_thumbscroll_threshould_get()
2780     * @ingroup Scrolling
2781     */
2782    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2783
2784    /**
2785     * Set the number of pixels one should travel while dragging a
2786     * scroller's view to actually trigger scrolling, for all Elementary
2787     * application windows.
2788     *
2789     * @param threshold the thumb scroll threshould
2790     *
2791     * @see elm_thumbscroll_threshould_get()
2792     * @ingroup Scrolling
2793     */
2794    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2795
2796    /**
2797     * Get the minimum speed of mouse cursor movement which will trigger
2798     * list self scrolling animation after a mouse up event
2799     * (pixels/second).
2800     *
2801     * @return the thumb scroll momentum threshould
2802     *
2803     * @ingroup Scrolling
2804     */
2805    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2806
2807    /**
2808     * Set the minimum speed of mouse cursor movement which will trigger
2809     * list self scrolling animation after a mouse up event
2810     * (pixels/second).
2811     *
2812     * @param threshold the thumb scroll momentum threshould
2813     *
2814     * @see elm_thumbscroll_momentum_threshould_get()
2815     * @ingroup Scrolling
2816     */
2817    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2818
2819    /**
2820     * Set the minimum speed of mouse cursor movement which will trigger
2821     * list self scrolling animation after a mouse up event
2822     * (pixels/second), for all Elementary application windows.
2823     *
2824     * @param threshold the thumb scroll momentum threshould
2825     *
2826     * @see elm_thumbscroll_momentum_threshould_get()
2827     * @ingroup Scrolling
2828     */
2829    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2830
2831    /**
2832     * Get the amount of inertia a scroller will impose at self scrolling
2833     * animations.
2834     *
2835     * @return the thumb scroll friction
2836     *
2837     * @ingroup Scrolling
2838     */
2839    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2840
2841    /**
2842     * Set the amount of inertia a scroller will impose at self scrolling
2843     * animations.
2844     *
2845     * @param friction the thumb scroll friction
2846     *
2847     * @see elm_thumbscroll_friction_get()
2848     * @ingroup Scrolling
2849     */
2850    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2851
2852    /**
2853     * Set the amount of inertia a scroller will impose at self scrolling
2854     * animations, for all Elementary application windows.
2855     *
2856     * @param friction the thumb scroll friction
2857     *
2858     * @see elm_thumbscroll_friction_get()
2859     * @ingroup Scrolling
2860     */
2861    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2862
2863    /**
2864     * Get the amount of lag between your actual mouse cursor dragging
2865     * movement and a scroller's view movement itself, while pushing it
2866     * into bounce state manually.
2867     *
2868     * @return the thumb scroll border friction
2869     *
2870     * @ingroup Scrolling
2871     */
2872    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2873
2874    /**
2875     * Set the amount of lag between your actual mouse cursor dragging
2876     * movement and a scroller's view movement itself, while pushing it
2877     * into bounce state manually.
2878     *
2879     * @param friction the thumb scroll border friction. @c 0.0 for
2880     *        perfect synchrony between two movements, @c 1.0 for maximum
2881     *        lag.
2882     *
2883     * @see elm_thumbscroll_border_friction_get()
2884     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2885     *
2886     * @ingroup Scrolling
2887     */
2888    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2889
2890    /**
2891     * Set the amount of lag between your actual mouse cursor dragging
2892     * movement and a scroller's view movement itself, while pushing it
2893     * into bounce state manually, for all Elementary application windows.
2894     *
2895     * @param friction the thumb scroll border friction. @c 0.0 for
2896     *        perfect synchrony between two movements, @c 1.0 for maximum
2897     *        lag.
2898     *
2899     * @see elm_thumbscroll_border_friction_get()
2900     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2901     *
2902     * @ingroup Scrolling
2903     */
2904    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2905
2906    /**
2907     * Get the sensitivity amount which is be multiplied by the length of
2908     * mouse dragging.
2909     *
2910     * @return the thumb scroll sensitivity friction
2911     *
2912     * @ingroup Scrolling
2913     */
2914    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2915
2916    /**
2917     * Set the sensitivity amount which is be multiplied by the length of
2918     * mouse dragging.
2919     *
2920     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2921     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2922     *        is proper.
2923     *
2924     * @see elm_thumbscroll_sensitivity_friction_get()
2925     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2926     *
2927     * @ingroup Scrolling
2928     */
2929    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2930
2931    /**
2932     * Set the sensitivity amount which is be multiplied by the length of
2933     * mouse dragging, for all Elementary application windows.
2934     *
2935     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2936     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2937     *        is proper.
2938     *
2939     * @see elm_thumbscroll_sensitivity_friction_get()
2940     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2941     *
2942     * @ingroup Scrolling
2943     */
2944    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2945
2946    /**
2947     * @}
2948     */
2949
2950    /**
2951     * @defgroup Scrollhints Scrollhints
2952     *
2953     * Objects when inside a scroller can scroll, but this may not always be
2954     * desirable in certain situations. This allows an object to hint to itself
2955     * and parents to "not scroll" in one of 2 ways. If any child object of a
2956     * scroller has pushed a scroll freeze or hold then it affects all parent
2957     * scrollers until all children have released them.
2958     *
2959     * 1. To hold on scrolling. This means just flicking and dragging may no
2960     * longer scroll, but pressing/dragging near an edge of the scroller will
2961     * still scroll. This is automatically used by the entry object when
2962     * selecting text.
2963     *
2964     * 2. To totally freeze scrolling. This means it stops. until
2965     * popped/released.
2966     *
2967     * @{
2968     */
2969
2970    /**
2971     * Push the scroll hold by 1
2972     *
2973     * This increments the scroll hold count by one. If it is more than 0 it will
2974     * take effect on the parents of the indicated object.
2975     *
2976     * @param obj The object
2977     * @ingroup Scrollhints
2978     */
2979    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2980
2981    /**
2982     * Pop the scroll hold by 1
2983     *
2984     * This decrements the scroll hold count by one. If it is more than 0 it will
2985     * take effect on the parents of the indicated object.
2986     *
2987     * @param obj The object
2988     * @ingroup Scrollhints
2989     */
2990    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2991
2992    /**
2993     * Push the scroll freeze by 1
2994     *
2995     * This increments the scroll freeze count by one. If it is more
2996     * than 0 it will take effect on the parents of the indicated
2997     * object.
2998     *
2999     * @param obj The object
3000     * @ingroup Scrollhints
3001     */
3002    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3003
3004    /**
3005     * Pop the scroll freeze by 1
3006     *
3007     * This decrements the scroll freeze count by one. If it is more
3008     * than 0 it will take effect on the parents of the indicated
3009     * object.
3010     *
3011     * @param obj The object
3012     * @ingroup Scrollhints
3013     */
3014    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3015
3016    /**
3017     * Lock the scrolling of the given widget (and thus all parents)
3018     *
3019     * This locks the given object from scrolling in the X axis (and implicitly
3020     * also locks all parent scrollers too from doing the same).
3021     *
3022     * @param obj The object
3023     * @param lock The lock state (1 == locked, 0 == unlocked)
3024     * @ingroup Scrollhints
3025     */
3026    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3027
3028    /**
3029     * Lock the scrolling of the given widget (and thus all parents)
3030     *
3031     * This locks the given object from scrolling in the Y axis (and implicitly
3032     * also locks all parent scrollers too from doing the same).
3033     *
3034     * @param obj The object
3035     * @param lock The lock state (1 == locked, 0 == unlocked)
3036     * @ingroup Scrollhints
3037     */
3038    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3039
3040    /**
3041     * Get the scrolling lock of the given widget
3042     *
3043     * This gets the lock for X axis scrolling.
3044     *
3045     * @param obj The object
3046     * @ingroup Scrollhints
3047     */
3048    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3049
3050    /**
3051     * Get the scrolling lock of the given widget
3052     *
3053     * This gets the lock for X axis scrolling.
3054     *
3055     * @param obj The object
3056     * @ingroup Scrollhints
3057     */
3058    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3059
3060    /**
3061     * @}
3062     */
3063
3064    /**
3065     * Send a signal to the widget edje object.
3066     *
3067     * This function sends a signal to the edje object of the obj. An
3068     * edje program can respond to a signal by specifying matching
3069     * 'signal' and 'source' fields.
3070     *
3071     * @param obj The object
3072     * @param emission The signal's name.
3073     * @param source The signal's source.
3074     * @ingroup General
3075     */
3076    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3077
3078    /**
3079     * Add a callback for a signal emitted by widget edje object.
3080     *
3081     * This function connects a callback function to a signal emitted by the
3082     * edje object of the obj.
3083     * Globs can occur in either the emission or source name.
3084     *
3085     * @param obj The object
3086     * @param emission The signal's name.
3087     * @param source The signal's source.
3088     * @param func The callback function to be executed when the signal is
3089     * emitted.
3090     * @param data A pointer to data to pass in to the callback function.
3091     * @ingroup General
3092     */
3093    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);
3094
3095    /**
3096     * Remove a signal-triggered callback from a widget edje object.
3097     *
3098     * This function removes a callback, previoulsy attached to a
3099     * signal emitted by the edje object of the obj.  The parameters
3100     * emission, source and func must match exactly those passed to a
3101     * previous call to elm_object_signal_callback_add(). The data
3102     * pointer that was passed to this call will be returned.
3103     *
3104     * @param obj The object
3105     * @param emission The signal's name.
3106     * @param source The signal's source.
3107     * @param func The callback function to be executed when the signal is
3108     * emitted.
3109     * @return The data pointer
3110     * @ingroup General
3111     */
3112    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);
3113
3114    /**
3115     * Add a callback for input events (key up, key down, mouse wheel)
3116     * on a given Elementary widget
3117     *
3118     * @param obj The widget to add an event callback on
3119     * @param func The callback function to be executed when the event
3120     * happens
3121     * @param data Data to pass in to @p func
3122     *
3123     * Every widget in an Elementary interface set to receive focus,
3124     * with elm_object_focus_allow_set(), will propagate @b all of its
3125     * key up, key down and mouse wheel input events up to its parent
3126     * object, and so on. All of the focusable ones in this chain which
3127     * had an event callback set, with this call, will be able to treat
3128     * those events. There are two ways of making the propagation of
3129     * these event upwards in the tree of widgets to @b cease:
3130     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3131     *   the event was @b not processed, so the propagation will go on.
3132     * - The @c event_info pointer passed to @p func will contain the
3133     *   event's structure and, if you OR its @c event_flags inner
3134     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3135     *   one has already handled it, thus killing the event's
3136     *   propagation, too.
3137     *
3138     * @note Your event callback will be issued on those events taking
3139     * place only if no other child widget of @obj has consumed the
3140     * event already.
3141     *
3142     * @note Not to be confused with @c
3143     * evas_object_event_callback_add(), which will add event callbacks
3144     * per type on general Evas objects (no event propagation
3145     * infrastructure taken in account).
3146     *
3147     * @note Not to be confused with @c
3148     * elm_object_signal_callback_add(), which will add callbacks to @b
3149     * signals coming from a widget's theme, not input events.
3150     *
3151     * @note Not to be confused with @c
3152     * edje_object_signal_callback_add(), which does the same as
3153     * elm_object_signal_callback_add(), but directly on an Edje
3154     * object.
3155     *
3156     * @note Not to be confused with @c
3157     * evas_object_smart_callback_add(), which adds callbacks to smart
3158     * objects' <b>smart events</b>, and not input events.
3159     *
3160     * @see elm_object_event_callback_del()
3161     *
3162     * @ingroup General
3163     */
3164    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3165
3166    /**
3167     * Remove an event callback from a widget.
3168     *
3169     * This function removes a callback, previoulsy attached to event emission
3170     * by the @p obj.
3171     * The parameters func and data must match exactly those passed to
3172     * a previous call to elm_object_event_callback_add(). The data pointer that
3173     * was passed to this call will be returned.
3174     *
3175     * @param obj The object
3176     * @param func The callback function to be executed when the event is
3177     * emitted.
3178     * @param data Data to pass in to the callback function.
3179     * @return The data pointer
3180     * @ingroup General
3181     */
3182    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3183
3184    /**
3185     * Adjust size of an element for finger usage.
3186     *
3187     * @param times_w How many fingers should fit horizontally
3188     * @param w Pointer to the width size to adjust
3189     * @param times_h How many fingers should fit vertically
3190     * @param h Pointer to the height size to adjust
3191     *
3192     * This takes width and height sizes (in pixels) as input and a
3193     * size multiple (which is how many fingers you want to place
3194     * within the area, being "finger" the size set by
3195     * elm_finger_size_set()), and adjusts the size to be large enough
3196     * to accommodate the resulting size -- if it doesn't already
3197     * accommodate it. On return the @p w and @p h sizes pointed to by
3198     * these parameters will be modified, on those conditions.
3199     *
3200     * @note This is kind of a low level Elementary call, most useful
3201     * on size evaluation times for widgets. An external user wouldn't
3202     * be calling, most of the time.
3203     *
3204     * @ingroup Fingers
3205     */
3206    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3207
3208    /**
3209     * Get the duration for occuring long press event.
3210     *
3211     * @return Timeout for long press event
3212     * @ingroup Longpress
3213     */
3214    EAPI double           elm_longpress_timeout_get(void);
3215
3216    /**
3217     * Set the duration for occuring long press event.
3218     *
3219     * @param lonpress_timeout Timeout for long press event
3220     * @ingroup Longpress
3221     */
3222    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3223
3224    /**
3225     * @defgroup Debug Debug
3226     * don't use it unless you are sure
3227     *
3228     * @{
3229     */
3230
3231    /**
3232     * Print Tree object hierarchy in stdout
3233     *
3234     * @param obj The root object
3235     * @ingroup Debug
3236     */
3237    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3238
3239    /**
3240     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3241     *
3242     * @param obj The root object
3243     * @param file The path of output file
3244     * @ingroup Debug
3245     */
3246    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3247
3248    /**
3249     * @}
3250     */
3251
3252    /**
3253     * @defgroup Theme Theme
3254     *
3255     * Elementary uses Edje to theme its widgets, naturally. But for the most
3256     * part this is hidden behind a simpler interface that lets the user set
3257     * extensions and choose the style of widgets in a much easier way.
3258     *
3259     * Instead of thinking in terms of paths to Edje files and their groups
3260     * each time you want to change the appearance of a widget, Elementary
3261     * works so you can add any theme file with extensions or replace the
3262     * main theme at one point in the application, and then just set the style
3263     * of widgets with elm_object_style_set() and related functions. Elementary
3264     * will then look in its list of themes for a matching group and apply it,
3265     * and when the theme changes midway through the application, all widgets
3266     * will be updated accordingly.
3267     *
3268     * There are three concepts you need to know to understand how Elementary
3269     * theming works: default theme, extensions and overlays.
3270     *
3271     * Default theme, obviously enough, is the one that provides the default
3272     * look of all widgets. End users can change the theme used by Elementary
3273     * by setting the @c ELM_THEME environment variable before running an
3274     * application, or globally for all programs using the @c elementary_config
3275     * utility. Applications can change the default theme using elm_theme_set(),
3276     * but this can go against the user wishes, so it's not an adviced practice.
3277     *
3278     * Ideally, applications should find everything they need in the already
3279     * provided theme, but there may be occasions when that's not enough and
3280     * custom styles are required to correctly express the idea. For this
3281     * cases, Elementary has extensions.
3282     *
3283     * Extensions allow the application developer to write styles of its own
3284     * to apply to some widgets. This requires knowledge of how each widget
3285     * is themed, as extensions will always replace the entire group used by
3286     * the widget, so important signals and parts need to be there for the
3287     * object to behave properly (see documentation of Edje for details).
3288     * Once the theme for the extension is done, the application needs to add
3289     * it to the list of themes Elementary will look into, using
3290     * elm_theme_extension_add(), and set the style of the desired widgets as
3291     * he would normally with elm_object_style_set().
3292     *
3293     * Overlays, on the other hand, can replace the look of all widgets by
3294     * overriding the default style. Like extensions, it's up to the application
3295     * developer to write the theme for the widgets it wants, the difference
3296     * being that when looking for the theme, Elementary will check first the
3297     * list of overlays, then the set theme and lastly the list of extensions,
3298     * so with overlays it's possible to replace the default view and every
3299     * widget will be affected. This is very much alike to setting the whole
3300     * theme for the application and will probably clash with the end user
3301     * options, not to mention the risk of ending up with not matching styles
3302     * across the program. Unless there's a very special reason to use them,
3303     * overlays should be avoided for the resons exposed before.
3304     *
3305     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3306     * keeps one default internally and every function that receives one of
3307     * these can be called with NULL to refer to this default (except for
3308     * elm_theme_free()). It's possible to create a new instance of a
3309     * ::Elm_Theme to set other theme for a specific widget (and all of its
3310     * children), but this is as discouraged, if not even more so, than using
3311     * overlays. Don't use this unless you really know what you are doing.
3312     *
3313     * But to be less negative about things, you can look at the following
3314     * examples:
3315     * @li @ref theme_example_01 "Using extensions"
3316     * @li @ref theme_example_02 "Using overlays"
3317     *
3318     * @{
3319     */
3320    /**
3321     * @typedef Elm_Theme
3322     *
3323     * Opaque handler for the list of themes Elementary looks for when
3324     * rendering widgets.
3325     *
3326     * Stay out of this unless you really know what you are doing. For most
3327     * cases, sticking to the default is all a developer needs.
3328     */
3329    typedef struct _Elm_Theme Elm_Theme;
3330
3331    /**
3332     * Create a new specific theme
3333     *
3334     * This creates an empty specific theme that only uses the default theme. A
3335     * specific theme has its own private set of extensions and overlays too
3336     * (which are empty by default). Specific themes do not fall back to themes
3337     * of parent objects. They are not intended for this use. Use styles, overlays
3338     * and extensions when needed, but avoid specific themes unless there is no
3339     * other way (example: you want to have a preview of a new theme you are
3340     * selecting in a "theme selector" window. The preview is inside a scroller
3341     * and should display what the theme you selected will look like, but not
3342     * actually apply it yet. The child of the scroller will have a specific
3343     * theme set to show this preview before the user decides to apply it to all
3344     * applications).
3345     */
3346    EAPI Elm_Theme       *elm_theme_new(void);
3347    /**
3348     * Free a specific theme
3349     *
3350     * @param th The theme to free
3351     *
3352     * This frees a theme created with elm_theme_new().
3353     */
3354    EAPI void             elm_theme_free(Elm_Theme *th);
3355    /**
3356     * Copy the theme fom the source to the destination theme
3357     *
3358     * @param th The source theme to copy from
3359     * @param thdst The destination theme to copy data to
3360     *
3361     * This makes a one-time static copy of all the theme config, extensions
3362     * and overlays from @p th to @p thdst. If @p th references a theme, then
3363     * @p thdst is also set to reference it, with all the theme settings,
3364     * overlays and extensions that @p th had.
3365     */
3366    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3367    /**
3368     * Tell the source theme to reference the ref theme
3369     *
3370     * @param th The theme that will do the referencing
3371     * @param thref The theme that is the reference source
3372     *
3373     * This clears @p th to be empty and then sets it to refer to @p thref
3374     * so @p th acts as an override to @p thref, but where its overrides
3375     * don't apply, it will fall through to @p thref for configuration.
3376     */
3377    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3378    /**
3379     * Return the theme referred to
3380     *
3381     * @param th The theme to get the reference from
3382     * @return The referenced theme handle
3383     *
3384     * This gets the theme set as the reference theme by elm_theme_ref_set().
3385     * If no theme is set as a reference, NULL is returned.
3386     */
3387    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3388    /**
3389     * Return the default theme
3390     *
3391     * @return The default theme handle
3392     *
3393     * This returns the internal default theme setup handle that all widgets
3394     * use implicitly unless a specific theme is set. This is also often use
3395     * as a shorthand of NULL.
3396     */
3397    EAPI Elm_Theme       *elm_theme_default_get(void);
3398    /**
3399     * Prepends a theme overlay to the list of overlays
3400     *
3401     * @param th The theme to add to, or if NULL, the default theme
3402     * @param item The Edje file path to be used
3403     *
3404     * Use this if your application needs to provide some custom overlay theme
3405     * (An Edje file that replaces some default styles of widgets) where adding
3406     * new styles, or changing system theme configuration is not possible. Do
3407     * NOT use this instead of a proper system theme configuration. Use proper
3408     * configuration files, profiles, environment variables etc. to set a theme
3409     * so that the theme can be altered by simple confiugration by a user. Using
3410     * this call to achieve that effect is abusing the API and will create lots
3411     * of trouble.
3412     *
3413     * @see elm_theme_extension_add()
3414     */
3415    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3416    /**
3417     * Delete a theme overlay from the list of overlays
3418     *
3419     * @param th The theme to delete from, or if NULL, the default theme
3420     * @param item The name of the theme overlay
3421     *
3422     * @see elm_theme_overlay_add()
3423     */
3424    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3425    /**
3426     * Appends a theme extension to the list of extensions.
3427     *
3428     * @param th The theme to add to, or if NULL, the default theme
3429     * @param item The Edje file path to be used
3430     *
3431     * This is intended when an application needs more styles of widgets or new
3432     * widget themes that the default does not provide (or may not provide). The
3433     * application has "extended" usage by coming up with new custom style names
3434     * for widgets for specific uses, but as these are not "standard", they are
3435     * not guaranteed to be provided by a default theme. This means the
3436     * application is required to provide these extra elements itself in specific
3437     * Edje files. This call adds one of those Edje files to the theme search
3438     * path to be search after the default theme. The use of this call is
3439     * encouraged when default styles do not meet the needs of the application.
3440     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3441     *
3442     * @see elm_object_style_set()
3443     */
3444    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3445    /**
3446     * Deletes a theme extension from the list of extensions.
3447     *
3448     * @param th The theme to delete from, or if NULL, the default theme
3449     * @param item The name of the theme extension
3450     *
3451     * @see elm_theme_extension_add()
3452     */
3453    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3454    /**
3455     * Set the theme search order for the given theme
3456     *
3457     * @param th The theme to set the search order, or if NULL, the default theme
3458     * @param theme Theme search string
3459     *
3460     * This sets the search string for the theme in path-notation from first
3461     * theme to search, to last, delimited by the : character. Example:
3462     *
3463     * "shiny:/path/to/file.edj:default"
3464     *
3465     * See the ELM_THEME environment variable for more information.
3466     *
3467     * @see elm_theme_get()
3468     * @see elm_theme_list_get()
3469     */
3470    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3471    /**
3472     * Return the theme search order
3473     *
3474     * @param th The theme to get the search order, or if NULL, the default theme
3475     * @return The internal search order path
3476     *
3477     * This function returns a colon separated string of theme elements as
3478     * returned by elm_theme_list_get().
3479     *
3480     * @see elm_theme_set()
3481     * @see elm_theme_list_get()
3482     */
3483    EAPI const char      *elm_theme_get(Elm_Theme *th);
3484    /**
3485     * Return a list of theme elements to be used in a theme.
3486     *
3487     * @param th Theme to get the list of theme elements from.
3488     * @return The internal list of theme elements
3489     *
3490     * This returns the internal list of theme elements (will only be valid as
3491     * long as the theme is not modified by elm_theme_set() or theme is not
3492     * freed by elm_theme_free(). This is a list of strings which must not be
3493     * altered as they are also internal. If @p th is NULL, then the default
3494     * theme element list is returned.
3495     *
3496     * A theme element can consist of a full or relative path to a .edj file,
3497     * or a name, without extension, for a theme to be searched in the known
3498     * theme paths for Elemementary.
3499     *
3500     * @see elm_theme_set()
3501     * @see elm_theme_get()
3502     */
3503    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3504    /**
3505     * Return the full patrh for a theme element
3506     *
3507     * @param f The theme element name
3508     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3509     * @return The full path to the file found.
3510     *
3511     * This returns a string you should free with free() on success, NULL on
3512     * failure. This will search for the given theme element, and if it is a
3513     * full or relative path element or a simple searchable name. The returned
3514     * path is the full path to the file, if searched, and the file exists, or it
3515     * is simply the full path given in the element or a resolved path if
3516     * relative to home. The @p in_search_path boolean pointed to is set to
3517     * EINA_TRUE if the file was a searchable file andis in the search path,
3518     * and EINA_FALSE otherwise.
3519     */
3520    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3521    /**
3522     * Flush the current theme.
3523     *
3524     * @param th Theme to flush
3525     *
3526     * This flushes caches that let elementary know where to find theme elements
3527     * in the given theme. If @p th is NULL, then the default theme is flushed.
3528     * Call this function if source theme data has changed in such a way as to
3529     * make any caches Elementary kept invalid.
3530     */
3531    EAPI void             elm_theme_flush(Elm_Theme *th);
3532    /**
3533     * This flushes all themes (default and specific ones).
3534     *
3535     * This will flush all themes in the current application context, by calling
3536     * elm_theme_flush() on each of them.
3537     */
3538    EAPI void             elm_theme_full_flush(void);
3539    /**
3540     * Set the theme for all elementary using applications on the current display
3541     *
3542     * @param theme The name of the theme to use. Format same as the ELM_THEME
3543     * environment variable.
3544     */
3545    EAPI void             elm_theme_all_set(const char *theme);
3546    /**
3547     * Return a list of theme elements in the theme search path
3548     *
3549     * @return A list of strings that are the theme element names.
3550     *
3551     * This lists all available theme files in the standard Elementary search path
3552     * for theme elements, and returns them in alphabetical order as theme
3553     * element names in a list of strings. Free this with
3554     * elm_theme_name_available_list_free() when you are done with the list.
3555     */
3556    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3557    /**
3558     * Free the list returned by elm_theme_name_available_list_new()
3559     *
3560     * This frees the list of themes returned by
3561     * elm_theme_name_available_list_new(). Once freed the list should no longer
3562     * be used. a new list mys be created.
3563     */
3564    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3565    /**
3566     * Set a specific theme to be used for this object and its children
3567     *
3568     * @param obj The object to set the theme on
3569     * @param th The theme to set
3570     *
3571     * This sets a specific theme that will be used for the given object and any
3572     * child objects it has. If @p th is NULL then the theme to be used is
3573     * cleared and the object will inherit its theme from its parent (which
3574     * ultimately will use the default theme if no specific themes are set).
3575     *
3576     * Use special themes with great care as this will annoy users and make
3577     * configuration difficult. Avoid any custom themes at all if it can be
3578     * helped.
3579     */
3580    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3581    /**
3582     * Get the specific theme to be used
3583     *
3584     * @param obj The object to get the specific theme from
3585     * @return The specifc theme set.
3586     *
3587     * This will return a specific theme set, or NULL if no specific theme is
3588     * set on that object. It will not return inherited themes from parents, only
3589     * the specific theme set for that specific object. See elm_object_theme_set()
3590     * for more information.
3591     */
3592    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3593
3594    /**
3595     * Get a data item from a theme
3596     *
3597     * @param th The theme, or NULL for default theme
3598     * @param key The data key to search with
3599     * @return The data value, or NULL on failure
3600     *
3601     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3602     * It works the same way as edje_file_data_get() except that the return is stringshared.
3603     */
3604    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3605    /**
3606     * @}
3607     */
3608
3609    /* win */
3610    /** @defgroup Win Win
3611     *
3612     * @image html img/widget/win/preview-00.png
3613     * @image latex img/widget/win/preview-00.eps
3614     *
3615     * The window class of Elementary.  Contains functions to manipulate
3616     * windows. The Evas engine used to render the window contents is specified
3617     * in the system or user elementary config files (whichever is found last),
3618     * and can be overridden with the ELM_ENGINE environment variable for
3619     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3620     * compilation setup and modules actually installed at runtime) are (listed
3621     * in order of best supported and most likely to be complete and work to
3622     * lowest quality).
3623     *
3624     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3625     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3626     * rendering in X11)
3627     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3628     * exits)
3629     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3630     * rendering)
3631     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3632     * buffer)
3633     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3634     * rendering using SDL as the buffer)
3635     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3636     * GDI with software)
3637     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3638     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3639     * grayscale using dedicated 8bit software engine in X11)
3640     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3641     * X11 using 16bit software engine)
3642     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3643     * (Windows CE rendering via GDI with 16bit software renderer)
3644     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3645     * buffer with 16bit software renderer)
3646     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3647     *
3648     * All engines use a simple string to select the engine to render, EXCEPT
3649     * the "shot" engine. This actually encodes the output of the virtual
3650     * screenshot and how long to delay in the engine string. The engine string
3651     * is encoded in the following way:
3652     *
3653     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3654     *
3655     * Where options are separated by a ":" char if more than one option is
3656     * given, with delay, if provided being the first option and file the last
3657     * (order is important). The delay specifies how long to wait after the
3658     * window is shown before doing the virtual "in memory" rendering and then
3659     * save the output to the file specified by the file option (and then exit).
3660     * If no delay is given, the default is 0.5 seconds. If no file is given the
3661     * default output file is "out.png". Repeat option is for continous
3662     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3663     * fixed to "out001.png" Some examples of using the shot engine:
3664     *
3665     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3666     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3667     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3668     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3669     *   ELM_ENGINE="shot:" elementary_test
3670     *
3671     * Signals that you can add callbacks for are:
3672     *
3673     * @li "delete,request": the user requested to close the window. See
3674     * elm_win_autodel_set().
3675     * @li "focus,in": window got focus
3676     * @li "focus,out": window lost focus
3677     * @li "moved": window that holds the canvas was moved
3678     *
3679     * Examples:
3680     * @li @ref win_example_01
3681     *
3682     * @{
3683     */
3684    /**
3685     * Defines the types of window that can be created
3686     *
3687     * These are hints set on the window so that a running Window Manager knows
3688     * how the window should be handled and/or what kind of decorations it
3689     * should have.
3690     *
3691     * Currently, only the X11 backed engines use them.
3692     */
3693    typedef enum _Elm_Win_Type
3694      {
3695         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3696                          window. Almost every window will be created with this
3697                          type. */
3698         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3699         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3700                            window holding desktop icons. */
3701         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3702                         be kept on top of any other window by the Window
3703                         Manager. */
3704         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3705                            similar. */
3706         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3707         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3708                            pallete. */
3709         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3710         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3711                                  entry in a menubar is clicked. Typically used
3712                                  with elm_win_override_set(). This hint exists
3713                                  for completion only, as the EFL way of
3714                                  implementing a menu would not normally use a
3715                                  separate window for its contents. */
3716         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3717                               triggered by right-clicking an object. */
3718         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3719                            explanatory text that typically appear after the
3720                            mouse cursor hovers over an object for a while.
3721                            Typically used with elm_win_override_set() and also
3722                            not very commonly used in the EFL. */
3723         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3724                                 battery life or a new E-Mail received. */
3725         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3726                          usually used in the EFL. */
3727         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3728                        object being dragged across different windows, or even
3729                        applications. Typically used with
3730                        elm_win_override_set(). */
3731         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3732                                  buffer. No actual window is created for this
3733                                  type, instead the window and all of its
3734                                  contents will be rendered to an image buffer.
3735                                  This allows to have children window inside a
3736                                  parent one just like any other object would
3737                                  be, and do other things like applying @c
3738                                  Evas_Map effects to it. This is the only type
3739                                  of window that requires the @c parent
3740                                  parameter of elm_win_add() to be a valid @c
3741                                  Evas_Object. */
3742      } Elm_Win_Type;
3743
3744    /**
3745     * The differents layouts that can be requested for the virtual keyboard.
3746     *
3747     * When the application window is being managed by Illume, it may request
3748     * any of the following layouts for the virtual keyboard.
3749     */
3750    typedef enum _Elm_Win_Keyboard_Mode
3751      {
3752         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3753         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3754         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3755         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3756         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3757         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3758         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3759         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3760         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3761         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3762         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3763         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3764         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3765         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3766         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3767         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3768      } Elm_Win_Keyboard_Mode;
3769
3770    /**
3771     * Available commands that can be sent to the Illume manager.
3772     *
3773     * When running under an Illume session, a window may send commands to the
3774     * Illume manager to perform different actions.
3775     */
3776    typedef enum _Elm_Illume_Command
3777      {
3778         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3779                                          window */
3780         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3781                                             in the list */
3782         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3783                                          screen */
3784         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3785      } Elm_Illume_Command;
3786
3787    /**
3788     * Adds a window object. If this is the first window created, pass NULL as
3789     * @p parent.
3790     *
3791     * @param parent Parent object to add the window to, or NULL
3792     * @param name The name of the window
3793     * @param type The window type, one of #Elm_Win_Type.
3794     *
3795     * The @p parent paramter can be @c NULL for every window @p type except
3796     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3797     * which the image object will be created.
3798     *
3799     * @return The created object, or NULL on failure
3800     */
3801    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3802    /**
3803     * Adds a window object with standard setup
3804     *
3805     * @param name The name of the window
3806     * @param title The title for the window
3807     *
3808     * This creates a window like elm_win_add() but also puts in a standard
3809     * background with elm_bg_add(), as well as setting the window title to
3810     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3811     * as the parent widget.
3812     * 
3813     * @return The created object, or NULL on failure
3814     *
3815     * @see elm_win_add()
3816     */
3817    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3818    /**
3819     * Add @p subobj as a resize object of window @p obj.
3820     *
3821     *
3822     * Setting an object as a resize object of the window means that the
3823     * @p subobj child's size and position will be controlled by the window
3824     * directly. That is, the object will be resized to match the window size
3825     * and should never be moved or resized manually by the developer.
3826     *
3827     * In addition, resize objects of the window control what the minimum size
3828     * of it will be, as well as whether it can or not be resized by the user.
3829     *
3830     * For the end user to be able to resize a window by dragging the handles
3831     * or borders provided by the Window Manager, or using any other similar
3832     * mechanism, all of the resize objects in the window should have their
3833     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3834     *
3835     * @param obj The window object
3836     * @param subobj The resize object to add
3837     */
3838    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3839    /**
3840     * Delete @p subobj as a resize object of window @p obj.
3841     *
3842     * This function removes the object @p subobj from the resize objects of
3843     * the window @p obj. It will not delete the object itself, which will be
3844     * left unmanaged and should be deleted by the developer, manually handled
3845     * or set as child of some other container.
3846     *
3847     * @param obj The window object
3848     * @param subobj The resize object to add
3849     */
3850    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3851    /**
3852     * Set the title of the window
3853     *
3854     * @param obj The window object
3855     * @param title The title to set
3856     */
3857    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3858    /**
3859     * Get the title of the window
3860     *
3861     * The returned string is an internal one and should not be freed or
3862     * modified. It will also be rendered invalid if a new title is set or if
3863     * the window is destroyed.
3864     *
3865     * @param obj The window object
3866     * @return The title
3867     */
3868    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3869    /**
3870     * Set the window's autodel state.
3871     *
3872     * When closing the window in any way outside of the program control, like
3873     * pressing the X button in the titlebar or using a command from the
3874     * Window Manager, a "delete,request" signal is emitted to indicate that
3875     * this event occurred and the developer can take any action, which may
3876     * include, or not, destroying the window object.
3877     *
3878     * When the @p autodel parameter is set, the window will be automatically
3879     * destroyed when this event occurs, after the signal is emitted.
3880     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3881     * and is up to the program to do so when it's required.
3882     *
3883     * @param obj The window object
3884     * @param autodel If true, the window will automatically delete itself when
3885     * closed
3886     */
3887    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3888    /**
3889     * Get the window's autodel state.
3890     *
3891     * @param obj The window object
3892     * @return If the window will automatically delete itself when closed
3893     *
3894     * @see elm_win_autodel_set()
3895     */
3896    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3897    /**
3898     * Activate a window object.
3899     *
3900     * This function sends a request to the Window Manager to activate the
3901     * window pointed by @p obj. If honored by the WM, the window will receive
3902     * the keyboard focus.
3903     *
3904     * @note This is just a request that a Window Manager may ignore, so calling
3905     * this function does not ensure in any way that the window will be the
3906     * active one after it.
3907     *
3908     * @param obj The window object
3909     */
3910    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3911    /**
3912     * Lower a window object.
3913     *
3914     * Places the window pointed by @p obj at the bottom of the stack, so that
3915     * no other window is covered by it.
3916     *
3917     * If elm_win_override_set() is not set, the Window Manager may ignore this
3918     * request.
3919     *
3920     * @param obj The window object
3921     */
3922    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3923    /**
3924     * Raise a window object.
3925     *
3926     * Places the window pointed by @p obj at the top of the stack, so that it's
3927     * not covered by any other window.
3928     *
3929     * If elm_win_override_set() is not set, the Window Manager may ignore this
3930     * request.
3931     *
3932     * @param obj The window object
3933     */
3934    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3935    /**
3936     * Set the borderless state of a window.
3937     *
3938     * This function requests the Window Manager to not draw any decoration
3939     * around the window.
3940     *
3941     * @param obj The window object
3942     * @param borderless If true, the window is borderless
3943     */
3944    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3945    /**
3946     * Get the borderless state of a window.
3947     *
3948     * @param obj The window object
3949     * @return If true, the window is borderless
3950     */
3951    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3952    /**
3953     * Set the shaped state of a window.
3954     *
3955     * Shaped windows, when supported, will render the parts of the window that
3956     * has no content, transparent.
3957     *
3958     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3959     * background object or cover the entire window in any other way, or the
3960     * parts of the canvas that have no data will show framebuffer artifacts.
3961     *
3962     * @param obj The window object
3963     * @param shaped If true, the window is shaped
3964     *
3965     * @see elm_win_alpha_set()
3966     */
3967    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3968    /**
3969     * Get the shaped state of a window.
3970     *
3971     * @param obj The window object
3972     * @return If true, the window is shaped
3973     *
3974     * @see elm_win_shaped_set()
3975     */
3976    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3977    /**
3978     * Set the alpha channel state of a window.
3979     *
3980     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3981     * possibly making parts of the window completely or partially transparent.
3982     * This is also subject to the underlying system supporting it, like for
3983     * example, running under a compositing manager. If no compositing is
3984     * available, enabling this option will instead fallback to using shaped
3985     * windows, with elm_win_shaped_set().
3986     *
3987     * @param obj The window object
3988     * @param alpha If true, the window has an alpha channel
3989     *
3990     * @see elm_win_alpha_set()
3991     */
3992    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3993    /**
3994     * Get the transparency state of a window.
3995     *
3996     * @param obj The window object
3997     * @return If true, the window is transparent
3998     *
3999     * @see elm_win_transparent_set()
4000     */
4001    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4002    /**
4003     * Set the transparency state of a window.
4004     *
4005     * Use elm_win_alpha_set() instead.
4006     *
4007     * @param obj The window object
4008     * @param transparent If true, the window is transparent
4009     *
4010     * @see elm_win_alpha_set()
4011     */
4012    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4013    /**
4014     * Get the alpha channel state of a window.
4015     *
4016     * @param obj The window object
4017     * @return If true, the window has an alpha channel
4018     */
4019    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4020    /**
4021     * Set the override state of a window.
4022     *
4023     * A window with @p override set to EINA_TRUE will not be managed by the
4024     * Window Manager. This means that no decorations of any kind will be shown
4025     * for it, moving and resizing must be handled by the application, as well
4026     * as the window visibility.
4027     *
4028     * This should not be used for normal windows, and even for not so normal
4029     * ones, it should only be used when there's a good reason and with a lot
4030     * of care. Mishandling override windows may result situations that
4031     * disrupt the normal workflow of the end user.
4032     *
4033     * @param obj The window object
4034     * @param override If true, the window is overridden
4035     */
4036    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4037    /**
4038     * Get the override state of a window.
4039     *
4040     * @param obj The window object
4041     * @return If true, the window is overridden
4042     *
4043     * @see elm_win_override_set()
4044     */
4045    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046    /**
4047     * Set the fullscreen state of a window.
4048     *
4049     * @param obj The window object
4050     * @param fullscreen If true, the window is fullscreen
4051     */
4052    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4053    /**
4054     * Get the fullscreen state of a window.
4055     *
4056     * @param obj The window object
4057     * @return If true, the window is fullscreen
4058     */
4059    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060    /**
4061     * Set the maximized state of a window.
4062     *
4063     * @param obj The window object
4064     * @param maximized If true, the window is maximized
4065     */
4066    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4067    /**
4068     * Get the maximized state of a window.
4069     *
4070     * @param obj The window object
4071     * @return If true, the window is maximized
4072     */
4073    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074    /**
4075     * Set the iconified state of a window.
4076     *
4077     * @param obj The window object
4078     * @param iconified If true, the window is iconified
4079     */
4080    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4081    /**
4082     * Get the iconified state of a window.
4083     *
4084     * @param obj The window object
4085     * @return If true, the window is iconified
4086     */
4087    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4088    /**
4089     * Set the layer of the window.
4090     *
4091     * What this means exactly will depend on the underlying engine used.
4092     *
4093     * In the case of X11 backed engines, the value in @p layer has the
4094     * following meanings:
4095     * @li < 3: The window will be placed below all others.
4096     * @li > 5: The window will be placed above all others.
4097     * @li other: The window will be placed in the default layer.
4098     *
4099     * @param obj The window object
4100     * @param layer The layer of the window
4101     */
4102    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4103    /**
4104     * Get the layer of the window.
4105     *
4106     * @param obj The window object
4107     * @return The layer of the window
4108     *
4109     * @see elm_win_layer_set()
4110     */
4111    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4112    /**
4113     * Set the rotation of the window.
4114     *
4115     * Most engines only work with multiples of 90.
4116     *
4117     * This function is used to set the orientation of the window @p obj to
4118     * match that of the screen. The window itself will be resized to adjust
4119     * to the new geometry of its contents. If you want to keep the window size,
4120     * see elm_win_rotation_with_resize_set().
4121     *
4122     * @param obj The window object
4123     * @param rotation The rotation of the window, in degrees (0-360),
4124     * counter-clockwise.
4125     */
4126    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4127    /**
4128     * Rotates the window and resizes it.
4129     *
4130     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4131     * that they fit inside the current window geometry.
4132     *
4133     * @param obj The window object
4134     * @param layer The rotation of the window in degrees (0-360),
4135     * counter-clockwise.
4136     */
4137    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4138    /**
4139     * Get the rotation of the window.
4140     *
4141     * @param obj The window object
4142     * @return The rotation of the window in degrees (0-360)
4143     *
4144     * @see elm_win_rotation_set()
4145     * @see elm_win_rotation_with_resize_set()
4146     */
4147    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4148    /**
4149     * Set the sticky state of the window.
4150     *
4151     * Hints the Window Manager that the window in @p obj should be left fixed
4152     * at its position even when the virtual desktop it's on moves or changes.
4153     *
4154     * @param obj The window object
4155     * @param sticky If true, the window's sticky state is enabled
4156     */
4157    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4158    /**
4159     * Get the sticky state of the window.
4160     *
4161     * @param obj The window object
4162     * @return If true, the window's sticky state is enabled
4163     *
4164     * @see elm_win_sticky_set()
4165     */
4166    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4167    /**
4168     * Set if this window is an illume conformant window
4169     *
4170     * @param obj The window object
4171     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4172     */
4173    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4174    /**
4175     * Get if this window is an illume conformant window
4176     *
4177     * @param obj The window object
4178     * @return A boolean if this window is illume conformant or not
4179     */
4180    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4181    /**
4182     * Set a window to be an illume quickpanel window
4183     *
4184     * By default window objects are not quickpanel windows.
4185     *
4186     * @param obj The window object
4187     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4188     */
4189    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4190    /**
4191     * Get if this window is a quickpanel or not
4192     *
4193     * @param obj The window object
4194     * @return A boolean if this window is a quickpanel or not
4195     */
4196    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4197    /**
4198     * Set the major priority of a quickpanel window
4199     *
4200     * @param obj The window object
4201     * @param priority The major priority for this quickpanel
4202     */
4203    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4204    /**
4205     * Get the major priority of a quickpanel window
4206     *
4207     * @param obj The window object
4208     * @return The major priority of this quickpanel
4209     */
4210    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4211    /**
4212     * Set the minor priority of a quickpanel window
4213     *
4214     * @param obj The window object
4215     * @param priority The minor priority for this quickpanel
4216     */
4217    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4218    /**
4219     * Get the minor priority of a quickpanel window
4220     *
4221     * @param obj The window object
4222     * @return The minor priority of this quickpanel
4223     */
4224    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4225    /**
4226     * Set which zone this quickpanel should appear in
4227     *
4228     * @param obj The window object
4229     * @param zone The requested zone for this quickpanel
4230     */
4231    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4232    /**
4233     * Get which zone this quickpanel should appear in
4234     *
4235     * @param obj The window object
4236     * @return The requested zone for this quickpanel
4237     */
4238    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4239    /**
4240     * Set the window to be skipped by keyboard focus
4241     *
4242     * This sets the window to be skipped by normal keyboard input. This means
4243     * a window manager will be asked to not focus this window as well as omit
4244     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4245     *
4246     * Call this and enable it on a window BEFORE you show it for the first time,
4247     * otherwise it may have no effect.
4248     *
4249     * Use this for windows that have only output information or might only be
4250     * interacted with by the mouse or fingers, and never for typing input.
4251     * Be careful that this may have side-effects like making the window
4252     * non-accessible in some cases unless the window is specially handled. Use
4253     * this with care.
4254     *
4255     * @param obj The window object
4256     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4257     */
4258    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4259    /**
4260     * Send a command to the windowing environment
4261     *
4262     * This is intended to work in touchscreen or small screen device
4263     * environments where there is a more simplistic window management policy in
4264     * place. This uses the window object indicated to select which part of the
4265     * environment to control (the part that this window lives in), and provides
4266     * a command and an optional parameter structure (use NULL for this if not
4267     * needed).
4268     *
4269     * @param obj The window object that lives in the environment to control
4270     * @param command The command to send
4271     * @param params Optional parameters for the command
4272     */
4273    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4274    /**
4275     * Get the inlined image object handle
4276     *
4277     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4278     * then the window is in fact an evas image object inlined in the parent
4279     * canvas. You can get this object (be careful to not manipulate it as it
4280     * is under control of elementary), and use it to do things like get pixel
4281     * data, save the image to a file, etc.
4282     *
4283     * @param obj The window object to get the inlined image from
4284     * @return The inlined image object, or NULL if none exists
4285     */
4286    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4287    /**
4288     * Set the enabled status for the focus highlight in a window
4289     *
4290     * This function will enable or disable the focus highlight only for the
4291     * given window, regardless of the global setting for it
4292     *
4293     * @param obj The window where to enable the highlight
4294     * @param enabled The enabled value for the highlight
4295     */
4296    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4297    /**
4298     * Get the enabled value of the focus highlight for this window
4299     *
4300     * @param obj The window in which to check if the focus highlight is enabled
4301     *
4302     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4303     */
4304    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4305    /**
4306     * Set the style for the focus highlight on this window
4307     *
4308     * Sets the style to use for theming the highlight of focused objects on
4309     * the given window. If @p style is NULL, the default will be used.
4310     *
4311     * @param obj The window where to set the style
4312     * @param style The style to set
4313     */
4314    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4315    /**
4316     * Get the style set for the focus highlight object
4317     *
4318     * Gets the style set for this windows highilght object, or NULL if none
4319     * is set.
4320     *
4321     * @param obj The window to retrieve the highlights style from
4322     *
4323     * @return The style set or NULL if none was. Default is used in that case.
4324     */
4325    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4326    /*...
4327     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4328     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4329     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4330     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4331     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4332     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4333     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4334     *
4335     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4336     * (blank mouse, private mouse obj, defaultmouse)
4337     *
4338     */
4339    /**
4340     * Sets the keyboard mode of the window.
4341     *
4342     * @param obj The window object
4343     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4344     */
4345    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4346    /**
4347     * Gets the keyboard mode of the window.
4348     *
4349     * @param obj The window object
4350     * @return The mode, one of #Elm_Win_Keyboard_Mode
4351     */
4352    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4353    /**
4354     * Sets whether the window is a keyboard.
4355     *
4356     * @param obj The window object
4357     * @param is_keyboard If true, the window is a virtual keyboard
4358     */
4359    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4360    /**
4361     * Gets whether the window is a keyboard.
4362     *
4363     * @param obj The window object
4364     * @return If the window is a virtual keyboard
4365     */
4366    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367
4368    /**
4369     * Get the screen position of a window.
4370     *
4371     * @param obj The window object
4372     * @param x The int to store the x coordinate to
4373     * @param y The int to store the y coordinate to
4374     */
4375    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4376    /**
4377     * @}
4378     */
4379
4380    /**
4381     * @defgroup Inwin Inwin
4382     *
4383     * @image html img/widget/inwin/preview-00.png
4384     * @image latex img/widget/inwin/preview-00.eps
4385     * @image html img/widget/inwin/preview-01.png
4386     * @image latex img/widget/inwin/preview-01.eps
4387     * @image html img/widget/inwin/preview-02.png
4388     * @image latex img/widget/inwin/preview-02.eps
4389     *
4390     * An inwin is a window inside a window that is useful for a quick popup.
4391     * It does not hover.
4392     *
4393     * It works by creating an object that will occupy the entire window, so it
4394     * must be created using an @ref Win "elm_win" as parent only. The inwin
4395     * object can be hidden or restacked below every other object if it's
4396     * needed to show what's behind it without destroying it. If this is done,
4397     * the elm_win_inwin_activate() function can be used to bring it back to
4398     * full visibility again.
4399     *
4400     * There are three styles available in the default theme. These are:
4401     * @li default: The inwin is sized to take over most of the window it's
4402     * placed in.
4403     * @li minimal: The size of the inwin will be the minimum necessary to show
4404     * its contents.
4405     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4406     * possible, but it's sized vertically the most it needs to fit its\
4407     * contents.
4408     *
4409     * Some examples of Inwin can be found in the following:
4410     * @li @ref inwin_example_01
4411     *
4412     * @{
4413     */
4414    /**
4415     * Adds an inwin to the current window
4416     *
4417     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4418     * Never call this function with anything other than the top-most window
4419     * as its parameter, unless you are fond of undefined behavior.
4420     *
4421     * After creating the object, the widget will set itself as resize object
4422     * for the window with elm_win_resize_object_add(), so when shown it will
4423     * appear to cover almost the entire window (how much of it depends on its
4424     * content and the style used). It must not be added into other container
4425     * objects and it needs not be moved or resized manually.
4426     *
4427     * @param parent The parent object
4428     * @return The new object or NULL if it cannot be created
4429     */
4430    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4431    /**
4432     * Activates an inwin object, ensuring its visibility
4433     *
4434     * This function will make sure that the inwin @p obj is completely visible
4435     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4436     * to the front. It also sets the keyboard focus to it, which will be passed
4437     * onto its content.
4438     *
4439     * The object's theme will also receive the signal "elm,action,show" with
4440     * source "elm".
4441     *
4442     * @param obj The inwin to activate
4443     */
4444    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4445    /**
4446     * Set the content of an inwin object.
4447     *
4448     * Once the content object is set, a previously set one will be deleted.
4449     * If you want to keep that old content object, use the
4450     * elm_win_inwin_content_unset() function.
4451     *
4452     * @param obj The inwin object
4453     * @param content The object to set as content
4454     */
4455    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4456    /**
4457     * Get the content of an inwin object.
4458     *
4459     * Return the content object which is set for this widget.
4460     *
4461     * The returned object is valid as long as the inwin is still alive and no
4462     * other content is set on it. Deleting the object will notify the inwin
4463     * about it and this one will be left empty.
4464     *
4465     * If you need to remove an inwin's content to be reused somewhere else,
4466     * see elm_win_inwin_content_unset().
4467     *
4468     * @param obj The inwin object
4469     * @return The content that is being used
4470     */
4471    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4472    /**
4473     * Unset the content of an inwin object.
4474     *
4475     * Unparent and return the content object which was set for this widget.
4476     *
4477     * @param obj The inwin object
4478     * @return The content that was being used
4479     */
4480    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4481    /**
4482     * @}
4483     */
4484    /* X specific calls - won't work on non-x engines (return 0) */
4485
4486    /**
4487     * Get the Ecore_X_Window of an Evas_Object
4488     *
4489     * @param obj The object
4490     *
4491     * @return The Ecore_X_Window of @p obj
4492     *
4493     * @ingroup Win
4494     */
4495    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4496
4497    /* smart callbacks called:
4498     * "delete,request" - the user requested to delete the window
4499     * "focus,in" - window got focus
4500     * "focus,out" - window lost focus
4501     * "moved" - window that holds the canvas was moved
4502     */
4503
4504    /**
4505     * @defgroup Bg Bg
4506     *
4507     * @image html img/widget/bg/preview-00.png
4508     * @image latex img/widget/bg/preview-00.eps
4509     *
4510     * @brief Background object, used for setting a solid color, image or Edje
4511     * group as background to a window or any container object.
4512     *
4513     * The bg object is used for setting a solid background to a window or
4514     * packing into any container object. It works just like an image, but has
4515     * some properties useful to a background, like setting it to tiled,
4516     * centered, scaled or stretched.
4517     * 
4518     * Default contents parts of the bg widget that you can use for are:
4519     * @li "elm.swallow.content" - overlay of the bg
4520     *
4521     * Here is some sample code using it:
4522     * @li @ref bg_01_example_page
4523     * @li @ref bg_02_example_page
4524     * @li @ref bg_03_example_page
4525     */
4526
4527    /* bg */
4528    typedef enum _Elm_Bg_Option
4529      {
4530         ELM_BG_OPTION_CENTER,  /**< center the background */
4531         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4532         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4533         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4534      } Elm_Bg_Option;
4535
4536    /**
4537     * Add a new background to the parent
4538     *
4539     * @param parent The parent object
4540     * @return The new object or NULL if it cannot be created
4541     *
4542     * @ingroup Bg
4543     */
4544    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4545
4546    /**
4547     * Set the file (image or edje) used for the background
4548     *
4549     * @param obj The bg object
4550     * @param file The file path
4551     * @param group Optional key (group in Edje) within the file
4552     *
4553     * This sets the image file used in the background object. The image (or edje)
4554     * will be stretched (retaining aspect if its an image file) to completely fill
4555     * the bg object. This may mean some parts are not visible.
4556     *
4557     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4558     * even if @p file is NULL.
4559     *
4560     * @ingroup Bg
4561     */
4562    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4563
4564    /**
4565     * Get the file (image or edje) used for the background
4566     *
4567     * @param obj The bg object
4568     * @param file The file path
4569     * @param group Optional key (group in Edje) within the file
4570     *
4571     * @ingroup Bg
4572     */
4573    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4574
4575    /**
4576     * Set the option used for the background image
4577     *
4578     * @param obj The bg object
4579     * @param option The desired background option (TILE, SCALE)
4580     *
4581     * This sets the option used for manipulating the display of the background
4582     * image. The image can be tiled or scaled.
4583     *
4584     * @ingroup Bg
4585     */
4586    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4587
4588    /**
4589     * Get the option used for the background image
4590     *
4591     * @param obj The bg object
4592     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4593     *
4594     * @ingroup Bg
4595     */
4596    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4597    /**
4598     * Set the option used for the background color
4599     *
4600     * @param obj The bg object
4601     * @param r
4602     * @param g
4603     * @param b
4604     *
4605     * This sets the color used for the background rectangle. Its range goes
4606     * from 0 to 255.
4607     *
4608     * @ingroup Bg
4609     */
4610    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4611    /**
4612     * Get the option used for the background color
4613     *
4614     * @param obj The bg object
4615     * @param r
4616     * @param g
4617     * @param b
4618     *
4619     * @ingroup Bg
4620     */
4621    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4622
4623    /**
4624     * Set the overlay object used for the background object.
4625     *
4626     * @param obj The bg object
4627     * @param overlay The overlay object
4628     *
4629     * This provides a way for elm_bg to have an 'overlay' that will be on top
4630     * of the bg. Once the over object is set, a previously set one will be
4631     * deleted, even if you set the new one to NULL. If you want to keep that
4632     * old content object, use the elm_bg_overlay_unset() function.
4633     *
4634     * @ingroup Bg
4635     */
4636
4637    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4638
4639    /**
4640     * Get the overlay object used for the background object.
4641     *
4642     * @param obj The bg object
4643     * @return The content that is being used
4644     *
4645     * Return the content object which is set for this widget
4646     *
4647     * @ingroup Bg
4648     */
4649    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650
4651    /**
4652     * Get the overlay object used for the background object.
4653     *
4654     * @param obj The bg object
4655     * @return The content that was being used
4656     *
4657     * Unparent and return the overlay object which was set for this widget
4658     *
4659     * @ingroup Bg
4660     */
4661    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4662
4663    /**
4664     * Set the size of the pixmap representation of the image.
4665     *
4666     * This option just makes sense if an image is going to be set in the bg.
4667     *
4668     * @param obj The bg object
4669     * @param w The new width of the image pixmap representation.
4670     * @param h The new height of the image pixmap representation.
4671     *
4672     * This function sets a new size for pixmap representation of the given bg
4673     * image. It allows the image to be loaded already in the specified size,
4674     * reducing the memory usage and load time when loading a big image with load
4675     * size set to a smaller size.
4676     *
4677     * NOTE: this is just a hint, the real size of the pixmap may differ
4678     * depending on the type of image being loaded, being bigger than requested.
4679     *
4680     * @ingroup Bg
4681     */
4682    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4683    /* smart callbacks called:
4684     */
4685
4686    /**
4687     * @defgroup Icon Icon
4688     *
4689     * @image html img/widget/icon/preview-00.png
4690     * @image latex img/widget/icon/preview-00.eps
4691     *
4692     * An object that provides standard icon images (delete, edit, arrows, etc.)
4693     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4694     *
4695     * The icon image requested can be in the elementary theme, or in the
4696     * freedesktop.org paths. It's possible to set the order of preference from
4697     * where the image will be used.
4698     *
4699     * This API is very similar to @ref Image, but with ready to use images.
4700     *
4701     * Default images provided by the theme are described below.
4702     *
4703     * The first list contains icons that were first intended to be used in
4704     * toolbars, but can be used in many other places too:
4705     * @li home
4706     * @li close
4707     * @li apps
4708     * @li arrow_up
4709     * @li arrow_down
4710     * @li arrow_left
4711     * @li arrow_right
4712     * @li chat
4713     * @li clock
4714     * @li delete
4715     * @li edit
4716     * @li refresh
4717     * @li folder
4718     * @li file
4719     *
4720     * Now some icons that were designed to be used in menus (but again, you can
4721     * use them anywhere else):
4722     * @li menu/home
4723     * @li menu/close
4724     * @li menu/apps
4725     * @li menu/arrow_up
4726     * @li menu/arrow_down
4727     * @li menu/arrow_left
4728     * @li menu/arrow_right
4729     * @li menu/chat
4730     * @li menu/clock
4731     * @li menu/delete
4732     * @li menu/edit
4733     * @li menu/refresh
4734     * @li menu/folder
4735     * @li menu/file
4736     *
4737     * And here we have some media player specific icons:
4738     * @li media_player/forward
4739     * @li media_player/info
4740     * @li media_player/next
4741     * @li media_player/pause
4742     * @li media_player/play
4743     * @li media_player/prev
4744     * @li media_player/rewind
4745     * @li media_player/stop
4746     *
4747     * Signals that you can add callbacks for are:
4748     *
4749     * "clicked" - This is called when a user has clicked the icon
4750     *
4751     * An example of usage for this API follows:
4752     * @li @ref tutorial_icon
4753     */
4754
4755    /**
4756     * @addtogroup Icon
4757     * @{
4758     */
4759
4760    typedef enum _Elm_Icon_Type
4761      {
4762         ELM_ICON_NONE,
4763         ELM_ICON_FILE,
4764         ELM_ICON_STANDARD
4765      } Elm_Icon_Type;
4766    /**
4767     * @enum _Elm_Icon_Lookup_Order
4768     * @typedef Elm_Icon_Lookup_Order
4769     *
4770     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4771     * theme, FDO paths, or both?
4772     *
4773     * @ingroup Icon
4774     */
4775    typedef enum _Elm_Icon_Lookup_Order
4776      {
4777         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4778         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4779         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4780         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4781      } Elm_Icon_Lookup_Order;
4782
4783    /**
4784     * Add a new icon object to the parent.
4785     *
4786     * @param parent The parent object
4787     * @return The new object or NULL if it cannot be created
4788     *
4789     * @see elm_icon_file_set()
4790     *
4791     * @ingroup Icon
4792     */
4793    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4794    /**
4795     * Set the file that will be used as icon.
4796     *
4797     * @param obj The icon object
4798     * @param file The path to file that will be used as icon image
4799     * @param group The group that the icon belongs to an edje file
4800     *
4801     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4802     *
4803     * @note The icon image set by this function can be changed by
4804     * elm_icon_standard_set().
4805     *
4806     * @see elm_icon_file_get()
4807     *
4808     * @ingroup Icon
4809     */
4810    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4811    /**
4812     * Set a location in memory to be used as an icon
4813     *
4814     * @param obj The icon object
4815     * @param img The binary data that will be used as an image
4816     * @param size The size of binary data @p img
4817     * @param format Optional format of @p img to pass to the image loader
4818     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4819     *
4820     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4821     *
4822     * @note The icon image set by this function can be changed by
4823     * elm_icon_standard_set().
4824     *
4825     * @ingroup Icon
4826     */
4827    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);
4828    /**
4829     * Get the file that will be used as icon.
4830     *
4831     * @param obj The icon object
4832     * @param file The path to file that will be used as the icon image
4833     * @param group The group that the icon belongs to, in edje file
4834     *
4835     * @see elm_icon_file_set()
4836     *
4837     * @ingroup Icon
4838     */
4839    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4840    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4841    /**
4842     * Set the icon by icon standards names.
4843     *
4844     * @param obj The icon object
4845     * @param name The icon name
4846     *
4847     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4848     *
4849     * For example, freedesktop.org defines standard icon names such as "home",
4850     * "network", etc. There can be different icon sets to match those icon
4851     * keys. The @p name given as parameter is one of these "keys", and will be
4852     * used to look in the freedesktop.org paths and elementary theme. One can
4853     * change the lookup order with elm_icon_order_lookup_set().
4854     *
4855     * If name is not found in any of the expected locations and it is the
4856     * absolute path of an image file, this image will be used.
4857     *
4858     * @note The icon image set by this function can be changed by
4859     * elm_icon_file_set().
4860     *
4861     * @see elm_icon_standard_get()
4862     * @see elm_icon_file_set()
4863     *
4864     * @ingroup Icon
4865     */
4866    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4867    /**
4868     * Get the icon name set by icon standard names.
4869     *
4870     * @param obj The icon object
4871     * @return The icon name
4872     *
4873     * If the icon image was set using elm_icon_file_set() instead of
4874     * elm_icon_standard_set(), then this function will return @c NULL.
4875     *
4876     * @see elm_icon_standard_set()
4877     *
4878     * @ingroup Icon
4879     */
4880    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4881    /**
4882     * Set the smooth scaling for an icon object.
4883     *
4884     * @param obj The icon object
4885     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4886     * otherwise. Default is @c EINA_TRUE.
4887     *
4888     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4889     * scaling provides a better resulting image, but is slower.
4890     *
4891     * The smooth scaling should be disabled when making animations that change
4892     * the icon size, since they will be faster. Animations that don't require
4893     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4894     * is already scaled, since the scaled icon image will be cached).
4895     *
4896     * @see elm_icon_smooth_get()
4897     *
4898     * @ingroup Icon
4899     */
4900    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4901    /**
4902     * Get whether smooth scaling is enabled for an icon object.
4903     *
4904     * @param obj The icon object
4905     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4906     *
4907     * @see elm_icon_smooth_set()
4908     *
4909     * @ingroup Icon
4910     */
4911    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4912    /**
4913     * Disable scaling of this object.
4914     *
4915     * @param obj The icon object.
4916     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4917     * otherwise. Default is @c EINA_FALSE.
4918     *
4919     * This function disables scaling of the icon object through the function
4920     * elm_object_scale_set(). However, this does not affect the object
4921     * size/resize in any way. For that effect, take a look at
4922     * elm_icon_scale_set().
4923     *
4924     * @see elm_icon_no_scale_get()
4925     * @see elm_icon_scale_set()
4926     * @see elm_object_scale_set()
4927     *
4928     * @ingroup Icon
4929     */
4930    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4931    /**
4932     * Get whether scaling is disabled on the object.
4933     *
4934     * @param obj The icon object
4935     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4936     *
4937     * @see elm_icon_no_scale_set()
4938     *
4939     * @ingroup Icon
4940     */
4941    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4942    /**
4943     * Set if the object is (up/down) resizable.
4944     *
4945     * @param obj The icon object
4946     * @param scale_up A bool to set if the object is resizable up. Default is
4947     * @c EINA_TRUE.
4948     * @param scale_down A bool to set if the object is resizable down. Default
4949     * is @c EINA_TRUE.
4950     *
4951     * This function limits the icon object resize ability. If @p scale_up is set to
4952     * @c EINA_FALSE, the object can't have its height or width resized to a value
4953     * higher than the original icon size. Same is valid for @p scale_down.
4954     *
4955     * @see elm_icon_scale_get()
4956     *
4957     * @ingroup Icon
4958     */
4959    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4960    /**
4961     * Get if the object is (up/down) resizable.
4962     *
4963     * @param obj The icon object
4964     * @param scale_up A bool to set if the object is resizable up
4965     * @param scale_down A bool to set if the object is resizable down
4966     *
4967     * @see elm_icon_scale_set()
4968     *
4969     * @ingroup Icon
4970     */
4971    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4972    /**
4973     * Get the object's image size
4974     *
4975     * @param obj The icon object
4976     * @param w A pointer to store the width in
4977     * @param h A pointer to store the height in
4978     *
4979     * @ingroup Icon
4980     */
4981    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4982    /**
4983     * Set if the icon fill the entire object area.
4984     *
4985     * @param obj The icon object
4986     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4987     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4988     *
4989     * When the icon object is resized to a different aspect ratio from the
4990     * original icon image, the icon image will still keep its aspect. This flag
4991     * tells how the image should fill the object's area. They are: keep the
4992     * entire icon inside the limits of height and width of the object (@p
4993     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4994     * of the object, and the icon will fill the entire object (@p fill_outside
4995     * is @c EINA_TRUE).
4996     *
4997     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4998     * retain property to false. Thus, the icon image will always keep its
4999     * original aspect ratio.
5000     *
5001     * @see elm_icon_fill_outside_get()
5002     * @see elm_image_fill_outside_set()
5003     *
5004     * @ingroup Icon
5005     */
5006    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5007    /**
5008     * Get if the object is filled outside.
5009     *
5010     * @param obj The icon object
5011     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5012     *
5013     * @see elm_icon_fill_outside_set()
5014     *
5015     * @ingroup Icon
5016     */
5017    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5018    /**
5019     * Set the prescale size for the icon.
5020     *
5021     * @param obj The icon object
5022     * @param size The prescale size. This value is used for both width and
5023     * height.
5024     *
5025     * This function sets a new size for pixmap representation of the given
5026     * icon. It allows the icon to be loaded already in the specified size,
5027     * reducing the memory usage and load time when loading a big icon with load
5028     * size set to a smaller size.
5029     *
5030     * It's equivalent to the elm_bg_load_size_set() function for bg.
5031     *
5032     * @note this is just a hint, the real size of the pixmap may differ
5033     * depending on the type of icon being loaded, being bigger than requested.
5034     *
5035     * @see elm_icon_prescale_get()
5036     * @see elm_bg_load_size_set()
5037     *
5038     * @ingroup Icon
5039     */
5040    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5041    /**
5042     * Get the prescale size for the icon.
5043     *
5044     * @param obj The icon object
5045     * @return The prescale size
5046     *
5047     * @see elm_icon_prescale_set()
5048     *
5049     * @ingroup Icon
5050     */
5051    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5052    /**
5053     * Sets the icon lookup order used by elm_icon_standard_set().
5054     *
5055     * @param obj The icon object
5056     * @param order The icon lookup order (can be one of
5057     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5058     * or ELM_ICON_LOOKUP_THEME)
5059     *
5060     * @see elm_icon_order_lookup_get()
5061     * @see Elm_Icon_Lookup_Order
5062     *
5063     * @ingroup Icon
5064     */
5065    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5066    /**
5067     * Gets the icon lookup order.
5068     *
5069     * @param obj The icon object
5070     * @return The icon lookup order
5071     *
5072     * @see elm_icon_order_lookup_set()
5073     * @see Elm_Icon_Lookup_Order
5074     *
5075     * @ingroup Icon
5076     */
5077    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5078    /**
5079     * Get if the icon supports animation or not.
5080     *
5081     * @param obj The icon object
5082     * @return @c EINA_TRUE if the icon supports animation,
5083     *         @c EINA_FALSE otherwise.
5084     *
5085     * Return if this elm icon's image can be animated. Currently Evas only
5086     * supports gif animation. If the return value is EINA_FALSE, other
5087     * elm_icon_animated_XXX APIs won't work.
5088     * @ingroup Icon
5089     */
5090    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5091    /**
5092     * Set animation mode of the icon.
5093     *
5094     * @param obj The icon object
5095     * @param anim @c EINA_TRUE if the object do animation job,
5096     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5097     *
5098     * Since the default animation mode is set to EINA_FALSE, 
5099     * the icon is shown without animation.
5100     * This might be desirable when the application developer wants to show
5101     * a snapshot of the animated icon.
5102     * Set it to EINA_TRUE when the icon needs to be animated.
5103     * @ingroup Icon
5104     */
5105    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5106    /**
5107     * Get animation mode of the icon.
5108     *
5109     * @param obj The icon object
5110     * @return The animation mode of the icon object
5111     * @see elm_icon_animated_set
5112     * @ingroup Icon
5113     */
5114    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5115    /**
5116     * Set animation play mode of the icon.
5117     *
5118     * @param obj The icon object
5119     * @param play @c EINA_TRUE the object play animation images,
5120     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5121     *
5122     * To play elm icon's animation, set play to EINA_TURE.
5123     * For example, you make gif player using this set/get API and click event.
5124     *
5125     * 1. Click event occurs
5126     * 2. Check play flag using elm_icon_animaged_play_get
5127     * 3. If elm icon was playing, set play to EINA_FALSE.
5128     *    Then animation will be stopped and vice versa
5129     * @ingroup Icon
5130     */
5131    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5132    /**
5133     * Get animation play mode of the icon.
5134     *
5135     * @param obj The icon object
5136     * @return The play mode of the icon object
5137     *
5138     * @see elm_icon_animated_play_get
5139     * @ingroup Icon
5140     */
5141    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142
5143    /**
5144     * @}
5145     */
5146
5147    /**
5148     * @defgroup Image Image
5149     *
5150     * @image html img/widget/image/preview-00.png
5151     * @image latex img/widget/image/preview-00.eps
5152
5153     *
5154     * An object that allows one to load an image file to it. It can be used
5155     * anywhere like any other elementary widget.
5156     *
5157     * This widget provides most of the functionality provided from @ref Bg or @ref
5158     * Icon, but with a slightly different API (use the one that fits better your
5159     * needs).
5160     *
5161     * The features not provided by those two other image widgets are:
5162     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5163     * @li change the object orientation with elm_image_orient_set();
5164     * @li and turning the image editable with elm_image_editable_set().
5165     *
5166     * Signals that you can add callbacks for are:
5167     *
5168     * @li @c "clicked" - This is called when a user has clicked the image
5169     *
5170     * An example of usage for this API follows:
5171     * @li @ref tutorial_image
5172     */
5173
5174    /**
5175     * @addtogroup Image
5176     * @{
5177     */
5178
5179    /**
5180     * @enum _Elm_Image_Orient
5181     * @typedef Elm_Image_Orient
5182     *
5183     * Possible orientation options for elm_image_orient_set().
5184     *
5185     * @image html elm_image_orient_set.png
5186     * @image latex elm_image_orient_set.eps width=\textwidth
5187     *
5188     * @ingroup Image
5189     */
5190    typedef enum _Elm_Image_Orient
5191      {
5192         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5193         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5194         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5195         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5196         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5197         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5198         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5199         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5200      } Elm_Image_Orient;
5201
5202    /**
5203     * Add a new image to the parent.
5204     *
5205     * @param parent The parent object
5206     * @return The new object or NULL if it cannot be created
5207     *
5208     * @see elm_image_file_set()
5209     *
5210     * @ingroup Image
5211     */
5212    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5213    /**
5214     * Set the file that will be used as image.
5215     *
5216     * @param obj The image object
5217     * @param file The path to file that will be used as image
5218     * @param group The group that the image belongs in edje file (if it's an
5219     * edje image)
5220     *
5221     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5222     *
5223     * @see elm_image_file_get()
5224     *
5225     * @ingroup Image
5226     */
5227    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5228    /**
5229     * Get the file that will be used as image.
5230     *
5231     * @param obj The image object
5232     * @param file The path to file
5233     * @param group The group that the image belongs in edje file
5234     *
5235     * @see elm_image_file_set()
5236     *
5237     * @ingroup Image
5238     */
5239    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5240    /**
5241     * Set the smooth effect for an image.
5242     *
5243     * @param obj The image object
5244     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5245     * otherwise. Default is @c EINA_TRUE.
5246     *
5247     * Set the scaling algorithm to be used when scaling the image. Smooth
5248     * scaling provides a better resulting image, but is slower.
5249     *
5250     * The smooth scaling should be disabled when making animations that change
5251     * the image size, since it will be faster. Animations that don't require
5252     * resizing of the image can keep the smooth scaling enabled (even if the
5253     * image is already scaled, since the scaled image will be cached).
5254     *
5255     * @see elm_image_smooth_get()
5256     *
5257     * @ingroup Image
5258     */
5259    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5260    /**
5261     * Get the smooth effect for an image.
5262     *
5263     * @param obj The image object
5264     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5265     *
5266     * @see elm_image_smooth_get()
5267     *
5268     * @ingroup Image
5269     */
5270    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5271
5272    /**
5273     * Gets the current size of the image.
5274     *
5275     * @param obj The image object.
5276     * @param w Pointer to store width, or NULL.
5277     * @param h Pointer to store height, or NULL.
5278     *
5279     * This is the real size of the image, not the size of the object.
5280     *
5281     * On error, neither w or h will be written.
5282     *
5283     * @ingroup Image
5284     */
5285    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5286    /**
5287     * Disable scaling of this object.
5288     *
5289     * @param obj The image object.
5290     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5291     * otherwise. Default is @c EINA_FALSE.
5292     *
5293     * This function disables scaling of the elm_image widget through the
5294     * function elm_object_scale_set(). However, this does not affect the widget
5295     * size/resize in any way. For that effect, take a look at
5296     * elm_image_scale_set().
5297     *
5298     * @see elm_image_no_scale_get()
5299     * @see elm_image_scale_set()
5300     * @see elm_object_scale_set()
5301     *
5302     * @ingroup Image
5303     */
5304    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5305    /**
5306     * Get whether scaling is disabled on the object.
5307     *
5308     * @param obj The image object
5309     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5310     *
5311     * @see elm_image_no_scale_set()
5312     *
5313     * @ingroup Image
5314     */
5315    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316    /**
5317     * Set if the object is (up/down) resizable.
5318     *
5319     * @param obj The image object
5320     * @param scale_up A bool to set if the object is resizable up. Default is
5321     * @c EINA_TRUE.
5322     * @param scale_down A bool to set if the object is resizable down. Default
5323     * is @c EINA_TRUE.
5324     *
5325     * This function limits the image resize ability. If @p scale_up is set to
5326     * @c EINA_FALSE, the object can't have its height or width resized to a value
5327     * higher than the original image size. Same is valid for @p scale_down.
5328     *
5329     * @see elm_image_scale_get()
5330     *
5331     * @ingroup Image
5332     */
5333    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5334    /**
5335     * Get if the object is (up/down) resizable.
5336     *
5337     * @param obj The image object
5338     * @param scale_up A bool to set if the object is resizable up
5339     * @param scale_down A bool to set if the object is resizable down
5340     *
5341     * @see elm_image_scale_set()
5342     *
5343     * @ingroup Image
5344     */
5345    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5346    /**
5347     * Set if the image fills the entire object area, when keeping the aspect ratio.
5348     *
5349     * @param obj The image object
5350     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5351     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5352     *
5353     * When the image should keep its aspect ratio even if resized to another
5354     * aspect ratio, there are two possibilities to resize it: keep the entire
5355     * image inside the limits of height and width of the object (@p fill_outside
5356     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5357     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5358     *
5359     * @note This option will have no effect if
5360     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5361     *
5362     * @see elm_image_fill_outside_get()
5363     * @see elm_image_aspect_ratio_retained_set()
5364     *
5365     * @ingroup Image
5366     */
5367    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5368    /**
5369     * Get if the object is filled outside
5370     *
5371     * @param obj The image object
5372     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5373     *
5374     * @see elm_image_fill_outside_set()
5375     *
5376     * @ingroup Image
5377     */
5378    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5379    /**
5380     * Set the prescale size for the image
5381     *
5382     * @param obj The image object
5383     * @param size The prescale size. This value is used for both width and
5384     * height.
5385     *
5386     * This function sets a new size for pixmap representation of the given
5387     * image. It allows the image to be loaded already in the specified size,
5388     * reducing the memory usage and load time when loading a big image with load
5389     * size set to a smaller size.
5390     *
5391     * It's equivalent to the elm_bg_load_size_set() function for bg.
5392     *
5393     * @note this is just a hint, the real size of the pixmap may differ
5394     * depending on the type of image being loaded, being bigger than requested.
5395     *
5396     * @see elm_image_prescale_get()
5397     * @see elm_bg_load_size_set()
5398     *
5399     * @ingroup Image
5400     */
5401    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5402    /**
5403     * Get the prescale size for the image
5404     *
5405     * @param obj The image object
5406     * @return The prescale size
5407     *
5408     * @see elm_image_prescale_set()
5409     *
5410     * @ingroup Image
5411     */
5412    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5413    /**
5414     * Set the image orientation.
5415     *
5416     * @param obj The image object
5417     * @param orient The image orientation @ref Elm_Image_Orient
5418     *  Default is #ELM_IMAGE_ORIENT_NONE.
5419     *
5420     * This function allows to rotate or flip the given image.
5421     *
5422     * @see elm_image_orient_get()
5423     * @see @ref Elm_Image_Orient
5424     *
5425     * @ingroup Image
5426     */
5427    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5428    /**
5429     * Get the image orientation.
5430     *
5431     * @param obj The image object
5432     * @return The image orientation @ref Elm_Image_Orient
5433     *
5434     * @see elm_image_orient_set()
5435     * @see @ref Elm_Image_Orient
5436     *
5437     * @ingroup Image
5438     */
5439    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5440    /**
5441     * Make the image 'editable'.
5442     *
5443     * @param obj Image object.
5444     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5445     *
5446     * This means the image is a valid drag target for drag and drop, and can be
5447     * cut or pasted too.
5448     *
5449     * @ingroup Image
5450     */
5451    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5452    /**
5453     * Check if the image 'editable'.
5454     *
5455     * @param obj Image object.
5456     * @return Editability.
5457     *
5458     * A return value of EINA_TRUE means the image is a valid drag target
5459     * for drag and drop, and can be cut or pasted too.
5460     *
5461     * @ingroup Image
5462     */
5463    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5464    /**
5465     * Get the basic Evas_Image object from this object (widget).
5466     *
5467     * @param obj The image object to get the inlined image from
5468     * @return The inlined image object, or NULL if none exists
5469     *
5470     * This function allows one to get the underlying @c Evas_Object of type
5471     * Image from this elementary widget. It can be useful to do things like get
5472     * the pixel data, save the image to a file, etc.
5473     *
5474     * @note Be careful to not manipulate it, as it is under control of
5475     * elementary.
5476     *
5477     * @ingroup Image
5478     */
5479    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5480    /**
5481     * Set whether the original aspect ratio of the image should be kept on resize.
5482     *
5483     * @param obj The image object.
5484     * @param retained @c EINA_TRUE if the image should retain the aspect,
5485     * @c EINA_FALSE otherwise.
5486     *
5487     * The original aspect ratio (width / height) of the image is usually
5488     * distorted to match the object's size. Enabling this option will retain
5489     * this original aspect, and the way that the image is fit into the object's
5490     * area depends on the option set by elm_image_fill_outside_set().
5491     *
5492     * @see elm_image_aspect_ratio_retained_get()
5493     * @see elm_image_fill_outside_set()
5494     *
5495     * @ingroup Image
5496     */
5497    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5498    /**
5499     * Get if the object retains the original aspect ratio.
5500     *
5501     * @param obj The image object.
5502     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5503     * otherwise.
5504     *
5505     * @ingroup Image
5506     */
5507    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5508
5509    /**
5510     * @}
5511     */
5512
5513    /* glview */
5514    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5515
5516    typedef enum _Elm_GLView_Mode
5517      {
5518         ELM_GLVIEW_ALPHA   = 1,
5519         ELM_GLVIEW_DEPTH   = 2,
5520         ELM_GLVIEW_STENCIL = 4
5521      } Elm_GLView_Mode;
5522
5523    /**
5524     * Defines a policy for the glview resizing.
5525     *
5526     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5527     */
5528    typedef enum _Elm_GLView_Resize_Policy
5529      {
5530         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5531         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5532      } Elm_GLView_Resize_Policy;
5533
5534    typedef enum _Elm_GLView_Render_Policy
5535      {
5536         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5537         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5538      } Elm_GLView_Render_Policy;
5539
5540    /**
5541     * @defgroup GLView
5542     *
5543     * A simple GLView widget that allows GL rendering.
5544     *
5545     * Signals that you can add callbacks for are:
5546     *
5547     * @{
5548     */
5549
5550    /**
5551     * Add a new glview to the parent
5552     *
5553     * @param parent The parent object
5554     * @return The new object or NULL if it cannot be created
5555     *
5556     * @ingroup GLView
5557     */
5558    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5559
5560    /**
5561     * Sets the size of the glview
5562     *
5563     * @param obj The glview object
5564     * @param width width of the glview object
5565     * @param height height of the glview object
5566     *
5567     * @ingroup GLView
5568     */
5569    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5570
5571    /**
5572     * Gets the size of the glview.
5573     *
5574     * @param obj The glview object
5575     * @param width width of the glview object
5576     * @param height height of the glview object
5577     *
5578     * Note that this function returns the actual image size of the
5579     * glview.  This means that when the scale policy is set to
5580     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5581     * size.
5582     *
5583     * @ingroup GLView
5584     */
5585    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5586
5587    /**
5588     * Gets the gl api struct for gl rendering
5589     *
5590     * @param obj The glview object
5591     * @return The api object or NULL if it cannot be created
5592     *
5593     * @ingroup GLView
5594     */
5595    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5596
5597    /**
5598     * Set the mode of the GLView. Supports Three simple modes.
5599     *
5600     * @param obj The glview object
5601     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5602     * @return True if set properly.
5603     *
5604     * @ingroup GLView
5605     */
5606    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5607
5608    /**
5609     * Set the resize policy for the glview object.
5610     *
5611     * @param obj The glview object.
5612     * @param policy The scaling policy.
5613     *
5614     * By default, the resize policy is set to
5615     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5616     * destroys the previous surface and recreates the newly specified
5617     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5618     * however, glview only scales the image object and not the underlying
5619     * GL Surface.
5620     *
5621     * @ingroup GLView
5622     */
5623    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5624
5625    /**
5626     * Set the render policy for the glview object.
5627     *
5628     * @param obj The glview object.
5629     * @param policy The render policy.
5630     *
5631     * By default, the render policy is set to
5632     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5633     * that during the render loop, glview is only redrawn if it needs
5634     * to be redrawn. (i.e. When it is visible) If the policy is set to
5635     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5636     * whether it is visible/need redrawing or not.
5637     *
5638     * @ingroup GLView
5639     */
5640    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5641
5642    /**
5643     * Set the init function that runs once in the main loop.
5644     *
5645     * @param obj The glview object.
5646     * @param func The init function to be registered.
5647     *
5648     * The registered init function gets called once during the render loop.
5649     *
5650     * @ingroup GLView
5651     */
5652    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5653
5654    /**
5655     * Set the render function that runs in the main loop.
5656     *
5657     * @param obj The glview object.
5658     * @param func The delete function to be registered.
5659     *
5660     * The registered del function gets called when GLView object is deleted.
5661     *
5662     * @ingroup GLView
5663     */
5664    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5665
5666    /**
5667     * Set the resize function that gets called when resize happens.
5668     *
5669     * @param obj The glview object.
5670     * @param func The resize function to be registered.
5671     *
5672     * @ingroup GLView
5673     */
5674    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5675
5676    /**
5677     * Set the render function that runs in the main loop.
5678     *
5679     * @param obj The glview object.
5680     * @param func The render function to be registered.
5681     *
5682     * @ingroup GLView
5683     */
5684    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5685
5686    /**
5687     * Notifies that there has been changes in the GLView.
5688     *
5689     * @param obj The glview object.
5690     *
5691     * @ingroup GLView
5692     */
5693    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5694
5695    /**
5696     * @}
5697     */
5698
5699    /* box */
5700    /**
5701     * @defgroup Box Box
5702     *
5703     * @image html img/widget/box/preview-00.png
5704     * @image latex img/widget/box/preview-00.eps width=\textwidth
5705     *
5706     * @image html img/box.png
5707     * @image latex img/box.eps width=\textwidth
5708     *
5709     * A box arranges objects in a linear fashion, governed by a layout function
5710     * that defines the details of this arrangement.
5711     *
5712     * By default, the box will use an internal function to set the layout to
5713     * a single row, either vertical or horizontal. This layout is affected
5714     * by a number of parameters, such as the homogeneous flag set by
5715     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5716     * elm_box_align_set() and the hints set to each object in the box.
5717     *
5718     * For this default layout, it's possible to change the orientation with
5719     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5720     * placing its elements ordered from top to bottom. When horizontal is set,
5721     * the order will go from left to right. If the box is set to be
5722     * homogeneous, every object in it will be assigned the same space, that
5723     * of the largest object. Padding can be used to set some spacing between
5724     * the cell given to each object. The alignment of the box, set with
5725     * elm_box_align_set(), determines how the bounding box of all the elements
5726     * will be placed within the space given to the box widget itself.
5727     *
5728     * The size hints of each object also affect how they are placed and sized
5729     * within the box. evas_object_size_hint_min_set() will give the minimum
5730     * size the object can have, and the box will use it as the basis for all
5731     * latter calculations. Elementary widgets set their own minimum size as
5732     * needed, so there's rarely any need to use it manually.
5733     *
5734     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5735     * used to tell whether the object will be allocated the minimum size it
5736     * needs or if the space given to it should be expanded. It's important
5737     * to realize that expanding the size given to the object is not the same
5738     * thing as resizing the object. It could very well end being a small
5739     * widget floating in a much larger empty space. If not set, the weight
5740     * for objects will normally be 0.0 for both axis, meaning the widget will
5741     * not be expanded. To take as much space possible, set the weight to
5742     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5743     *
5744     * Besides how much space each object is allocated, it's possible to control
5745     * how the widget will be placed within that space using
5746     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5747     * for both axis, meaning the object will be centered, but any value from
5748     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5749     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5750     * is -1.0, means the object will be resized to fill the entire space it
5751     * was allocated.
5752     *
5753     * In addition, customized functions to define the layout can be set, which
5754     * allow the application developer to organize the objects within the box
5755     * in any number of ways.
5756     *
5757     * The special elm_box_layout_transition() function can be used
5758     * to switch from one layout to another, animating the motion of the
5759     * children of the box.
5760     *
5761     * @note Objects should not be added to box objects using _add() calls.
5762     *
5763     * Some examples on how to use boxes follow:
5764     * @li @ref box_example_01
5765     * @li @ref box_example_02
5766     *
5767     * @{
5768     */
5769    /**
5770     * @typedef Elm_Box_Transition
5771     *
5772     * Opaque handler containing the parameters to perform an animated
5773     * transition of the layout the box uses.
5774     *
5775     * @see elm_box_transition_new()
5776     * @see elm_box_layout_set()
5777     * @see elm_box_layout_transition()
5778     */
5779    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5780
5781    /**
5782     * Add a new box to the parent
5783     *
5784     * By default, the box will be in vertical mode and non-homogeneous.
5785     *
5786     * @param parent The parent object
5787     * @return The new object or NULL if it cannot be created
5788     */
5789    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5790    /**
5791     * Set the horizontal orientation
5792     *
5793     * By default, box object arranges their contents vertically from top to
5794     * bottom.
5795     * By calling this function with @p horizontal as EINA_TRUE, the box will
5796     * become horizontal, arranging contents from left to right.
5797     *
5798     * @note This flag is ignored if a custom layout function is set.
5799     *
5800     * @param obj The box object
5801     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5802     * EINA_FALSE = vertical)
5803     */
5804    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5805    /**
5806     * Get the horizontal orientation
5807     *
5808     * @param obj The box object
5809     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5810     */
5811    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5812    /**
5813     * Set the box to arrange its children homogeneously
5814     *
5815     * If enabled, homogeneous layout makes all items the same size, according
5816     * to the size of the largest of its children.
5817     *
5818     * @note This flag is ignored if a custom layout function is set.
5819     *
5820     * @param obj The box object
5821     * @param homogeneous The homogeneous flag
5822     */
5823    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5824    /**
5825     * Get whether the box is using homogeneous mode or not
5826     *
5827     * @param obj The box object
5828     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5829     */
5830    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5832    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5833    /**
5834     * Add an object to the beginning of the pack list
5835     *
5836     * Pack @p subobj into the box @p obj, placing it first in the list of
5837     * children objects. The actual position the object will get on screen
5838     * depends on the layout used. If no custom layout is set, it will be at
5839     * the top or left, depending if the box is vertical or horizontal,
5840     * respectively.
5841     *
5842     * @param obj The box object
5843     * @param subobj The object to add to the box
5844     *
5845     * @see elm_box_pack_end()
5846     * @see elm_box_pack_before()
5847     * @see elm_box_pack_after()
5848     * @see elm_box_unpack()
5849     * @see elm_box_unpack_all()
5850     * @see elm_box_clear()
5851     */
5852    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5853    /**
5854     * Add an object at the end of the pack list
5855     *
5856     * Pack @p subobj into the box @p obj, placing it last in the list of
5857     * children objects. The actual position the object will get on screen
5858     * depends on the layout used. If no custom layout is set, it will be at
5859     * the bottom or right, depending if the box is vertical or horizontal,
5860     * respectively.
5861     *
5862     * @param obj The box object
5863     * @param subobj The object to add to the box
5864     *
5865     * @see elm_box_pack_start()
5866     * @see elm_box_pack_before()
5867     * @see elm_box_pack_after()
5868     * @see elm_box_unpack()
5869     * @see elm_box_unpack_all()
5870     * @see elm_box_clear()
5871     */
5872    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5873    /**
5874     * Adds an object to the box before the indicated object
5875     *
5876     * This will add the @p subobj to the box indicated before the object
5877     * indicated with @p before. If @p before is not already in the box, results
5878     * are undefined. Before means either to the left of the indicated object or
5879     * above it depending on orientation.
5880     *
5881     * @param obj The box object
5882     * @param subobj The object to add to the box
5883     * @param before The object before which to add it
5884     *
5885     * @see elm_box_pack_start()
5886     * @see elm_box_pack_end()
5887     * @see elm_box_pack_after()
5888     * @see elm_box_unpack()
5889     * @see elm_box_unpack_all()
5890     * @see elm_box_clear()
5891     */
5892    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5893    /**
5894     * Adds an object to the box after the indicated object
5895     *
5896     * This will add the @p subobj to the box indicated after the object
5897     * indicated with @p after. If @p after is not already in the box, results
5898     * are undefined. After means either to the right of the indicated object or
5899     * below it depending on orientation.
5900     *
5901     * @param obj The box object
5902     * @param subobj The object to add to the box
5903     * @param after The object after which to add it
5904     *
5905     * @see elm_box_pack_start()
5906     * @see elm_box_pack_end()
5907     * @see elm_box_pack_before()
5908     * @see elm_box_unpack()
5909     * @see elm_box_unpack_all()
5910     * @see elm_box_clear()
5911     */
5912    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5913    /**
5914     * Clear the box of all children
5915     *
5916     * Remove all the elements contained by the box, deleting the respective
5917     * objects.
5918     *
5919     * @param obj The box object
5920     *
5921     * @see elm_box_unpack()
5922     * @see elm_box_unpack_all()
5923     */
5924    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5925    /**
5926     * Unpack a box item
5927     *
5928     * Remove the object given by @p subobj from the box @p obj without
5929     * deleting it.
5930     *
5931     * @param obj The box object
5932     *
5933     * @see elm_box_unpack_all()
5934     * @see elm_box_clear()
5935     */
5936    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5937    /**
5938     * Remove all items from the box, without deleting them
5939     *
5940     * Clear the box from all children, but don't delete the respective objects.
5941     * If no other references of the box children exist, the objects will never
5942     * be deleted, and thus the application will leak the memory. Make sure
5943     * when using this function that you hold a reference to all the objects
5944     * in the box @p obj.
5945     *
5946     * @param obj The box object
5947     *
5948     * @see elm_box_clear()
5949     * @see elm_box_unpack()
5950     */
5951    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5952    /**
5953     * Retrieve a list of the objects packed into the box
5954     *
5955     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5956     * The order of the list corresponds to the packing order the box uses.
5957     *
5958     * You must free this list with eina_list_free() once you are done with it.
5959     *
5960     * @param obj The box object
5961     */
5962    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5963    /**
5964     * Set the space (padding) between the box's elements.
5965     *
5966     * Extra space in pixels that will be added between a box child and its
5967     * neighbors after its containing cell has been calculated. This padding
5968     * is set for all elements in the box, besides any possible padding that
5969     * individual elements may have through their size hints.
5970     *
5971     * @param obj The box object
5972     * @param horizontal The horizontal space between elements
5973     * @param vertical The vertical space between elements
5974     */
5975    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5976    /**
5977     * Get the space (padding) between the box's elements.
5978     *
5979     * @param obj The box object
5980     * @param horizontal The horizontal space between elements
5981     * @param vertical The vertical space between elements
5982     *
5983     * @see elm_box_padding_set()
5984     */
5985    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5986    /**
5987     * Set the alignment of the whole bouding box of contents.
5988     *
5989     * Sets how the bounding box containing all the elements of the box, after
5990     * their sizes and position has been calculated, will be aligned within
5991     * the space given for the whole box widget.
5992     *
5993     * @param obj The box object
5994     * @param horizontal The horizontal alignment of elements
5995     * @param vertical The vertical alignment of elements
5996     */
5997    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5998    /**
5999     * Get the alignment of the whole bouding box of contents.
6000     *
6001     * @param obj The box object
6002     * @param horizontal The horizontal alignment of elements
6003     * @param vertical The vertical alignment of elements
6004     *
6005     * @see elm_box_align_set()
6006     */
6007    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6008
6009    /**
6010     * Force the box to recalculate its children packing.
6011     *
6012     * If any children was added or removed, box will not calculate the
6013     * values immediately rather leaving it to the next main loop
6014     * iteration. While this is great as it would save lots of
6015     * recalculation, whenever you need to get the position of a just
6016     * added item you must force recalculate before doing so.
6017     *
6018     * @param obj The box object.
6019     */
6020    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6021
6022    /**
6023     * Set the layout defining function to be used by the box
6024     *
6025     * Whenever anything changes that requires the box in @p obj to recalculate
6026     * the size and position of its elements, the function @p cb will be called
6027     * to determine what the layout of the children will be.
6028     *
6029     * Once a custom function is set, everything about the children layout
6030     * is defined by it. The flags set by elm_box_horizontal_set() and
6031     * elm_box_homogeneous_set() no longer have any meaning, and the values
6032     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6033     * layout function to decide if they are used and how. These last two
6034     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6035     * passed to @p cb. The @c Evas_Object the function receives is not the
6036     * Elementary widget, but the internal Evas Box it uses, so none of the
6037     * functions described here can be used on it.
6038     *
6039     * Any of the layout functions in @c Evas can be used here, as well as the
6040     * special elm_box_layout_transition().
6041     *
6042     * The final @p data argument received by @p cb is the same @p data passed
6043     * here, and the @p free_data function will be called to free it
6044     * whenever the box is destroyed or another layout function is set.
6045     *
6046     * Setting @p cb to NULL will revert back to the default layout function.
6047     *
6048     * @param obj The box object
6049     * @param cb The callback function used for layout
6050     * @param data Data that will be passed to layout function
6051     * @param free_data Function called to free @p data
6052     *
6053     * @see elm_box_layout_transition()
6054     */
6055    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);
6056    /**
6057     * Special layout function that animates the transition from one layout to another
6058     *
6059     * Normally, when switching the layout function for a box, this will be
6060     * reflected immediately on screen on the next render, but it's also
6061     * possible to do this through an animated transition.
6062     *
6063     * This is done by creating an ::Elm_Box_Transition and setting the box
6064     * layout to this function.
6065     *
6066     * For example:
6067     * @code
6068     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6069     *                            evas_object_box_layout_vertical, // start
6070     *                            NULL, // data for initial layout
6071     *                            NULL, // free function for initial data
6072     *                            evas_object_box_layout_horizontal, // end
6073     *                            NULL, // data for final layout
6074     *                            NULL, // free function for final data
6075     *                            anim_end, // will be called when animation ends
6076     *                            NULL); // data for anim_end function\
6077     * elm_box_layout_set(box, elm_box_layout_transition, t,
6078     *                    elm_box_transition_free);
6079     * @endcode
6080     *
6081     * @note This function can only be used with elm_box_layout_set(). Calling
6082     * it directly will not have the expected results.
6083     *
6084     * @see elm_box_transition_new
6085     * @see elm_box_transition_free
6086     * @see elm_box_layout_set
6087     */
6088    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6089    /**
6090     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6091     *
6092     * If you want to animate the change from one layout to another, you need
6093     * to set the layout function of the box to elm_box_layout_transition(),
6094     * passing as user data to it an instance of ::Elm_Box_Transition with the
6095     * necessary information to perform this animation. The free function to
6096     * set for the layout is elm_box_transition_free().
6097     *
6098     * The parameters to create an ::Elm_Box_Transition sum up to how long
6099     * will it be, in seconds, a layout function to describe the initial point,
6100     * another for the final position of the children and one function to be
6101     * called when the whole animation ends. This last function is useful to
6102     * set the definitive layout for the box, usually the same as the end
6103     * layout for the animation, but could be used to start another transition.
6104     *
6105     * @param start_layout The layout function that will be used to start the animation
6106     * @param start_layout_data The data to be passed the @p start_layout function
6107     * @param start_layout_free_data Function to free @p start_layout_data
6108     * @param end_layout The layout function that will be used to end the animation
6109     * @param end_layout_free_data The data to be passed the @p end_layout function
6110     * @param end_layout_free_data Function to free @p end_layout_data
6111     * @param transition_end_cb Callback function called when animation ends
6112     * @param transition_end_data Data to be passed to @p transition_end_cb
6113     * @return An instance of ::Elm_Box_Transition
6114     *
6115     * @see elm_box_transition_new
6116     * @see elm_box_layout_transition
6117     */
6118    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);
6119    /**
6120     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6121     *
6122     * This function is mostly useful as the @c free_data parameter in
6123     * elm_box_layout_set() when elm_box_layout_transition().
6124     *
6125     * @param data The Elm_Box_Transition instance to be freed.
6126     *
6127     * @see elm_box_transition_new
6128     * @see elm_box_layout_transition
6129     */
6130    EAPI void                elm_box_transition_free(void *data);
6131    /**
6132     * @}
6133     */
6134
6135    /* button */
6136    /**
6137     * @defgroup Button Button
6138     *
6139     * @image html img/widget/button/preview-00.png
6140     * @image latex img/widget/button/preview-00.eps
6141     * @image html img/widget/button/preview-01.png
6142     * @image latex img/widget/button/preview-01.eps
6143     * @image html img/widget/button/preview-02.png
6144     * @image latex img/widget/button/preview-02.eps
6145     *
6146     * This is a push-button. Press it and run some function. It can contain
6147     * a simple label and icon object and it also has an autorepeat feature.
6148     *
6149     * This widgets emits the following signals:
6150     * @li "clicked": the user clicked the button (press/release).
6151     * @li "repeated": the user pressed the button without releasing it.
6152     * @li "pressed": button was pressed.
6153     * @li "unpressed": button was released after being pressed.
6154     * In all three cases, the @c event parameter of the callback will be
6155     * @c NULL.
6156     *
6157     * Also, defined in the default theme, the button has the following styles
6158     * available:
6159     * @li default: a normal button.
6160     * @li anchor: Like default, but the button fades away when the mouse is not
6161     * over it, leaving only the text or icon.
6162     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6163     * continuous look across its options.
6164     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6165     *
6166     * Default contents parts of the button widget that you can use for are:
6167     * @li "elm.swallow.content" - A icon of the button
6168     *
6169     * Default text parts of the button widget that you can use for are:
6170     * @li "elm.text" - Label of the button
6171     *
6172     * Follow through a complete example @ref button_example_01 "here".
6173     * @{
6174     */
6175    /**
6176     * Add a new button to the parent's canvas
6177     *
6178     * @param parent The parent object
6179     * @return The new object or NULL if it cannot be created
6180     */
6181    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6182    /**
6183     * Set the label used in the button
6184     *
6185     * The passed @p label can be NULL to clean any existing text in it and
6186     * leave the button as an icon only object.
6187     *
6188     * @param obj The button object
6189     * @param label The text will be written on the button
6190     * @deprecated use elm_object_text_set() instead.
6191     */
6192    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6193    /**
6194     * Get the label set for the button
6195     *
6196     * The string returned is an internal pointer and should not be freed or
6197     * altered. It will also become invalid when the button is destroyed.
6198     * The string returned, if not NULL, is a stringshare, so if you need to
6199     * keep it around even after the button is destroyed, you can use
6200     * eina_stringshare_ref().
6201     *
6202     * @param obj The button object
6203     * @return The text set to the label, or NULL if nothing is set
6204     * @deprecated use elm_object_text_set() instead.
6205     */
6206    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6207    /**
6208     * Set the icon used for the button
6209     *
6210     * Setting a new icon will delete any other that was previously set, making
6211     * any reference to them invalid. If you need to maintain the previous
6212     * object alive, unset it first with elm_button_icon_unset().
6213     *
6214     * @param obj The button object
6215     * @param icon The icon object for the button
6216     */
6217    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6218    /**
6219     * Get the icon used for the button
6220     *
6221     * Return the icon object which is set for this widget. If the button is
6222     * destroyed or another icon is set, the returned object will be deleted
6223     * and any reference to it will be invalid.
6224     *
6225     * @param obj The button object
6226     * @return The icon object that is being used
6227     *
6228     * @see elm_button_icon_unset()
6229     */
6230    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6231    /**
6232     * Remove the icon set without deleting it and return the object
6233     *
6234     * This function drops the reference the button holds of the icon object
6235     * and returns this last object. It is used in case you want to remove any
6236     * icon, or set another one, without deleting the actual object. The button
6237     * will be left without an icon set.
6238     *
6239     * @param obj The button object
6240     * @return The icon object that was being used
6241     */
6242    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6243    /**
6244     * Turn on/off the autorepeat event generated when the button is kept pressed
6245     *
6246     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6247     * signal when they are clicked.
6248     *
6249     * When on, keeping a button pressed will continuously emit a @c repeated
6250     * signal until the button is released. The time it takes until it starts
6251     * emitting the signal is given by
6252     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6253     * new emission by elm_button_autorepeat_gap_timeout_set().
6254     *
6255     * @param obj The button object
6256     * @param on  A bool to turn on/off the event
6257     */
6258    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6259    /**
6260     * Get whether the autorepeat feature is enabled
6261     *
6262     * @param obj The button object
6263     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6264     *
6265     * @see elm_button_autorepeat_set()
6266     */
6267    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6268    /**
6269     * Set the initial timeout before the autorepeat event is generated
6270     *
6271     * Sets the timeout, in seconds, since the button is pressed until the
6272     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6273     * won't be any delay and the even will be fired the moment the button is
6274     * pressed.
6275     *
6276     * @param obj The button object
6277     * @param t   Timeout in seconds
6278     *
6279     * @see elm_button_autorepeat_set()
6280     * @see elm_button_autorepeat_gap_timeout_set()
6281     */
6282    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6283    /**
6284     * Get the initial timeout before the autorepeat event is generated
6285     *
6286     * @param obj The button object
6287     * @return Timeout in seconds
6288     *
6289     * @see elm_button_autorepeat_initial_timeout_set()
6290     */
6291    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6292    /**
6293     * Set the interval between each generated autorepeat event
6294     *
6295     * After the first @c repeated event is fired, all subsequent ones will
6296     * follow after a delay of @p t seconds for each.
6297     *
6298     * @param obj The button object
6299     * @param t   Interval in seconds
6300     *
6301     * @see elm_button_autorepeat_initial_timeout_set()
6302     */
6303    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6304    /**
6305     * Get the interval between each generated autorepeat event
6306     *
6307     * @param obj The button object
6308     * @return Interval in seconds
6309     */
6310    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6311    /**
6312     * @}
6313     */
6314
6315    /**
6316     * @defgroup File_Selector_Button File Selector Button
6317     *
6318     * @image html img/widget/fileselector_button/preview-00.png
6319     * @image latex img/widget/fileselector_button/preview-00.eps
6320     * @image html img/widget/fileselector_button/preview-01.png
6321     * @image latex img/widget/fileselector_button/preview-01.eps
6322     * @image html img/widget/fileselector_button/preview-02.png
6323     * @image latex img/widget/fileselector_button/preview-02.eps
6324     *
6325     * This is a button that, when clicked, creates an Elementary
6326     * window (or inner window) <b> with a @ref Fileselector "file
6327     * selector widget" within</b>. When a file is chosen, the (inner)
6328     * window is closed and the button emits a signal having the
6329     * selected file as it's @c event_info.
6330     *
6331     * This widget encapsulates operations on its internal file
6332     * selector on its own API. There is less control over its file
6333     * selector than that one would have instatiating one directly.
6334     *
6335     * The following styles are available for this button:
6336     * @li @c "default"
6337     * @li @c "anchor"
6338     * @li @c "hoversel_vertical"
6339     * @li @c "hoversel_vertical_entry"
6340     *
6341     * Smart callbacks one can register to:
6342     * - @c "file,chosen" - the user has selected a path, whose string
6343     *   pointer comes as the @c event_info data (a stringshared
6344     *   string)
6345     *
6346     * Here is an example on its usage:
6347     * @li @ref fileselector_button_example
6348     *
6349     * @see @ref File_Selector_Entry for a similar widget.
6350     * @{
6351     */
6352
6353    /**
6354     * Add a new file selector button widget to the given parent
6355     * Elementary (container) object
6356     *
6357     * @param parent The parent object
6358     * @return a new file selector button widget handle or @c NULL, on
6359     * errors
6360     */
6361    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6362
6363    /**
6364     * Set the label for a given file selector button widget
6365     *
6366     * @param obj The file selector button widget
6367     * @param label The text label to be displayed on @p obj
6368     *
6369     * @deprecated use elm_object_text_set() instead.
6370     */
6371    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6372
6373    /**
6374     * Get the label set for a given file selector button widget
6375     *
6376     * @param obj The file selector button widget
6377     * @return The button label
6378     *
6379     * @deprecated use elm_object_text_set() instead.
6380     */
6381    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6382
6383    /**
6384     * Set the icon on a given file selector button widget
6385     *
6386     * @param obj The file selector button widget
6387     * @param icon The icon object for the button
6388     *
6389     * Once the icon object is set, a previously set one will be
6390     * deleted. If you want to keep the latter, use the
6391     * elm_fileselector_button_icon_unset() function.
6392     *
6393     * @see elm_fileselector_button_icon_get()
6394     */
6395    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6396
6397    /**
6398     * Get the icon set for a given file selector button widget
6399     *
6400     * @param obj The file selector button widget
6401     * @return The icon object currently set on @p obj or @c NULL, if
6402     * none is
6403     *
6404     * @see elm_fileselector_button_icon_set()
6405     */
6406    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6407
6408    /**
6409     * Unset the icon used in a given file selector button widget
6410     *
6411     * @param obj The file selector button widget
6412     * @return The icon object that was being used on @p obj or @c
6413     * NULL, on errors
6414     *
6415     * Unparent and return the icon object which was set for this
6416     * widget.
6417     *
6418     * @see elm_fileselector_button_icon_set()
6419     */
6420    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6421
6422    /**
6423     * Set the title for a given file selector button widget's window
6424     *
6425     * @param obj The file selector button widget
6426     * @param title The title string
6427     *
6428     * This will change the window's title, when the file selector pops
6429     * out after a click on the button. Those windows have the default
6430     * (unlocalized) value of @c "Select a file" as titles.
6431     *
6432     * @note It will only take any effect if the file selector
6433     * button widget is @b not under "inwin mode".
6434     *
6435     * @see elm_fileselector_button_window_title_get()
6436     */
6437    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6438
6439    /**
6440     * Get the title set for a given file selector button widget's
6441     * window
6442     *
6443     * @param obj The file selector button widget
6444     * @return Title of the file selector button's window
6445     *
6446     * @see elm_fileselector_button_window_title_get() for more details
6447     */
6448    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6449
6450    /**
6451     * Set the size of a given file selector button widget's window,
6452     * holding the file selector itself.
6453     *
6454     * @param obj The file selector button widget
6455     * @param width The window's width
6456     * @param height The window's height
6457     *
6458     * @note it will only take any effect if the file selector button
6459     * widget is @b not under "inwin mode". The default size for the
6460     * window (when applicable) is 400x400 pixels.
6461     *
6462     * @see elm_fileselector_button_window_size_get()
6463     */
6464    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6465
6466    /**
6467     * Get the size of a given file selector button widget's window,
6468     * holding the file selector itself.
6469     *
6470     * @param obj The file selector button widget
6471     * @param width Pointer into which to store the width value
6472     * @param height Pointer into which to store the height value
6473     *
6474     * @note Use @c NULL pointers on the size values you're not
6475     * interested in: they'll be ignored by the function.
6476     *
6477     * @see elm_fileselector_button_window_size_set(), for more details
6478     */
6479    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6480
6481    /**
6482     * Set the initial file system path for a given file selector
6483     * button widget
6484     *
6485     * @param obj The file selector button widget
6486     * @param path The path string
6487     *
6488     * It must be a <b>directory</b> path, which will have the contents
6489     * displayed initially in the file selector's view, when invoked
6490     * from @p obj. The default initial path is the @c "HOME"
6491     * environment variable's value.
6492     *
6493     * @see elm_fileselector_button_path_get()
6494     */
6495    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6496
6497    /**
6498     * Get the initial file system path set for a given file selector
6499     * button widget
6500     *
6501     * @param obj The file selector button widget
6502     * @return path The path string
6503     *
6504     * @see elm_fileselector_button_path_set() for more details
6505     */
6506    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6507
6508    /**
6509     * Enable/disable a tree view in the given file selector button
6510     * widget's internal file selector
6511     *
6512     * @param obj The file selector button widget
6513     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6514     * disable
6515     *
6516     * This has the same effect as elm_fileselector_expandable_set(),
6517     * but now applied to a file selector button's internal file
6518     * selector.
6519     *
6520     * @note There's no way to put a file selector button's internal
6521     * file selector in "grid mode", as one may do with "pure" file
6522     * selectors.
6523     *
6524     * @see elm_fileselector_expandable_get()
6525     */
6526    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6527
6528    /**
6529     * Get whether tree view is enabled for the given file selector
6530     * button widget's internal file selector
6531     *
6532     * @param obj The file selector button widget
6533     * @return @c EINA_TRUE if @p obj widget's internal file selector
6534     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6535     *
6536     * @see elm_fileselector_expandable_set() for more details
6537     */
6538    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6539
6540    /**
6541     * Set whether a given file selector button widget's internal file
6542     * selector is to display folders only or the directory contents,
6543     * as well.
6544     *
6545     * @param obj The file selector button widget
6546     * @param only @c EINA_TRUE to make @p obj widget's internal file
6547     * selector only display directories, @c EINA_FALSE to make files
6548     * to be displayed in it too
6549     *
6550     * This has the same effect as elm_fileselector_folder_only_set(),
6551     * but now applied to a file selector button's internal file
6552     * selector.
6553     *
6554     * @see elm_fileselector_folder_only_get()
6555     */
6556    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6557
6558    /**
6559     * Get whether a given file selector button widget's internal file
6560     * selector is displaying folders only or the directory contents,
6561     * as well.
6562     *
6563     * @param obj The file selector button widget
6564     * @return @c EINA_TRUE if @p obj widget's internal file
6565     * selector is only displaying directories, @c EINA_FALSE if files
6566     * are being displayed in it too (and on errors)
6567     *
6568     * @see elm_fileselector_button_folder_only_set() for more details
6569     */
6570    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6571
6572    /**
6573     * Enable/disable the file name entry box where the user can type
6574     * in a name for a file, in a given file selector button widget's
6575     * internal file selector.
6576     *
6577     * @param obj The file selector button widget
6578     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6579     * file selector a "saving dialog", @c EINA_FALSE otherwise
6580     *
6581     * This has the same effect as elm_fileselector_is_save_set(),
6582     * but now applied to a file selector button's internal file
6583     * selector.
6584     *
6585     * @see elm_fileselector_is_save_get()
6586     */
6587    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6588
6589    /**
6590     * Get whether the given file selector button widget's internal
6591     * file selector is in "saving dialog" mode
6592     *
6593     * @param obj The file selector button widget
6594     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6595     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6596     * errors)
6597     *
6598     * @see elm_fileselector_button_is_save_set() for more details
6599     */
6600    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6601
6602    /**
6603     * Set whether a given file selector button widget's internal file
6604     * selector will raise an Elementary "inner window", instead of a
6605     * dedicated Elementary window. By default, it won't.
6606     *
6607     * @param obj The file selector button widget
6608     * @param value @c EINA_TRUE to make it use an inner window, @c
6609     * EINA_TRUE to make it use a dedicated window
6610     *
6611     * @see elm_win_inwin_add() for more information on inner windows
6612     * @see elm_fileselector_button_inwin_mode_get()
6613     */
6614    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6615
6616    /**
6617     * Get whether a given file selector button widget's internal file
6618     * selector will raise an Elementary "inner window", instead of a
6619     * dedicated Elementary window.
6620     *
6621     * @param obj The file selector button widget
6622     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6623     * if it will use a dedicated window
6624     *
6625     * @see elm_fileselector_button_inwin_mode_set() for more details
6626     */
6627    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628
6629    /**
6630     * @}
6631     */
6632
6633     /**
6634     * @defgroup File_Selector_Entry File Selector Entry
6635     *
6636     * @image html img/widget/fileselector_entry/preview-00.png
6637     * @image latex img/widget/fileselector_entry/preview-00.eps
6638     *
6639     * This is an entry made to be filled with or display a <b>file
6640     * system path string</b>. Besides the entry itself, the widget has
6641     * a @ref File_Selector_Button "file selector button" on its side,
6642     * which will raise an internal @ref Fileselector "file selector widget",
6643     * when clicked, for path selection aided by file system
6644     * navigation.
6645     *
6646     * This file selector may appear in an Elementary window or in an
6647     * inner window. When a file is chosen from it, the (inner) window
6648     * is closed and the selected file's path string is exposed both as
6649     * an smart event and as the new text on the entry.
6650     *
6651     * This widget encapsulates operations on its internal file
6652     * selector on its own API. There is less control over its file
6653     * selector than that one would have instatiating one directly.
6654     *
6655     * Smart callbacks one can register to:
6656     * - @c "changed" - The text within the entry was changed
6657     * - @c "activated" - The entry has had editing finished and
6658     *   changes are to be "committed"
6659     * - @c "press" - The entry has been clicked
6660     * - @c "longpressed" - The entry has been clicked (and held) for a
6661     *   couple seconds
6662     * - @c "clicked" - The entry has been clicked
6663     * - @c "clicked,double" - The entry has been double clicked
6664     * - @c "focused" - The entry has received focus
6665     * - @c "unfocused" - The entry has lost focus
6666     * - @c "selection,paste" - A paste action has occurred on the
6667     *   entry
6668     * - @c "selection,copy" - A copy action has occurred on the entry
6669     * - @c "selection,cut" - A cut action has occurred on the entry
6670     * - @c "unpressed" - The file selector entry's button was released
6671     *   after being pressed.
6672     * - @c "file,chosen" - The user has selected a path via the file
6673     *   selector entry's internal file selector, whose string pointer
6674     *   comes as the @c event_info data (a stringshared string)
6675     *
6676     * Here is an example on its usage:
6677     * @li @ref fileselector_entry_example
6678     *
6679     * @see @ref File_Selector_Button for a similar widget.
6680     * @{
6681     */
6682
6683    /**
6684     * Add a new file selector entry widget to the given parent
6685     * Elementary (container) object
6686     *
6687     * @param parent The parent object
6688     * @return a new file selector entry widget handle or @c NULL, on
6689     * errors
6690     */
6691    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6692
6693    /**
6694     * Set the label for a given file selector entry widget's button
6695     *
6696     * @param obj The file selector entry widget
6697     * @param label The text label to be displayed on @p obj widget's
6698     * button
6699     *
6700     * @deprecated use elm_object_text_set() instead.
6701     */
6702    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6703
6704    /**
6705     * Get the label set for a given file selector entry widget's button
6706     *
6707     * @param obj The file selector entry widget
6708     * @return The widget button's label
6709     *
6710     * @deprecated use elm_object_text_set() instead.
6711     */
6712    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6713
6714    /**
6715     * Set the icon on a given file selector entry widget's button
6716     *
6717     * @param obj The file selector entry widget
6718     * @param icon The icon object for the entry's button
6719     *
6720     * Once the icon object is set, a previously set one will be
6721     * deleted. If you want to keep the latter, use the
6722     * elm_fileselector_entry_button_icon_unset() function.
6723     *
6724     * @see elm_fileselector_entry_button_icon_get()
6725     */
6726    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6727
6728    /**
6729     * Get the icon set for a given file selector entry widget's button
6730     *
6731     * @param obj The file selector entry widget
6732     * @return The icon object currently set on @p obj widget's button
6733     * or @c NULL, if none is
6734     *
6735     * @see elm_fileselector_entry_button_icon_set()
6736     */
6737    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6738
6739    /**
6740     * Unset the icon used in a given file selector entry widget's
6741     * button
6742     *
6743     * @param obj The file selector entry widget
6744     * @return The icon object that was being used on @p obj widget's
6745     * button or @c NULL, on errors
6746     *
6747     * Unparent and return the icon object which was set for this
6748     * widget's button.
6749     *
6750     * @see elm_fileselector_entry_button_icon_set()
6751     */
6752    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6753
6754    /**
6755     * Set the title for a given file selector entry widget's window
6756     *
6757     * @param obj The file selector entry widget
6758     * @param title The title string
6759     *
6760     * This will change the window's title, when the file selector pops
6761     * out after a click on the entry's button. Those windows have the
6762     * default (unlocalized) value of @c "Select a file" as titles.
6763     *
6764     * @note It will only take any effect if the file selector
6765     * entry widget is @b not under "inwin mode".
6766     *
6767     * @see elm_fileselector_entry_window_title_get()
6768     */
6769    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6770
6771    /**
6772     * Get the title set for a given file selector entry widget's
6773     * window
6774     *
6775     * @param obj The file selector entry widget
6776     * @return Title of the file selector entry's window
6777     *
6778     * @see elm_fileselector_entry_window_title_get() for more details
6779     */
6780    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6781
6782    /**
6783     * Set the size of a given file selector entry widget's window,
6784     * holding the file selector itself.
6785     *
6786     * @param obj The file selector entry widget
6787     * @param width The window's width
6788     * @param height The window's height
6789     *
6790     * @note it will only take any effect if the file selector entry
6791     * widget is @b not under "inwin mode". The default size for the
6792     * window (when applicable) is 400x400 pixels.
6793     *
6794     * @see elm_fileselector_entry_window_size_get()
6795     */
6796    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6797
6798    /**
6799     * Get the size of a given file selector entry widget's window,
6800     * holding the file selector itself.
6801     *
6802     * @param obj The file selector entry widget
6803     * @param width Pointer into which to store the width value
6804     * @param height Pointer into which to store the height value
6805     *
6806     * @note Use @c NULL pointers on the size values you're not
6807     * interested in: they'll be ignored by the function.
6808     *
6809     * @see elm_fileselector_entry_window_size_set(), for more details
6810     */
6811    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6812
6813    /**
6814     * Set the initial file system path and the entry's path string for
6815     * a given file selector entry widget
6816     *
6817     * @param obj The file selector entry widget
6818     * @param path The path string
6819     *
6820     * It must be a <b>directory</b> path, which will have the contents
6821     * displayed initially in the file selector's view, when invoked
6822     * from @p obj. The default initial path is the @c "HOME"
6823     * environment variable's value.
6824     *
6825     * @see elm_fileselector_entry_path_get()
6826     */
6827    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6828
6829    /**
6830     * Get the entry's path string for a given file selector entry
6831     * widget
6832     *
6833     * @param obj The file selector entry widget
6834     * @return path The path string
6835     *
6836     * @see elm_fileselector_entry_path_set() for more details
6837     */
6838    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6839
6840    /**
6841     * Enable/disable a tree view in the given file selector entry
6842     * widget's internal file selector
6843     *
6844     * @param obj The file selector entry widget
6845     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6846     * disable
6847     *
6848     * This has the same effect as elm_fileselector_expandable_set(),
6849     * but now applied to a file selector entry's internal file
6850     * selector.
6851     *
6852     * @note There's no way to put a file selector entry's internal
6853     * file selector in "grid mode", as one may do with "pure" file
6854     * selectors.
6855     *
6856     * @see elm_fileselector_expandable_get()
6857     */
6858    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6859
6860    /**
6861     * Get whether tree view is enabled for the given file selector
6862     * entry widget's internal file selector
6863     *
6864     * @param obj The file selector entry widget
6865     * @return @c EINA_TRUE if @p obj widget's internal file selector
6866     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6867     *
6868     * @see elm_fileselector_expandable_set() for more details
6869     */
6870    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6871
6872    /**
6873     * Set whether a given file selector entry widget's internal file
6874     * selector is to display folders only or the directory contents,
6875     * as well.
6876     *
6877     * @param obj The file selector entry widget
6878     * @param only @c EINA_TRUE to make @p obj widget's internal file
6879     * selector only display directories, @c EINA_FALSE to make files
6880     * to be displayed in it too
6881     *
6882     * This has the same effect as elm_fileselector_folder_only_set(),
6883     * but now applied to a file selector entry's internal file
6884     * selector.
6885     *
6886     * @see elm_fileselector_folder_only_get()
6887     */
6888    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6889
6890    /**
6891     * Get whether a given file selector entry widget's internal file
6892     * selector is displaying folders only or the directory contents,
6893     * as well.
6894     *
6895     * @param obj The file selector entry widget
6896     * @return @c EINA_TRUE if @p obj widget's internal file
6897     * selector is only displaying directories, @c EINA_FALSE if files
6898     * are being displayed in it too (and on errors)
6899     *
6900     * @see elm_fileselector_entry_folder_only_set() for more details
6901     */
6902    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6903
6904    /**
6905     * Enable/disable the file name entry box where the user can type
6906     * in a name for a file, in a given file selector entry widget's
6907     * internal file selector.
6908     *
6909     * @param obj The file selector entry widget
6910     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6911     * file selector a "saving dialog", @c EINA_FALSE otherwise
6912     *
6913     * This has the same effect as elm_fileselector_is_save_set(),
6914     * but now applied to a file selector entry's internal file
6915     * selector.
6916     *
6917     * @see elm_fileselector_is_save_get()
6918     */
6919    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6920
6921    /**
6922     * Get whether the given file selector entry widget's internal
6923     * file selector is in "saving dialog" mode
6924     *
6925     * @param obj The file selector entry widget
6926     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6927     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6928     * errors)
6929     *
6930     * @see elm_fileselector_entry_is_save_set() for more details
6931     */
6932    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6933
6934    /**
6935     * Set whether a given file selector entry widget's internal file
6936     * selector will raise an Elementary "inner window", instead of a
6937     * dedicated Elementary window. By default, it won't.
6938     *
6939     * @param obj The file selector entry widget
6940     * @param value @c EINA_TRUE to make it use an inner window, @c
6941     * EINA_TRUE to make it use a dedicated window
6942     *
6943     * @see elm_win_inwin_add() for more information on inner windows
6944     * @see elm_fileselector_entry_inwin_mode_get()
6945     */
6946    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6947
6948    /**
6949     * Get whether a given file selector entry widget's internal file
6950     * selector will raise an Elementary "inner window", instead of a
6951     * dedicated Elementary window.
6952     *
6953     * @param obj The file selector entry widget
6954     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6955     * if it will use a dedicated window
6956     *
6957     * @see elm_fileselector_entry_inwin_mode_set() for more details
6958     */
6959    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6960
6961    /**
6962     * Set the initial file system path for a given file selector entry
6963     * widget
6964     *
6965     * @param obj The file selector entry widget
6966     * @param path The path string
6967     *
6968     * It must be a <b>directory</b> path, which will have the contents
6969     * displayed initially in the file selector's view, when invoked
6970     * from @p obj. The default initial path is the @c "HOME"
6971     * environment variable's value.
6972     *
6973     * @see elm_fileselector_entry_path_get()
6974     */
6975    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6976
6977    /**
6978     * Get the parent directory's path to the latest file selection on
6979     * a given filer selector entry widget
6980     *
6981     * @param obj The file selector object
6982     * @return The (full) path of the directory of the last selection
6983     * on @p obj widget, a @b stringshared string
6984     *
6985     * @see elm_fileselector_entry_path_set()
6986     */
6987    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6988
6989    /**
6990     * @}
6991     */
6992
6993    /**
6994     * @defgroup Scroller Scroller
6995     *
6996     * A scroller holds a single object and "scrolls it around". This means that
6997     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6998     * region around, allowing to move through a much larger object that is
6999     * contained in the scroller. The scroller will always have a small minimum
7000     * size by default as it won't be limited by the contents of the scroller.
7001     *
7002     * Signals that you can add callbacks for are:
7003     * @li "edge,left" - the left edge of the content has been reached
7004     * @li "edge,right" - the right edge of the content has been reached
7005     * @li "edge,top" - the top edge of the content has been reached
7006     * @li "edge,bottom" - the bottom edge of the content has been reached
7007     * @li "scroll" - the content has been scrolled (moved)
7008     * @li "scroll,anim,start" - scrolling animation has started
7009     * @li "scroll,anim,stop" - scrolling animation has stopped
7010     * @li "scroll,drag,start" - dragging the contents around has started
7011     * @li "scroll,drag,stop" - dragging the contents around has stopped
7012     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7013     * user intervetion.
7014     *
7015     * @note When Elemementary is in embedded mode the scrollbars will not be
7016     * dragable, they appear merely as indicators of how much has been scrolled.
7017     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7018     * fingerscroll) won't work.
7019     *
7020     * Default contents parts of the scroller widget that you can use for are:
7021     * @li "elm.swallow.content" - A content of the scroller
7022     *
7023     * In @ref tutorial_scroller you'll find an example of how to use most of
7024     * this API.
7025     * @{
7026     */
7027    /**
7028     * @brief Type that controls when scrollbars should appear.
7029     *
7030     * @see elm_scroller_policy_set()
7031     */
7032    typedef enum _Elm_Scroller_Policy
7033      {
7034         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7035         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7036         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7037         ELM_SCROLLER_POLICY_LAST
7038      } Elm_Scroller_Policy;
7039    /**
7040     * @brief Add a new scroller to the parent
7041     *
7042     * @param parent The parent object
7043     * @return The new object or NULL if it cannot be created
7044     */
7045    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7046    /**
7047     * @brief Set the content of the scroller widget (the object to be scrolled around).
7048     *
7049     * @param obj The scroller object
7050     * @param content The new content object
7051     *
7052     * Once the content object is set, a previously set one will be deleted.
7053     * If you want to keep that old content object, use the
7054     * elm_scroller_content_unset() function.
7055     */
7056    EINA_DEPRECATED EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7057    /**
7058     * @brief Get the content of the scroller widget
7059     *
7060     * @param obj The slider object
7061     * @return The content that is being used
7062     *
7063     * Return the content object which is set for this widget
7064     *
7065     * @see elm_scroller_content_set()
7066     */
7067    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7068    /**
7069     * @brief Unset the content of the scroller widget
7070     *
7071     * @param obj The slider object
7072     * @return The content that was being used
7073     *
7074     * Unparent and return the content object which was set for this widget
7075     *
7076     * @see elm_scroller_content_set()
7077     */
7078    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7079    /**
7080     * @brief Set custom theme elements for the scroller
7081     *
7082     * @param obj The scroller object
7083     * @param widget The widget name to use (default is "scroller")
7084     * @param base The base name to use (default is "base")
7085     */
7086    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7087    /**
7088     * @brief Make the scroller minimum size limited to the minimum size of the content
7089     *
7090     * @param obj The scroller object
7091     * @param w Enable limiting minimum size horizontally
7092     * @param h Enable limiting minimum size vertically
7093     *
7094     * By default the scroller will be as small as its design allows,
7095     * irrespective of its content. This will make the scroller minimum size the
7096     * right size horizontally and/or vertically to perfectly fit its content in
7097     * that direction.
7098     */
7099    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7100    /**
7101     * @brief Show a specific virtual region within the scroller content object
7102     *
7103     * @param obj The scroller object
7104     * @param x X coordinate of the region
7105     * @param y Y coordinate of the region
7106     * @param w Width of the region
7107     * @param h Height of the region
7108     *
7109     * This will ensure all (or part if it does not fit) of the designated
7110     * region in the virtual content object (0, 0 starting at the top-left of the
7111     * virtual content object) is shown within the scroller.
7112     */
7113    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);
7114    /**
7115     * @brief Set the scrollbar visibility policy
7116     *
7117     * @param obj The scroller object
7118     * @param policy_h Horizontal scrollbar policy
7119     * @param policy_v Vertical scrollbar policy
7120     *
7121     * This sets the scrollbar visibility policy for the given scroller.
7122     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7123     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7124     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7125     * respectively for the horizontal and vertical scrollbars.
7126     */
7127    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7128    /**
7129     * @brief Gets scrollbar visibility policy
7130     *
7131     * @param obj The scroller object
7132     * @param policy_h Horizontal scrollbar policy
7133     * @param policy_v Vertical scrollbar policy
7134     *
7135     * @see elm_scroller_policy_set()
7136     */
7137    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7138    /**
7139     * @brief Get the currently visible content region
7140     *
7141     * @param obj The scroller object
7142     * @param x X coordinate of the region
7143     * @param y Y coordinate of the region
7144     * @param w Width of the region
7145     * @param h Height of the region
7146     *
7147     * This gets the current region in the content object that is visible through
7148     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7149     * w, @p h values pointed to.
7150     *
7151     * @note All coordinates are relative to the content.
7152     *
7153     * @see elm_scroller_region_show()
7154     */
7155    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);
7156    /**
7157     * @brief Get the size of the content object
7158     *
7159     * @param obj The scroller object
7160     * @param w Width of the content object.
7161     * @param h Height of the content object.
7162     *
7163     * This gets the size of the content object of the scroller.
7164     */
7165    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7166    /**
7167     * @brief Set bouncing behavior
7168     *
7169     * @param obj The scroller object
7170     * @param h_bounce Allow bounce horizontally
7171     * @param v_bounce Allow bounce vertically
7172     *
7173     * When scrolling, the scroller may "bounce" when reaching an edge of the
7174     * content object. This is a visual way to indicate the end has been reached.
7175     * This is enabled by default for both axis. This API will set if it is enabled
7176     * for the given axis with the boolean parameters for each axis.
7177     */
7178    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7179    /**
7180     * @brief Get the bounce behaviour
7181     *
7182     * @param obj The Scroller object
7183     * @param h_bounce Will the scroller bounce horizontally or not
7184     * @param v_bounce Will the scroller bounce vertically or not
7185     *
7186     * @see elm_scroller_bounce_set()
7187     */
7188    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7189    /**
7190     * @brief Set scroll page size relative to viewport size.
7191     *
7192     * @param obj The scroller object
7193     * @param h_pagerel The horizontal page relative size
7194     * @param v_pagerel The vertical page relative size
7195     *
7196     * The scroller is capable of limiting scrolling by the user to "pages". That
7197     * is to jump by and only show a "whole page" at a time as if the continuous
7198     * area of the scroller content is split into page sized pieces. This sets
7199     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7200     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7201     * axis. This is mutually exclusive with page size
7202     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7203     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7204     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7205     * the other axis.
7206     */
7207    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7208    /**
7209     * @brief Set scroll page size.
7210     *
7211     * @param obj The scroller object
7212     * @param h_pagesize The horizontal page size
7213     * @param v_pagesize The vertical page size
7214     *
7215     * This sets the page size to an absolute fixed value, with 0 turning it off
7216     * for that axis.
7217     *
7218     * @see elm_scroller_page_relative_set()
7219     */
7220    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7221    /**
7222     * @brief Get scroll current page number.
7223     *
7224     * @param obj The scroller object
7225     * @param h_pagenumber The horizontal page number
7226     * @param v_pagenumber The vertical page number
7227     *
7228     * The page number starts from 0. 0 is the first page.
7229     * Current page means the page which meets the top-left of the viewport.
7230     * If there are two or more pages in the viewport, it returns the number of the page
7231     * which meets the top-left of the viewport.
7232     *
7233     * @see elm_scroller_last_page_get()
7234     * @see elm_scroller_page_show()
7235     * @see elm_scroller_page_brint_in()
7236     */
7237    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7238    /**
7239     * @brief Get scroll last page number.
7240     *
7241     * @param obj The scroller object
7242     * @param h_pagenumber The horizontal page number
7243     * @param v_pagenumber The vertical page number
7244     *
7245     * The page number starts from 0. 0 is the first page.
7246     * This returns the last page number among the pages.
7247     *
7248     * @see elm_scroller_current_page_get()
7249     * @see elm_scroller_page_show()
7250     * @see elm_scroller_page_brint_in()
7251     */
7252    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7253    /**
7254     * Show a specific virtual region within the scroller content object by page number.
7255     *
7256     * @param obj The scroller object
7257     * @param h_pagenumber The horizontal page number
7258     * @param v_pagenumber The vertical page number
7259     *
7260     * 0, 0 of the indicated page is located at the top-left of the viewport.
7261     * This will jump to the page directly without animation.
7262     *
7263     * Example of usage:
7264     *
7265     * @code
7266     * sc = elm_scroller_add(win);
7267     * elm_scroller_content_set(sc, content);
7268     * elm_scroller_page_relative_set(sc, 1, 0);
7269     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7270     * elm_scroller_page_show(sc, h_page + 1, v_page);
7271     * @endcode
7272     *
7273     * @see elm_scroller_page_bring_in()
7274     */
7275    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7276    /**
7277     * Show a specific virtual region within the scroller content object by page number.
7278     *
7279     * @param obj The scroller object
7280     * @param h_pagenumber The horizontal page number
7281     * @param v_pagenumber The vertical page number
7282     *
7283     * 0, 0 of the indicated page is located at the top-left of the viewport.
7284     * This will slide to the page with animation.
7285     *
7286     * Example of usage:
7287     *
7288     * @code
7289     * sc = elm_scroller_add(win);
7290     * elm_scroller_content_set(sc, content);
7291     * elm_scroller_page_relative_set(sc, 1, 0);
7292     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7293     * elm_scroller_page_bring_in(sc, h_page, v_page);
7294     * @endcode
7295     *
7296     * @see elm_scroller_page_show()
7297     */
7298    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7299    /**
7300     * @brief Show a specific virtual region within the scroller content object.
7301     *
7302     * @param obj The scroller object
7303     * @param x X coordinate of the region
7304     * @param y Y coordinate of the region
7305     * @param w Width of the region
7306     * @param h Height of the region
7307     *
7308     * This will ensure all (or part if it does not fit) of the designated
7309     * region in the virtual content object (0, 0 starting at the top-left of the
7310     * virtual content object) is shown within the scroller. Unlike
7311     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7312     * to this location (if configuration in general calls for transitions). It
7313     * may not jump immediately to the new location and make take a while and
7314     * show other content along the way.
7315     *
7316     * @see elm_scroller_region_show()
7317     */
7318    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);
7319    /**
7320     * @brief Set event propagation on a scroller
7321     *
7322     * @param obj The scroller object
7323     * @param propagation If propagation is enabled or not
7324     *
7325     * This enables or disabled event propagation from the scroller content to
7326     * the scroller and its parent. By default event propagation is disabled.
7327     */
7328    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7329    /**
7330     * @brief Get event propagation for a scroller
7331     *
7332     * @param obj The scroller object
7333     * @return The propagation state
7334     *
7335     * This gets the event propagation for a scroller.
7336     *
7337     * @see elm_scroller_propagate_events_set()
7338     */
7339    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7340    /**
7341     * @brief Set scrolling gravity on a scroller
7342     *
7343     * @param obj The scroller object
7344     * @param x The scrolling horizontal gravity
7345     * @param y The scrolling vertical gravity
7346     *
7347     * The gravity, defines how the scroller will adjust its view
7348     * when the size of the scroller contents increase.
7349     *
7350     * The scroller will adjust the view to glue itself as follows.
7351     *
7352     *  x=0.0, for showing the left most region of the content.
7353     *  x=1.0, for showing the right most region of the content.
7354     *  y=0.0, for showing the bottom most region of the content.
7355     *  y=1.0, for showing the top most region of the content.
7356     *
7357     * Default values for x and y are 0.0
7358     */
7359    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7360    /**
7361     * @brief Get scrolling gravity values for a scroller
7362     *
7363     * @param obj The scroller object
7364     * @param x The scrolling horizontal gravity
7365     * @param y The scrolling vertical gravity
7366     *
7367     * This gets gravity values for a scroller.
7368     *
7369     * @see elm_scroller_gravity_set()
7370     *
7371     */
7372    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7373    /**
7374     * @}
7375     */
7376
7377    /**
7378     * @defgroup Label Label
7379     *
7380     * @image html img/widget/label/preview-00.png
7381     * @image latex img/widget/label/preview-00.eps
7382     *
7383     * @brief Widget to display text, with simple html-like markup.
7384     *
7385     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7386     * text doesn't fit the geometry of the label it will be ellipsized or be
7387     * cut. Elementary provides several themes for this widget:
7388     * @li default - No animation
7389     * @li marker - Centers the text in the label and make it bold by default
7390     * @li slide_long - The entire text appears from the right of the screen and
7391     * slides until it disappears in the left of the screen(reappering on the
7392     * right again).
7393     * @li slide_short - The text appears in the left of the label and slides to
7394     * the right to show the overflow. When all of the text has been shown the
7395     * position is reset.
7396     * @li slide_bounce - The text appears in the left of the label and slides to
7397     * the right to show the overflow. When all of the text has been shown the
7398     * animation reverses, moving the text to the left.
7399     *
7400     * Custom themes can of course invent new markup tags and style them any way
7401     * they like.
7402     *
7403     * The following signals may be emitted by the label widget:
7404     * @li "language,changed": The program's language changed.
7405     *
7406     * See @ref tutorial_label for a demonstration of how to use a label widget.
7407     * @{
7408     */
7409    /**
7410     * @brief Add a new label to the parent
7411     *
7412     * @param parent The parent object
7413     * @return The new object or NULL if it cannot be created
7414     */
7415    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7416    /**
7417     * @brief Set the label on the label object
7418     *
7419     * @param obj The label object
7420     * @param label The label will be used on the label object
7421     * @deprecated See elm_object_text_set()
7422     */
7423    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 */
7424    /**
7425     * @brief Get the label used on the label object
7426     *
7427     * @param obj The label object
7428     * @return The string inside the label
7429     * @deprecated See elm_object_text_get()
7430     */
7431    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7432    /**
7433     * @brief Set the wrapping behavior of the label
7434     *
7435     * @param obj The label object
7436     * @param wrap To wrap text or not
7437     *
7438     * By default no wrapping is done. Possible values for @p wrap are:
7439     * @li ELM_WRAP_NONE - No wrapping
7440     * @li ELM_WRAP_CHAR - wrap between characters
7441     * @li ELM_WRAP_WORD - wrap between words
7442     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7443     */
7444    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7445    /**
7446     * @brief Get the wrapping behavior of the label
7447     *
7448     * @param obj The label object
7449     * @return Wrap type
7450     *
7451     * @see elm_label_line_wrap_set()
7452     */
7453    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7454    /**
7455     * @brief Set wrap width of the label
7456     *
7457     * @param obj The label object
7458     * @param w The wrap width in pixels at a minimum where words need to wrap
7459     *
7460     * This function sets the maximum width size hint of the label.
7461     *
7462     * @warning This is only relevant if the label is inside a container.
7463     */
7464    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7465    /**
7466     * @brief Get wrap width of the label
7467     *
7468     * @param obj The label object
7469     * @return The wrap width in pixels at a minimum where words need to wrap
7470     *
7471     * @see elm_label_wrap_width_set()
7472     */
7473    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7474    /**
7475     * @brief Set wrap height of the label
7476     *
7477     * @param obj The label object
7478     * @param h The wrap height in pixels at a minimum where words need to wrap
7479     *
7480     * This function sets the maximum height size hint of the label.
7481     *
7482     * @warning This is only relevant if the label is inside a container.
7483     */
7484    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7485    /**
7486     * @brief get wrap width of the label
7487     *
7488     * @param obj The label object
7489     * @return The wrap height in pixels at a minimum where words need to wrap
7490     */
7491    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7492    /**
7493     * @brief Set the font size on the label object.
7494     *
7495     * @param obj The label object
7496     * @param size font size
7497     *
7498     * @warning NEVER use this. It is for hyper-special cases only. use styles
7499     * instead. e.g. "big", "medium", "small" - or better name them by use:
7500     * "title", "footnote", "quote" etc.
7501     */
7502    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7503    /**
7504     * @brief Set the text color on the label object
7505     *
7506     * @param obj The label object
7507     * @param r Red property background color of The label object
7508     * @param g Green property background color of The label object
7509     * @param b Blue property background color of The label object
7510     * @param a Alpha property background color of The label object
7511     *
7512     * @warning NEVER use this. It is for hyper-special cases only. use styles
7513     * instead. e.g. "big", "medium", "small" - or better name them by use:
7514     * "title", "footnote", "quote" etc.
7515     */
7516    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);
7517    /**
7518     * @brief Set the text align on the label object
7519     *
7520     * @param obj The label object
7521     * @param align align mode ("left", "center", "right")
7522     *
7523     * @warning NEVER use this. It is for hyper-special cases only. use styles
7524     * instead. e.g. "big", "medium", "small" - or better name them by use:
7525     * "title", "footnote", "quote" etc.
7526     */
7527    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7528    /**
7529     * @brief Set background color of the label
7530     *
7531     * @param obj The label object
7532     * @param r Red property background color of The label object
7533     * @param g Green property background color of The label object
7534     * @param b Blue property background color of The label object
7535     * @param a Alpha property background alpha of The label object
7536     *
7537     * @warning NEVER use this. It is for hyper-special cases only. use styles
7538     * instead. e.g. "big", "medium", "small" - or better name them by use:
7539     * "title", "footnote", "quote" etc.
7540     */
7541    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);
7542    /**
7543     * @brief Set the ellipsis behavior of the label
7544     *
7545     * @param obj The label object
7546     * @param ellipsis To ellipsis text or not
7547     *
7548     * If set to true and the text doesn't fit in the label an ellipsis("...")
7549     * will be shown at the end of the widget.
7550     *
7551     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7552     * choosen wrap method was ELM_WRAP_WORD.
7553     */
7554    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7555    /**
7556     * @brief Set the text slide of the label
7557     *
7558     * @param obj The label object
7559     * @param slide To start slide or stop
7560     *
7561     * If set to true, the text of the label will slide/scroll through the length of
7562     * label.
7563     *
7564     * @warning This only works with the themes "slide_short", "slide_long" and
7565     * "slide_bounce".
7566     */
7567    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7568    /**
7569     * @brief Get the text slide mode of the label
7570     *
7571     * @param obj The label object
7572     * @return slide slide mode value
7573     *
7574     * @see elm_label_slide_set()
7575     */
7576    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7577    /**
7578     * @brief Set the slide duration(speed) of the label
7579     *
7580     * @param obj The label object
7581     * @return The duration in seconds in moving text from slide begin position
7582     * to slide end position
7583     */
7584    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7585    /**
7586     * @brief Get the slide duration(speed) of the label
7587     *
7588     * @param obj The label object
7589     * @return The duration time in moving text from slide begin position to slide end position
7590     *
7591     * @see elm_label_slide_duration_set()
7592     */
7593    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7594    /**
7595     * @}
7596     */
7597
7598    /**
7599     * @defgroup Toggle Toggle
7600     *
7601     * @image html img/widget/toggle/preview-00.png
7602     * @image latex img/widget/toggle/preview-00.eps
7603     *
7604     * @brief A toggle is a slider which can be used to toggle between
7605     * two values.  It has two states: on and off.
7606     *
7607     * This widget is deprecated. Please use elm_check_add() instead using the
7608     * toggle style like:
7609     * 
7610     * @code
7611     * obj = elm_check_add(parent);
7612     * elm_object_style_set(obj, "toggle");
7613     * elm_object_text_part_set(obj, "on", "ON");
7614     * elm_object_text_part_set(obj, "off", "OFF");
7615     * @endcode
7616     * 
7617     * Signals that you can add callbacks for are:
7618     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7619     *                 until the toggle is released by the cursor (assuming it
7620     *                 has been triggered by the cursor in the first place).
7621     *
7622     * @ref tutorial_toggle show how to use a toggle.
7623     * @{
7624     */
7625    /**
7626     * @brief Add a toggle to @p parent.
7627     *
7628     * @param parent The parent object
7629     *
7630     * @return The toggle object
7631     */
7632    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7633    /**
7634     * @brief Sets the label to be displayed with the toggle.
7635     *
7636     * @param obj The toggle object
7637     * @param label The label to be displayed
7638     *
7639     * @deprecated use elm_object_text_set() instead.
7640     */
7641    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7642    /**
7643     * @brief Gets the label of the toggle
7644     *
7645     * @param obj  toggle object
7646     * @return The label of the toggle
7647     *
7648     * @deprecated use elm_object_text_get() instead.
7649     */
7650    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7651    /**
7652     * @brief Set the icon used for the toggle
7653     *
7654     * @param obj The toggle object
7655     * @param icon The icon object for the button
7656     *
7657     * Once the icon object is set, a previously set one will be deleted
7658     * If you want to keep that old content object, use the
7659     * elm_toggle_icon_unset() function.
7660     *
7661     * @deprecated use elm_object_content_set() instead.
7662     */
7663    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7664    /**
7665     * @brief Get the icon used for the toggle
7666     *
7667     * @param obj The toggle object
7668     * @return The icon object that is being used
7669     *
7670     * Return the icon object which is set for this widget.
7671     *
7672     * @see elm_toggle_icon_set()
7673     *
7674     * @deprecated use elm_object_content_get() instead.
7675     */
7676    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7677    /**
7678     * @brief Unset the icon used for the toggle
7679     *
7680     * @param obj The toggle object
7681     * @return The icon object that was being used
7682     *
7683     * Unparent and return the icon object which was set for this widget.
7684     *
7685     * @see elm_toggle_icon_set()
7686     *
7687     * @deprecated use elm_object_content_unset() instead.
7688     */
7689    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7690    /**
7691     * @brief Sets the labels to be associated with the on and off states of the toggle.
7692     *
7693     * @param obj The toggle object
7694     * @param onlabel The label displayed when the toggle is in the "on" state
7695     * @param offlabel The label displayed when the toggle is in the "off" state
7696     *
7697     * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7698     * instead.
7699     */
7700    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7701    /**
7702     * @brief Gets the labels associated with the on and off states of the
7703     * toggle.
7704     *
7705     * @param obj The toggle object
7706     * @param onlabel A char** to place the onlabel of @p obj into
7707     * @param offlabel A char** to place the offlabel of @p obj into
7708     *
7709     * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7710     * instead.
7711     */
7712    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7713    /**
7714     * @brief Sets the state of the toggle to @p state.
7715     *
7716     * @param obj The toggle object
7717     * @param state The state of @p obj
7718     *
7719     * @deprecated use elm_check_state_set() instead.
7720     */
7721    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7722    /**
7723     * @brief Gets the state of the toggle to @p state.
7724     *
7725     * @param obj The toggle object
7726     * @return The state of @p obj
7727     *
7728     * @deprecated use elm_check_state_get() instead.
7729     */
7730    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7731    /**
7732     * @brief Sets the state pointer of the toggle to @p statep.
7733     *
7734     * @param obj The toggle object
7735     * @param statep The state pointer of @p obj
7736     *
7737     * @deprecated use elm_check_state_pointer_set() instead.
7738     */
7739    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7740    /**
7741     * @}
7742     */
7743
7744    /**
7745     * @defgroup Frame Frame
7746     *
7747     * @image html img/widget/frame/preview-00.png
7748     * @image latex img/widget/frame/preview-00.eps
7749     *
7750     * @brief Frame is a widget that holds some content and has a title.
7751     *
7752     * The default look is a frame with a title, but Frame supports multple
7753     * styles:
7754     * @li default
7755     * @li pad_small
7756     * @li pad_medium
7757     * @li pad_large
7758     * @li pad_huge
7759     * @li outdent_top
7760     * @li outdent_bottom
7761     *
7762     * Of all this styles only default shows the title. Frame emits no signals.
7763     *
7764     * Default contents parts of the frame widget that you can use for are:
7765     * @li "elm.swallow.content" - A content of the frame
7766     *
7767     * Default text parts of the frame widget that you can use for are:
7768     * @li "elm.text" - Label of the frame
7769     *
7770     * For a detailed example see the @ref tutorial_frame.
7771     *
7772     * @{
7773     */
7774    /**
7775     * @brief Add a new frame to the parent
7776     *
7777     * @param parent The parent object
7778     * @return The new object or NULL if it cannot be created
7779     */
7780    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7781    /**
7782     * @brief Set the frame label
7783     *
7784     * @param obj The frame object
7785     * @param label The label of this frame object
7786     *
7787     * @deprecated use elm_object_text_set() instead.
7788     */
7789    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7790    /**
7791     * @brief Get the frame label
7792     *
7793     * @param obj The frame object
7794     *
7795     * @return The label of this frame objet or NULL if unable to get frame
7796     *
7797     * @deprecated use elm_object_text_get() instead.
7798     */
7799    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7800    /**
7801     * @brief Set the content of the frame widget
7802     *
7803     * Once the content object is set, a previously set one will be deleted.
7804     * If you want to keep that old content object, use the
7805     * elm_frame_content_unset() function.
7806     *
7807     * @param obj The frame object
7808     * @param content The content will be filled in this frame object
7809     */
7810    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7811    /**
7812     * @brief Get the content of the frame widget
7813     *
7814     * Return the content object which is set for this widget
7815     *
7816     * @param obj The frame object
7817     * @return The content that is being used
7818     */
7819    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7820    /**
7821     * @brief Unset the content of the frame widget
7822     *
7823     * Unparent and return the content object which was set for this widget
7824     *
7825     * @param obj The frame object
7826     * @return The content that was being used
7827     */
7828    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7829    /**
7830     * @}
7831     */
7832
7833    /**
7834     * @defgroup Table Table
7835     *
7836     * A container widget to arrange other widgets in a table where items can
7837     * also span multiple columns or rows - even overlap (and then be raised or
7838     * lowered accordingly to adjust stacking if they do overlap).
7839     *
7840     * The followin are examples of how to use a table:
7841     * @li @ref tutorial_table_01
7842     * @li @ref tutorial_table_02
7843     *
7844     * @{
7845     */
7846    /**
7847     * @brief Add a new table to the parent
7848     *
7849     * @param parent The parent object
7850     * @return The new object or NULL if it cannot be created
7851     */
7852    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7853    /**
7854     * @brief Set the homogeneous layout in the table
7855     *
7856     * @param obj The layout object
7857     * @param homogeneous A boolean to set if the layout is homogeneous in the
7858     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7859     */
7860    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7861    /**
7862     * @brief Get the current table homogeneous mode.
7863     *
7864     * @param obj The table object
7865     * @return A boolean to indicating if the layout is homogeneous in the table
7866     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7867     */
7868    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7869    /**
7870     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7871     */
7872    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7873    /**
7874     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7875     */
7876    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7877    /**
7878     * @brief Set padding between cells.
7879     *
7880     * @param obj The layout object.
7881     * @param horizontal set the horizontal padding.
7882     * @param vertical set the vertical padding.
7883     *
7884     * Default value is 0.
7885     */
7886    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7887    /**
7888     * @brief Get padding between cells.
7889     *
7890     * @param obj The layout object.
7891     * @param horizontal set the horizontal padding.
7892     * @param vertical set the vertical padding.
7893     */
7894    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7895    /**
7896     * @brief Add a subobject on the table with the coordinates passed
7897     *
7898     * @param obj The table object
7899     * @param subobj The subobject to be added to the table
7900     * @param x Row number
7901     * @param y Column number
7902     * @param w rowspan
7903     * @param h colspan
7904     *
7905     * @note All positioning inside the table is relative to rows and columns, so
7906     * a value of 0 for x and y, means the top left cell of the table, and a
7907     * value of 1 for w and h means @p subobj only takes that 1 cell.
7908     */
7909    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7910    /**
7911     * @brief Remove child from table.
7912     *
7913     * @param obj The table object
7914     * @param subobj The subobject
7915     */
7916    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7917    /**
7918     * @brief Faster way to remove all child objects from a table object.
7919     *
7920     * @param obj The table object
7921     * @param clear If true, will delete children, else just remove from table.
7922     */
7923    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7924    /**
7925     * @brief Set the packing location of an existing child of the table
7926     *
7927     * @param subobj The subobject to be modified in the table
7928     * @param x Row number
7929     * @param y Column number
7930     * @param w rowspan
7931     * @param h colspan
7932     *
7933     * Modifies the position of an object already in the table.
7934     *
7935     * @note All positioning inside the table is relative to rows and columns, so
7936     * a value of 0 for x and y, means the top left cell of the table, and a
7937     * value of 1 for w and h means @p subobj only takes that 1 cell.
7938     */
7939    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7940    /**
7941     * @brief Get the packing location of an existing child of the table
7942     *
7943     * @param subobj The subobject to be modified in the table
7944     * @param x Row number
7945     * @param y Column number
7946     * @param w rowspan
7947     * @param h colspan
7948     *
7949     * @see elm_table_pack_set()
7950     */
7951    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7952    /**
7953     * @}
7954     */
7955
7956    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7957    typedef struct Elm_Gen_Item Elm_Gen_Item;
7958    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7959    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7960    typedef char        *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7961    typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7962    typedef Eina_Bool    (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7963    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7964    struct _Elm_Gen_Item_Class
7965      {
7966         const char             *item_style;
7967         struct _Elm_Gen_Item_Class_Func
7968           {
7969              Elm_Gen_Item_Label_Get_Cb label_get;
7970              Elm_Gen_Item_Content_Get_Cb  content_get;
7971              Elm_Gen_Item_State_Get_Cb state_get;
7972              Elm_Gen_Item_Del_Cb       del;
7973           } func;
7974      };
7975    EAPI void elm_gen_clear(Evas_Object *obj);
7976    EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7977    EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7978    EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7979    EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7980    EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7981    EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7982    EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7983    EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7984    EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7985    EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7986    EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7987    EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7988    EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7989    EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7990    EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7991    EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7992    EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7993    EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
7994    EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
7995    EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
7996
7997    /**
7998     * @defgroup Gengrid Gengrid (Generic grid)
7999     *
8000     * This widget aims to position objects in a grid layout while
8001     * actually creating and rendering only the visible ones, using the
8002     * same idea as the @ref Genlist "genlist": the user defines a @b
8003     * class for each item, specifying functions that will be called at
8004     * object creation, deletion, etc. When those items are selected by
8005     * the user, a callback function is issued. Users may interact with
8006     * a gengrid via the mouse (by clicking on items to select them and
8007     * clicking on the grid's viewport and swiping to pan the whole
8008     * view) or via the keyboard, navigating through item with the
8009     * arrow keys.
8010     *
8011     * @section Gengrid_Layouts Gengrid layouts
8012     *
8013     * Gengrids may layout its items in one of two possible layouts:
8014     * - horizontal or
8015     * - vertical.
8016     *
8017     * When in "horizontal mode", items will be placed in @b columns,
8018     * from top to bottom and, when the space for a column is filled,
8019     * another one is started on the right, thus expanding the grid
8020     * horizontally, making for horizontal scrolling. When in "vertical
8021     * mode" , though, items will be placed in @b rows, from left to
8022     * right and, when the space for a row is filled, another one is
8023     * started below, thus expanding the grid vertically (and making
8024     * for vertical scrolling).
8025     *
8026     * @section Gengrid_Items Gengrid items
8027     *
8028     * An item in a gengrid can have 0 or more text labels (they can be
8029     * regular text or textblock Evas objects - that's up to the style
8030     * to determine), 0 or more icons (which are simply objects
8031     * swallowed into the gengrid item's theming Edje object) and 0 or
8032     * more <b>boolean states</b>, which have the behavior left to the
8033     * user to define. The Edje part names for each of these properties
8034     * will be looked up, in the theme file for the gengrid, under the
8035     * Edje (string) data items named @c "labels", @c "icons" and @c
8036     * "states", respectively. For each of those properties, if more
8037     * than one part is provided, they must have names listed separated
8038     * by spaces in the data fields. For the default gengrid item
8039     * theme, we have @b one label part (@c "elm.text"), @b two icon
8040     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8041     * no state parts.
8042     *
8043     * A gengrid item may be at one of several styles. Elementary
8044     * provides one by default - "default", but this can be extended by
8045     * system or application custom themes/overlays/extensions (see
8046     * @ref Theme "themes" for more details).
8047     *
8048     * @section Gengrid_Item_Class Gengrid item classes
8049     *
8050     * In order to have the ability to add and delete items on the fly,
8051     * gengrid implements a class (callback) system where the
8052     * application provides a structure with information about that
8053     * type of item (gengrid may contain multiple different items with
8054     * different classes, states and styles). Gengrid will call the
8055     * functions in this struct (methods) when an item is "realized"
8056     * (i.e., created dynamically, while the user is scrolling the
8057     * grid). All objects will simply be deleted when no longer needed
8058     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8059     * contains the following members:
8060     * - @c item_style - This is a constant string and simply defines
8061     * the name of the item style. It @b must be specified and the
8062     * default should be @c "default".
8063     * - @c func.label_get - This function is called when an item
8064     * object is actually created. The @c data parameter will point to
8065     * the same data passed to elm_gengrid_item_append() and related
8066     * item creation functions. The @c obj parameter is the gengrid
8067     * object itself, while the @c part one is the name string of one
8068     * of the existing text parts in the Edje group implementing the
8069     * item's theme. This function @b must return a strdup'()ed string,
8070     * as the caller will free() it when done. See
8071     * #Elm_Gengrid_Item_Label_Get_Cb.
8072     * - @c func.content_get - This function is called when an item object
8073     * is actually created. The @c data parameter will point to the
8074     * same data passed to elm_gengrid_item_append() and related item
8075     * creation functions. The @c obj parameter is the gengrid object
8076     * itself, while the @c part one is the name string of one of the
8077     * existing (content) swallow parts in the Edje group implementing the
8078     * item's theme. It must return @c NULL, when no content is desired,
8079     * or a valid object handle, otherwise. The object will be deleted
8080     * by the gengrid on its deletion or when the item is "unrealized".
8081     * See #Elm_Gengrid_Item_Content_Get_Cb.
8082     * - @c func.state_get - This function is called when an item
8083     * object is actually created. The @c data parameter will point to
8084     * the same data passed to elm_gengrid_item_append() and related
8085     * item creation functions. The @c obj parameter is the gengrid
8086     * object itself, while the @c part one is the name string of one
8087     * of the state parts in the Edje group implementing the item's
8088     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8089     * true/on. Gengrids will emit a signal to its theming Edje object
8090     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8091     * "source" arguments, respectively, when the state is true (the
8092     * default is false), where @c XXX is the name of the (state) part.
8093     * See #Elm_Gengrid_Item_State_Get_Cb.
8094     * - @c func.del - This is called when elm_gengrid_item_del() is
8095     * called on an item or elm_gengrid_clear() is called on the
8096     * gengrid. This is intended for use when gengrid items are
8097     * deleted, so any data attached to the item (e.g. its data
8098     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8099     *
8100     * @section Gengrid_Usage_Hints Usage hints
8101     *
8102     * If the user wants to have multiple items selected at the same
8103     * time, elm_gengrid_multi_select_set() will permit it. If the
8104     * gengrid is single-selection only (the default), then
8105     * elm_gengrid_select_item_get() will return the selected item or
8106     * @c NULL, if none is selected. If the gengrid is under
8107     * multi-selection, then elm_gengrid_selected_items_get() will
8108     * return a list (that is only valid as long as no items are
8109     * modified (added, deleted, selected or unselected) of child items
8110     * on a gengrid.
8111     *
8112     * If an item changes (internal (boolean) state, label or content 
8113     * changes), then use elm_gengrid_item_update() to have gengrid
8114     * update the item with the new state. A gengrid will re-"realize"
8115     * the item, thus calling the functions in the
8116     * #Elm_Gengrid_Item_Class set for that item.
8117     *
8118     * To programmatically (un)select an item, use
8119     * elm_gengrid_item_selected_set(). To get its selected state use
8120     * elm_gengrid_item_selected_get(). To make an item disabled
8121     * (unable to be selected and appear differently) use
8122     * elm_gengrid_item_disabled_set() to set this and
8123     * elm_gengrid_item_disabled_get() to get the disabled state.
8124     *
8125     * Grid cells will only have their selection smart callbacks called
8126     * when firstly getting selected. Any further clicks will do
8127     * nothing, unless you enable the "always select mode", with
8128     * elm_gengrid_always_select_mode_set(), thus making every click to
8129     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8130     * turn off the ability to select items entirely in the widget and
8131     * they will neither appear selected nor call the selection smart
8132     * callbacks.
8133     *
8134     * Remember that you can create new styles and add your own theme
8135     * augmentation per application with elm_theme_extension_add(). If
8136     * you absolutely must have a specific style that overrides any
8137     * theme the user or system sets up you can use
8138     * elm_theme_overlay_add() to add such a file.
8139     *
8140     * @section Gengrid_Smart_Events Gengrid smart events
8141     *
8142     * Smart events that you can add callbacks for are:
8143     * - @c "activated" - The user has double-clicked or pressed
8144     *   (enter|return|spacebar) on an item. The @c event_info parameter
8145     *   is the gengrid item that was activated.
8146     * - @c "clicked,double" - The user has double-clicked an item.
8147     *   The @c event_info parameter is the gengrid item that was double-clicked.
8148     * - @c "longpressed" - This is called when the item is pressed for a certain
8149     *   amount of time. By default it's 1 second.
8150     * - @c "selected" - The user has made an item selected. The
8151     *   @c event_info parameter is the gengrid item that was selected.
8152     * - @c "unselected" - The user has made an item unselected. The
8153     *   @c event_info parameter is the gengrid item that was unselected.
8154     * - @c "realized" - This is called when the item in the gengrid
8155     *   has its implementing Evas object instantiated, de facto. @c
8156     *   event_info is the gengrid item that was created. The object
8157     *   may be deleted at any time, so it is highly advised to the
8158     *   caller @b not to use the object pointer returned from
8159     *   elm_gengrid_item_object_get(), because it may point to freed
8160     *   objects.
8161     * - @c "unrealized" - This is called when the implementing Evas
8162     *   object for this item is deleted. @c event_info is the gengrid
8163     *   item that was deleted.
8164     * - @c "changed" - Called when an item is added, removed, resized
8165     *   or moved and when the gengrid is resized or gets "horizontal"
8166     *   property changes.
8167     * - @c "scroll,anim,start" - This is called when scrolling animation has
8168     *   started.
8169     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8170     *   stopped.
8171     * - @c "drag,start,up" - Called when the item in the gengrid has
8172     *   been dragged (not scrolled) up.
8173     * - @c "drag,start,down" - Called when the item in the gengrid has
8174     *   been dragged (not scrolled) down.
8175     * - @c "drag,start,left" - Called when the item in the gengrid has
8176     *   been dragged (not scrolled) left.
8177     * - @c "drag,start,right" - Called when the item in the gengrid has
8178     *   been dragged (not scrolled) right.
8179     * - @c "drag,stop" - Called when the item in the gengrid has
8180     *   stopped being dragged.
8181     * - @c "drag" - Called when the item in the gengrid is being
8182     *   dragged.
8183     * - @c "scroll" - called when the content has been scrolled
8184     *   (moved).
8185     * - @c "scroll,drag,start" - called when dragging the content has
8186     *   started.
8187     * - @c "scroll,drag,stop" - called when dragging the content has
8188     *   stopped.
8189     * - @c "edge,top" - This is called when the gengrid is scrolled until
8190     *   the top edge.
8191     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8192     *   until the bottom edge.
8193     * - @c "edge,left" - This is called when the gengrid is scrolled
8194     *   until the left edge.
8195     * - @c "edge,right" - This is called when the gengrid is scrolled
8196     *   until the right edge.
8197     *
8198     * List of gengrid examples:
8199     * @li @ref gengrid_example
8200     */
8201
8202    /**
8203     * @addtogroup Gengrid
8204     * @{
8205     */
8206
8207    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8208    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8209    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8210    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8211    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8212    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8213    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. */
8214    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. */
8215    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8216
8217    /**
8218     * @struct _Elm_Gengrid_Item_Class
8219     *
8220     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8221     * field details.
8222     */
8223    struct _Elm_Gengrid_Item_Class
8224      {
8225         const char             *item_style;
8226         struct _Elm_Gengrid_Item_Class_Func
8227           {
8228              Elm_Gengrid_Item_Label_Get_Cb label_get;
8229              Elm_Gengrid_Item_Content_Get_Cb content_get;
8230              Elm_Gengrid_Item_State_Get_Cb state_get;
8231              Elm_Gengrid_Item_Del_Cb       del;
8232           } func;
8233      }; /**< #Elm_Gengrid_Item_Class member definitions */
8234    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8235    /**
8236     * Add a new gengrid widget to the given parent Elementary
8237     * (container) object
8238     *
8239     * @param parent The parent object
8240     * @return a new gengrid widget handle or @c NULL, on errors
8241     *
8242     * This function inserts a new gengrid widget on the canvas.
8243     *
8244     * @see elm_gengrid_item_size_set()
8245     * @see elm_gengrid_group_item_size_set()
8246     * @see elm_gengrid_horizontal_set()
8247     * @see elm_gengrid_item_append()
8248     * @see elm_gengrid_item_del()
8249     * @see elm_gengrid_clear()
8250     *
8251     * @ingroup Gengrid
8252     */
8253    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8254
8255    /**
8256     * Set the size for the items of a given gengrid widget
8257     *
8258     * @param obj The gengrid object.
8259     * @param w The items' width.
8260     * @param h The items' height;
8261     *
8262     * A gengrid, after creation, has still no information on the size
8263     * to give to each of its cells. So, you most probably will end up
8264     * with squares one @ref Fingers "finger" wide, the default
8265     * size. Use this function to force a custom size for you items,
8266     * making them as big as you wish.
8267     *
8268     * @see elm_gengrid_item_size_get()
8269     *
8270     * @ingroup Gengrid
8271     */
8272    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8273
8274    /**
8275     * Get the size set for the items of a given gengrid widget
8276     *
8277     * @param obj The gengrid object.
8278     * @param w Pointer to a variable where to store the items' width.
8279     * @param h Pointer to a variable where to store the items' height.
8280     *
8281     * @note Use @c NULL pointers on the size values you're not
8282     * interested in: they'll be ignored by the function.
8283     *
8284     * @see elm_gengrid_item_size_get() for more details
8285     *
8286     * @ingroup Gengrid
8287     */
8288    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8289
8290    /**
8291     * Set the size for the group items of a given gengrid widget
8292     *
8293     * @param obj The gengrid object.
8294     * @param w The group items' width.
8295     * @param h The group items' height;
8296     *
8297     * A gengrid, after creation, has still no information on the size
8298     * to give to each of its cells. So, you most probably will end up
8299     * with squares one @ref Fingers "finger" wide, the default
8300     * size. Use this function to force a custom size for you group items,
8301     * making them as big as you wish.
8302     *
8303     * @see elm_gengrid_group_item_size_get()
8304     *
8305     * @ingroup Gengrid
8306     */
8307    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8308
8309    /**
8310     * Get the size set for the group items of a given gengrid widget
8311     *
8312     * @param obj The gengrid object.
8313     * @param w Pointer to a variable where to store the group items' width.
8314     * @param h Pointer to a variable where to store the group items' height.
8315     *
8316     * @note Use @c NULL pointers on the size values you're not
8317     * interested in: they'll be ignored by the function.
8318     *
8319     * @see elm_gengrid_group_item_size_get() for more details
8320     *
8321     * @ingroup Gengrid
8322     */
8323    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8324
8325    /**
8326     * Set the items grid's alignment within a given gengrid widget
8327     *
8328     * @param obj The gengrid object.
8329     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8330     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8331     *
8332     * This sets the alignment of the whole grid of items of a gengrid
8333     * within its given viewport. By default, those values are both
8334     * 0.5, meaning that the gengrid will have its items grid placed
8335     * exactly in the middle of its viewport.
8336     *
8337     * @note If given alignment values are out of the cited ranges,
8338     * they'll be changed to the nearest boundary values on the valid
8339     * ranges.
8340     *
8341     * @see elm_gengrid_align_get()
8342     *
8343     * @ingroup Gengrid
8344     */
8345    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8346
8347    /**
8348     * Get the items grid's alignment values within a given gengrid
8349     * widget
8350     *
8351     * @param obj The gengrid object.
8352     * @param align_x Pointer to a variable where to store the
8353     * horizontal alignment.
8354     * @param align_y Pointer to a variable where to store the vertical
8355     * alignment.
8356     *
8357     * @note Use @c NULL pointers on the alignment values you're not
8358     * interested in: they'll be ignored by the function.
8359     *
8360     * @see elm_gengrid_align_set() for more details
8361     *
8362     * @ingroup Gengrid
8363     */
8364    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8365
8366    /**
8367     * Set whether a given gengrid widget is or not able have items
8368     * @b reordered
8369     *
8370     * @param obj The gengrid object
8371     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8372     * @c EINA_FALSE to turn it off
8373     *
8374     * If a gengrid is set to allow reordering, a click held for more
8375     * than 0.5 over a given item will highlight it specially,
8376     * signalling the gengrid has entered the reordering state. From
8377     * that time on, the user will be able to, while still holding the
8378     * mouse button down, move the item freely in the gengrid's
8379     * viewport, replacing to said item to the locations it goes to.
8380     * The replacements will be animated and, whenever the user
8381     * releases the mouse button, the item being replaced gets a new
8382     * definitive place in the grid.
8383     *
8384     * @see elm_gengrid_reorder_mode_get()
8385     *
8386     * @ingroup Gengrid
8387     */
8388    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8389
8390    /**
8391     * Get whether a given gengrid widget is or not able have items
8392     * @b reordered
8393     *
8394     * @param obj The gengrid object
8395     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8396     * off
8397     *
8398     * @see elm_gengrid_reorder_mode_set() for more details
8399     *
8400     * @ingroup Gengrid
8401     */
8402    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8403
8404    /**
8405     * Append a new item in a given gengrid widget.
8406     *
8407     * @param obj The gengrid object.
8408     * @param gic The item class for the item.
8409     * @param data The item data.
8410     * @param func Convenience function called when the item is
8411     * selected.
8412     * @param func_data Data to be passed to @p func.
8413     * @return A handle to the item added or @c NULL, on errors.
8414     *
8415     * This adds an item to the beginning of the gengrid.
8416     *
8417     * @see elm_gengrid_item_prepend()
8418     * @see elm_gengrid_item_insert_before()
8419     * @see elm_gengrid_item_insert_after()
8420     * @see elm_gengrid_item_del()
8421     *
8422     * @ingroup Gengrid
8423     */
8424    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);
8425
8426    /**
8427     * Prepend a new item in a given gengrid widget.
8428     *
8429     * @param obj The gengrid object.
8430     * @param gic The item class for the item.
8431     * @param data The item data.
8432     * @param func Convenience function called when the item is
8433     * selected.
8434     * @param func_data Data to be passed to @p func.
8435     * @return A handle to the item added or @c NULL, on errors.
8436     *
8437     * This adds an item to the end of the gengrid.
8438     *
8439     * @see elm_gengrid_item_append()
8440     * @see elm_gengrid_item_insert_before()
8441     * @see elm_gengrid_item_insert_after()
8442     * @see elm_gengrid_item_del()
8443     *
8444     * @ingroup Gengrid
8445     */
8446    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);
8447
8448    /**
8449     * Insert an item before another in a gengrid widget
8450     *
8451     * @param obj The gengrid object.
8452     * @param gic The item class for the item.
8453     * @param data The item data.
8454     * @param relative The item to place this new one before.
8455     * @param func Convenience function called when the item is
8456     * selected.
8457     * @param func_data Data to be passed to @p func.
8458     * @return A handle to the item added or @c NULL, on errors.
8459     *
8460     * This inserts an item before another in the gengrid.
8461     *
8462     * @see elm_gengrid_item_append()
8463     * @see elm_gengrid_item_prepend()
8464     * @see elm_gengrid_item_insert_after()
8465     * @see elm_gengrid_item_del()
8466     *
8467     * @ingroup Gengrid
8468     */
8469    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);
8470
8471    /**
8472     * Insert an item after another in a gengrid widget
8473     *
8474     * @param obj The gengrid object.
8475     * @param gic The item class for the item.
8476     * @param data The item data.
8477     * @param relative The item to place this new one after.
8478     * @param func Convenience function called when the item is
8479     * selected.
8480     * @param func_data Data to be passed to @p func.
8481     * @return A handle to the item added or @c NULL, on errors.
8482     *
8483     * This inserts an item after another in the gengrid.
8484     *
8485     * @see elm_gengrid_item_append()
8486     * @see elm_gengrid_item_prepend()
8487     * @see elm_gengrid_item_insert_after()
8488     * @see elm_gengrid_item_del()
8489     *
8490     * @ingroup Gengrid
8491     */
8492    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);
8493
8494    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);
8495
8496    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);
8497
8498    /**
8499     * Set whether items on a given gengrid widget are to get their
8500     * selection callbacks issued for @b every subsequent selection
8501     * click on them or just for the first click.
8502     *
8503     * @param obj The gengrid object
8504     * @param always_select @c EINA_TRUE to make items "always
8505     * selected", @c EINA_FALSE, otherwise
8506     *
8507     * By default, grid items will only call their selection callback
8508     * function when firstly getting selected, any subsequent further
8509     * clicks will do nothing. With this call, you make those
8510     * subsequent clicks also to issue the selection callbacks.
8511     *
8512     * @note <b>Double clicks</b> will @b always be reported on items.
8513     *
8514     * @see elm_gengrid_always_select_mode_get()
8515     *
8516     * @ingroup Gengrid
8517     */
8518    EINA_DEPRECATED EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8519
8520    /**
8521     * Get whether items on a given gengrid widget have their selection
8522     * callbacks issued for @b every subsequent selection click on them
8523     * or just for the first click.
8524     *
8525     * @param obj The gengrid object.
8526     * @return @c EINA_TRUE if the gengrid items are "always selected",
8527     * @c EINA_FALSE, otherwise
8528     *
8529     * @see elm_gengrid_always_select_mode_set() for more details
8530     *
8531     * @ingroup Gengrid
8532     */
8533    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8534
8535    /**
8536     * Set whether items on a given gengrid widget can be selected or not.
8537     *
8538     * @param obj The gengrid object
8539     * @param no_select @c EINA_TRUE to make items selectable,
8540     * @c EINA_FALSE otherwise
8541     *
8542     * This will make items in @p obj selectable or not. In the latter
8543     * case, any user interaction on the gengrid items will neither make
8544     * them appear selected nor them call their selection callback
8545     * functions.
8546     *
8547     * @see elm_gengrid_no_select_mode_get()
8548     *
8549     * @ingroup Gengrid
8550     */
8551    EINA_DEPRECATED EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8552
8553    /**
8554     * Get whether items on a given gengrid widget can be selected or
8555     * not.
8556     *
8557     * @param obj The gengrid object
8558     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8559     * otherwise
8560     *
8561     * @see elm_gengrid_no_select_mode_set() for more details
8562     *
8563     * @ingroup Gengrid
8564     */
8565    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8566
8567    /**
8568     * Enable or disable multi-selection in a given gengrid widget
8569     *
8570     * @param obj The gengrid object.
8571     * @param multi @c EINA_TRUE, to enable multi-selection,
8572     * @c EINA_FALSE to disable it.
8573     *
8574     * Multi-selection is the ability for one to have @b more than one
8575     * item selected, on a given gengrid, simultaneously. When it is
8576     * enabled, a sequence of clicks on different items will make them
8577     * all selected, progressively. A click on an already selected item
8578     * will unselect it. If interecting via the keyboard,
8579     * multi-selection is enabled while holding the "Shift" key.
8580     *
8581     * @note By default, multi-selection is @b disabled on gengrids
8582     *
8583     * @see elm_gengrid_multi_select_get()
8584     *
8585     * @ingroup Gengrid
8586     */
8587    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8588
8589    /**
8590     * Get whether multi-selection is enabled or disabled for a given
8591     * gengrid widget
8592     *
8593     * @param obj The gengrid object.
8594     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8595     * EINA_FALSE otherwise
8596     *
8597     * @see elm_gengrid_multi_select_set() for more details
8598     *
8599     * @ingroup Gengrid
8600     */
8601    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8602
8603    /**
8604     * Enable or disable bouncing effect for a given gengrid widget
8605     *
8606     * @param obj The gengrid object
8607     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8608     * @c EINA_FALSE to disable it
8609     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8610     * @c EINA_FALSE to disable it
8611     *
8612     * The bouncing effect occurs whenever one reaches the gengrid's
8613     * edge's while panning it -- it will scroll past its limits a
8614     * little bit and return to the edge again, in a animated for,
8615     * automatically.
8616     *
8617     * @note By default, gengrids have bouncing enabled on both axis
8618     *
8619     * @see elm_gengrid_bounce_get()
8620     *
8621     * @ingroup Gengrid
8622     */
8623    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8624
8625    /**
8626     * Get whether bouncing effects are enabled or disabled, for a
8627     * given gengrid widget, on each axis
8628     *
8629     * @param obj The gengrid object
8630     * @param h_bounce Pointer to a variable where to store the
8631     * horizontal bouncing flag.
8632     * @param v_bounce Pointer to a variable where to store the
8633     * vertical bouncing flag.
8634     *
8635     * @see elm_gengrid_bounce_set() for more details
8636     *
8637     * @ingroup Gengrid
8638     */
8639    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8640
8641    /**
8642     * Set a given gengrid widget's scrolling page size, relative to
8643     * its viewport size.
8644     *
8645     * @param obj The gengrid object
8646     * @param h_pagerel The horizontal page (relative) size
8647     * @param v_pagerel The vertical page (relative) size
8648     *
8649     * The gengrid's scroller is capable of binding scrolling by the
8650     * user to "pages". It means that, while scrolling and, specially
8651     * after releasing the mouse button, the grid will @b snap to the
8652     * nearest displaying page's area. When page sizes are set, the
8653     * grid's continuous content area is split into (equal) page sized
8654     * pieces.
8655     *
8656     * This function sets the size of a page <b>relatively to the
8657     * viewport dimensions</b> of the gengrid, for each axis. A value
8658     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8659     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8660     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8661     * 1.0. Values beyond those will make it behave behave
8662     * inconsistently. If you only want one axis to snap to pages, use
8663     * the value @c 0.0 for the other one.
8664     *
8665     * There is a function setting page size values in @b absolute
8666     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8667     * is mutually exclusive to this one.
8668     *
8669     * @see elm_gengrid_page_relative_get()
8670     *
8671     * @ingroup Gengrid
8672     */
8673    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8674
8675    /**
8676     * Get a given gengrid widget's scrolling page size, relative to
8677     * its viewport size.
8678     *
8679     * @param obj The gengrid object
8680     * @param h_pagerel Pointer to a variable where to store the
8681     * horizontal page (relative) size
8682     * @param v_pagerel Pointer to a variable where to store the
8683     * vertical page (relative) size
8684     *
8685     * @see elm_gengrid_page_relative_set() for more details
8686     *
8687     * @ingroup Gengrid
8688     */
8689    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8690
8691    /**
8692     * Set a given gengrid widget's scrolling page size
8693     *
8694     * @param obj The gengrid object
8695     * @param h_pagerel The horizontal page size, in pixels
8696     * @param v_pagerel The vertical page size, in pixels
8697     *
8698     * The gengrid's scroller is capable of binding scrolling by the
8699     * user to "pages". It means that, while scrolling and, specially
8700     * after releasing the mouse button, the grid will @b snap to the
8701     * nearest displaying page's area. When page sizes are set, the
8702     * grid's continuous content area is split into (equal) page sized
8703     * pieces.
8704     *
8705     * This function sets the size of a page of the gengrid, in pixels,
8706     * for each axis. Sane usable values are, between @c 0 and the
8707     * dimensions of @p obj, for each axis. Values beyond those will
8708     * make it behave behave inconsistently. If you only want one axis
8709     * to snap to pages, use the value @c 0 for the other one.
8710     *
8711     * There is a function setting page size values in @b relative
8712     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8713     * use is mutually exclusive to this one.
8714     *
8715     * @ingroup Gengrid
8716     */
8717    EINA_DEPRECATED EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8718
8719    /**
8720     * @brief Get gengrid current page number.
8721     *
8722     * @param obj The gengrid object
8723     * @param h_pagenumber The horizontal page number
8724     * @param v_pagenumber The vertical page number
8725     *
8726     * The page number starts from 0. 0 is the first page.
8727     * Current page means the page which meet the top-left of the viewport.
8728     * If there are two or more pages in the viewport, it returns the number of page
8729     * which meet the top-left of the viewport.
8730     *
8731     * @see elm_gengrid_last_page_get()
8732     * @see elm_gengrid_page_show()
8733     * @see elm_gengrid_page_brint_in()
8734     */
8735    EINA_DEPRECATED EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8736
8737    /**
8738     * @brief Get scroll last page number.
8739     *
8740     * @param obj The gengrid object
8741     * @param h_pagenumber The horizontal page number
8742     * @param v_pagenumber The vertical page number
8743     *
8744     * The page number starts from 0. 0 is the first page.
8745     * This returns the last page number among the pages.
8746     *
8747     * @see elm_gengrid_current_page_get()
8748     * @see elm_gengrid_page_show()
8749     * @see elm_gengrid_page_brint_in()
8750     */
8751    EINA_DEPRECATED EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8752
8753    /**
8754     * Show a specific virtual region within the gengrid content object by page number.
8755     *
8756     * @param obj The gengrid object
8757     * @param h_pagenumber The horizontal page number
8758     * @param v_pagenumber The vertical page number
8759     *
8760     * 0, 0 of the indicated page is located at the top-left of the viewport.
8761     * This will jump to the page directly without animation.
8762     *
8763     * Example of usage:
8764     *
8765     * @code
8766     * sc = elm_gengrid_add(win);
8767     * elm_gengrid_content_set(sc, content);
8768     * elm_gengrid_page_relative_set(sc, 1, 0);
8769     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8770     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8771     * @endcode
8772     *
8773     * @see elm_gengrid_page_bring_in()
8774     */
8775    EINA_DEPRECATED EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8776
8777    /**
8778     * Show a specific virtual region within the gengrid content object by page number.
8779     *
8780     * @param obj The gengrid object
8781     * @param h_pagenumber The horizontal page number
8782     * @param v_pagenumber The vertical page number
8783     *
8784     * 0, 0 of the indicated page is located at the top-left of the viewport.
8785     * This will slide to the page with animation.
8786     *
8787     * Example of usage:
8788     *
8789     * @code
8790     * sc = elm_gengrid_add(win);
8791     * elm_gengrid_content_set(sc, content);
8792     * elm_gengrid_page_relative_set(sc, 1, 0);
8793     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8794     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8795     * @endcode
8796     *
8797     * @see elm_gengrid_page_show()
8798     */
8799     EINA_DEPRECATED EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8800
8801    /**
8802     * Set for what direction a given gengrid widget will expand while
8803     * placing its items.
8804     *
8805     * @param obj The gengrid object.
8806     * @param setting @c EINA_TRUE to make the gengrid expand
8807     * horizontally, @c EINA_FALSE to expand vertically.
8808     *
8809     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8810     * in @b columns, from top to bottom and, when the space for a
8811     * column is filled, another one is started on the right, thus
8812     * expanding the grid horizontally. When in "vertical mode"
8813     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8814     * to right and, when the space for a row is filled, another one is
8815     * started below, thus expanding the grid vertically.
8816     *
8817     * @see elm_gengrid_horizontal_get()
8818     *
8819     * @ingroup Gengrid
8820     */
8821    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8822
8823    /**
8824     * Get for what direction a given gengrid widget will expand while
8825     * placing its items.
8826     *
8827     * @param obj The gengrid object.
8828     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8829     * @c EINA_FALSE if it's set to expand vertically.
8830     *
8831     * @see elm_gengrid_horizontal_set() for more detais
8832     *
8833     * @ingroup Gengrid
8834     */
8835    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8836
8837    /**
8838     * Get the first item in a given gengrid widget
8839     *
8840     * @param obj The gengrid object
8841     * @return The first item's handle or @c NULL, if there are no
8842     * items in @p obj (and on errors)
8843     *
8844     * This returns the first item in the @p obj's internal list of
8845     * items.
8846     *
8847     * @see elm_gengrid_last_item_get()
8848     *
8849     * @ingroup Gengrid
8850     */
8851    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8852
8853    /**
8854     * Get the last item in a given gengrid widget
8855     *
8856     * @param obj The gengrid object
8857     * @return The last item's handle or @c NULL, if there are no
8858     * items in @p obj (and on errors)
8859     *
8860     * This returns the last item in the @p obj's internal list of
8861     * items.
8862     *
8863     * @see elm_gengrid_first_item_get()
8864     *
8865     * @ingroup Gengrid
8866     */
8867    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8868
8869    /**
8870     * Get the @b next item in a gengrid widget's internal list of items,
8871     * given a handle to one of those items.
8872     *
8873     * @param item The gengrid item to fetch next from
8874     * @return The item after @p item, or @c NULL if there's none (and
8875     * on errors)
8876     *
8877     * This returns the item placed after the @p item, on the container
8878     * gengrid.
8879     *
8880     * @see elm_gengrid_item_prev_get()
8881     *
8882     * @ingroup Gengrid
8883     */
8884    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8885
8886    /**
8887     * Get the @b previous item in a gengrid widget's internal list of items,
8888     * given a handle to one of those items.
8889     *
8890     * @param item The gengrid item to fetch previous from
8891     * @return The item before @p item, or @c NULL if there's none (and
8892     * on errors)
8893     *
8894     * This returns the item placed before the @p item, on the container
8895     * gengrid.
8896     *
8897     * @see elm_gengrid_item_next_get()
8898     *
8899     * @ingroup Gengrid
8900     */
8901    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8902
8903    /**
8904     * Get the gengrid object's handle which contains a given gengrid
8905     * item
8906     *
8907     * @param item The item to fetch the container from
8908     * @return The gengrid (parent) object
8909     *
8910     * This returns the gengrid object itself that an item belongs to.
8911     *
8912     * @ingroup Gengrid
8913     */
8914    EINA_DEPRECATED EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8915
8916    /**
8917     * Remove a gengrid item from the its parent, deleting it.
8918     *
8919     * @param item The item to be removed.
8920     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8921     *
8922     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8923     * once.
8924     *
8925     * @ingroup Gengrid
8926     */
8927    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8928
8929    /**
8930     * Update the contents of a given gengrid item
8931     *
8932     * @param item The gengrid item
8933     *
8934     * This updates an item by calling all the item class functions
8935     * again to get the contents, labels and states. Use this when the
8936     * original item data has changed and you want thta changes to be
8937     * reflected.
8938     *
8939     * @ingroup Gengrid
8940     */
8941    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8942    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8943    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8944
8945    /**
8946     * Return the data associated to a given gengrid item
8947     *
8948     * @param item The gengrid item.
8949     * @return the data associated to this item.
8950     *
8951     * This returns the @c data value passed on the
8952     * elm_gengrid_item_append() and related item addition calls.
8953     *
8954     * @see elm_gengrid_item_append()
8955     * @see elm_gengrid_item_data_set()
8956     *
8957     * @ingroup Gengrid
8958     */
8959    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8960
8961    /**
8962     * Set the data associated to a given gengrid item
8963     *
8964     * @param item The gengrid item
8965     * @param data The new data pointer to set on it
8966     *
8967     * This @b overrides the @c data value passed on the
8968     * elm_gengrid_item_append() and related item addition calls. This
8969     * function @b won't call elm_gengrid_item_update() automatically,
8970     * so you'd issue it afterwards if you want to hove the item
8971     * updated to reflect the that new data.
8972     *
8973     * @see elm_gengrid_item_data_get()
8974     *
8975     * @ingroup Gengrid
8976     */
8977    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8978
8979    /**
8980     * Get a given gengrid item's position, relative to the whole
8981     * gengrid's grid area.
8982     *
8983     * @param item The Gengrid item.
8984     * @param x Pointer to variable where to store the item's <b>row
8985     * number</b>.
8986     * @param y Pointer to variable where to store the item's <b>column
8987     * number</b>.
8988     *
8989     * This returns the "logical" position of the item whithin the
8990     * gengrid. For example, @c (0, 1) would stand for first row,
8991     * second column.
8992     *
8993     * @ingroup Gengrid
8994     */
8995    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8996
8997    /**
8998     * Set whether a given gengrid item is selected or not
8999     *
9000     * @param item The gengrid item
9001     * @param selected Use @c EINA_TRUE, to make it selected, @c
9002     * EINA_FALSE to make it unselected
9003     *
9004     * This sets the selected state of an item. If multi selection is
9005     * not enabled on the containing gengrid and @p selected is @c
9006     * EINA_TRUE, any other previously selected items will get
9007     * unselected in favor of this new one.
9008     *
9009     * @see elm_gengrid_item_selected_get()
9010     *
9011     * @ingroup Gengrid
9012     */
9013    EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9014
9015    /**
9016     * Get whether a given gengrid item is selected or not
9017     *
9018     * @param item The gengrid item
9019     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9020     *
9021     * @see elm_gengrid_item_selected_set() for more details
9022     *
9023     * @ingroup Gengrid
9024     */
9025    EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9026
9027    /**
9028     * Get the real Evas object created to implement the view of a
9029     * given gengrid item
9030     *
9031     * @param item The gengrid item.
9032     * @return the Evas object implementing this item's view.
9033     *
9034     * This returns the actual Evas object used to implement the
9035     * specified gengrid item's view. This may be @c NULL, as it may
9036     * not have been created or may have been deleted, at any time, by
9037     * the gengrid. <b>Do not modify this object</b> (move, resize,
9038     * show, hide, etc.), as the gengrid is controlling it. This
9039     * function is for querying, emitting custom signals or hooking
9040     * lower level callbacks for events on that object. Do not delete
9041     * this object under any circumstances.
9042     *
9043     * @see elm_gengrid_item_data_get()
9044     *
9045     * @ingroup Gengrid
9046     */
9047    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9048
9049    /**
9050     * Show the portion of a gengrid's internal grid containing a given
9051     * item, @b immediately.
9052     *
9053     * @param item The item to display
9054     *
9055     * This causes gengrid to @b redraw its viewport's contents to the
9056     * region contining the given @p item item, if it is not fully
9057     * visible.
9058     *
9059     * @see elm_gengrid_item_bring_in()
9060     *
9061     * @ingroup Gengrid
9062     */
9063    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9064
9065    /**
9066     * Animatedly bring in, to the visible are of a gengrid, a given
9067     * item on it.
9068     *
9069     * @param item The gengrid item to display
9070     *
9071     * This causes gengrig to jump to the given @p item item and show
9072     * it (by scrolling), if it is not fully visible. This will use
9073     * animation to do so and take a period of time to complete.
9074     *
9075     * @see elm_gengrid_item_show()
9076     *
9077     * @ingroup Gengrid
9078     */
9079    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9080
9081    /**
9082     * Set whether a given gengrid item is disabled or not.
9083     *
9084     * @param item The gengrid item
9085     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9086     * to enable it back.
9087     *
9088     * A disabled item cannot be selected or unselected. It will also
9089     * change its appearance, to signal the user it's disabled.
9090     *
9091     * @see elm_gengrid_item_disabled_get()
9092     *
9093     * @ingroup Gengrid
9094     */
9095    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9096
9097    /**
9098     * Get whether a given gengrid item is disabled or not.
9099     *
9100     * @param item The gengrid item
9101     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9102     * (and on errors).
9103     *
9104     * @see elm_gengrid_item_disabled_set() for more details
9105     *
9106     * @ingroup Gengrid
9107     */
9108    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9109
9110    /**
9111     * Set the text to be shown in a given gengrid item's tooltips.
9112     *
9113     * @param item The gengrid item
9114     * @param text The text to set in the content
9115     *
9116     * This call will setup the text to be used as tooltip to that item
9117     * (analogous to elm_object_tooltip_text_set(), but being item
9118     * tooltips with higher precedence than object tooltips). It can
9119     * have only one tooltip at a time, so any previous tooltip data
9120     * will get removed.
9121     *
9122     * @ingroup Gengrid
9123     */
9124    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9125
9126    /**
9127     * Set the content to be shown in a given gengrid item's tooltips
9128     *
9129     * @param item The gengrid item.
9130     * @param func The function returning the tooltip contents.
9131     * @param data What to provide to @a func as callback data/context.
9132     * @param del_cb Called when data is not needed anymore, either when
9133     *        another callback replaces @p func, the tooltip is unset with
9134     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9135     *        dies. This callback receives as its first parameter the
9136     *        given @p data, being @c event_info the item handle.
9137     *
9138     * This call will setup the tooltip's contents to @p item
9139     * (analogous to elm_object_tooltip_content_cb_set(), but being
9140     * item tooltips with higher precedence than object tooltips). It
9141     * can have only one tooltip at a time, so any previous tooltip
9142     * content will get removed. @p func (with @p data) will be called
9143     * every time Elementary needs to show the tooltip and it should
9144     * return a valid Evas object, which will be fully managed by the
9145     * tooltip system, getting deleted when the tooltip is gone.
9146     *
9147     * @ingroup Gengrid
9148     */
9149    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);
9150
9151    /**
9152     * Unset a tooltip from a given gengrid item
9153     *
9154     * @param item gengrid item to remove a previously set tooltip from.
9155     *
9156     * This call removes any tooltip set on @p item. The callback
9157     * provided as @c del_cb to
9158     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9159     * notify it is not used anymore (and have resources cleaned, if
9160     * need be).
9161     *
9162     * @see elm_gengrid_item_tooltip_content_cb_set()
9163     *
9164     * @ingroup Gengrid
9165     */
9166    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9167
9168    /**
9169     * Set a different @b style for a given gengrid item's tooltip.
9170     *
9171     * @param item gengrid item with tooltip set
9172     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9173     * "default", @c "transparent", etc)
9174     *
9175     * Tooltips can have <b>alternate styles</b> to be displayed on,
9176     * which are defined by the theme set on Elementary. This function
9177     * works analogously as elm_object_tooltip_style_set(), but here
9178     * applied only to gengrid item objects. The default style for
9179     * tooltips is @c "default".
9180     *
9181     * @note before you set a style you should define a tooltip with
9182     *       elm_gengrid_item_tooltip_content_cb_set() or
9183     *       elm_gengrid_item_tooltip_text_set()
9184     *
9185     * @see elm_gengrid_item_tooltip_style_get()
9186     *
9187     * @ingroup Gengrid
9188     */
9189    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9190
9191    /**
9192     * Get the style set a given gengrid item's tooltip.
9193     *
9194     * @param item gengrid item with tooltip already set on.
9195     * @return style the theme style in use, which defaults to
9196     *         "default". If the object does not have a tooltip set,
9197     *         then @c NULL is returned.
9198     *
9199     * @see elm_gengrid_item_tooltip_style_set() for more details
9200     *
9201     * @ingroup Gengrid
9202     */
9203    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9204    /**
9205     * @brief Disable size restrictions on an object's tooltip
9206     * @param item The tooltip's anchor object
9207     * @param disable If EINA_TRUE, size restrictions are disabled
9208     * @return EINA_FALSE on failure, EINA_TRUE on success
9209     *
9210     * This function allows a tooltip to expand beyond its parant window's canvas.
9211     * It will instead be limited only by the size of the display.
9212     */
9213    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9214    /**
9215     * @brief Retrieve size restriction state of an object's tooltip
9216     * @param item The tooltip's anchor object
9217     * @return If EINA_TRUE, size restrictions are disabled
9218     *
9219     * This function returns whether a tooltip is allowed to expand beyond
9220     * its parant window's canvas.
9221     * It will instead be limited only by the size of the display.
9222     */
9223    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9224    /**
9225     * Set the type of mouse pointer/cursor decoration to be shown,
9226     * when the mouse pointer is over the given gengrid widget item
9227     *
9228     * @param item gengrid item to customize cursor on
9229     * @param cursor the cursor type's name
9230     *
9231     * This function works analogously as elm_object_cursor_set(), but
9232     * here the cursor's changing area is restricted to the item's
9233     * area, and not the whole widget's. Note that that item cursors
9234     * have precedence over widget cursors, so that a mouse over @p
9235     * item will always show cursor @p type.
9236     *
9237     * If this function is called twice for an object, a previously set
9238     * cursor will be unset on the second call.
9239     *
9240     * @see elm_object_cursor_set()
9241     * @see elm_gengrid_item_cursor_get()
9242     * @see elm_gengrid_item_cursor_unset()
9243     *
9244     * @ingroup Gengrid
9245     */
9246    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9247
9248    /**
9249     * Get the type of mouse pointer/cursor decoration set to be shown,
9250     * when the mouse pointer is over the given gengrid widget item
9251     *
9252     * @param item gengrid item with custom cursor set
9253     * @return the cursor type's name or @c NULL, if no custom cursors
9254     * were set to @p item (and on errors)
9255     *
9256     * @see elm_object_cursor_get()
9257     * @see elm_gengrid_item_cursor_set() for more details
9258     * @see elm_gengrid_item_cursor_unset()
9259     *
9260     * @ingroup Gengrid
9261     */
9262    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9263
9264    /**
9265     * Unset any custom mouse pointer/cursor decoration set to be
9266     * shown, when the mouse pointer is over the given gengrid widget
9267     * item, thus making it show the @b default cursor again.
9268     *
9269     * @param item a gengrid item
9270     *
9271     * Use this call to undo any custom settings on this item's cursor
9272     * decoration, bringing it back to defaults (no custom style set).
9273     *
9274     * @see elm_object_cursor_unset()
9275     * @see elm_gengrid_item_cursor_set() for more details
9276     *
9277     * @ingroup Gengrid
9278     */
9279    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9280
9281    /**
9282     * Set a different @b style for a given custom cursor set for a
9283     * gengrid item.
9284     *
9285     * @param item gengrid item with custom cursor set
9286     * @param style the <b>theme style</b> to use (e.g. @c "default",
9287     * @c "transparent", etc)
9288     *
9289     * This function only makes sense when one is using custom mouse
9290     * cursor decorations <b>defined in a theme file</b> , which can
9291     * have, given a cursor name/type, <b>alternate styles</b> on
9292     * it. It works analogously as elm_object_cursor_style_set(), but
9293     * here applied only to gengrid item objects.
9294     *
9295     * @warning Before you set a cursor style you should have defined a
9296     *       custom cursor previously on the item, with
9297     *       elm_gengrid_item_cursor_set()
9298     *
9299     * @see elm_gengrid_item_cursor_engine_only_set()
9300     * @see elm_gengrid_item_cursor_style_get()
9301     *
9302     * @ingroup Gengrid
9303     */
9304    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9305
9306    /**
9307     * Get the current @b style set for a given gengrid item's custom
9308     * cursor
9309     *
9310     * @param item gengrid item with custom cursor set.
9311     * @return style the cursor style in use. If the object does not
9312     *         have a cursor set, then @c NULL is returned.
9313     *
9314     * @see elm_gengrid_item_cursor_style_set() for more details
9315     *
9316     * @ingroup Gengrid
9317     */
9318    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9319
9320    /**
9321     * Set if the (custom) cursor for a given gengrid item should be
9322     * searched in its theme, also, or should only rely on the
9323     * rendering engine.
9324     *
9325     * @param item item with custom (custom) cursor already set on
9326     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9327     * only on those provided by the rendering engine, @c EINA_FALSE to
9328     * have them searched on the widget's theme, as well.
9329     *
9330     * @note This call is of use only if you've set a custom cursor
9331     * for gengrid items, with elm_gengrid_item_cursor_set().
9332     *
9333     * @note By default, cursors will only be looked for between those
9334     * provided by the rendering engine.
9335     *
9336     * @ingroup Gengrid
9337     */
9338    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9339
9340    /**
9341     * Get if the (custom) cursor for a given gengrid item is being
9342     * searched in its theme, also, or is only relying on the rendering
9343     * engine.
9344     *
9345     * @param item a gengrid item
9346     * @return @c EINA_TRUE, if cursors are being looked for only on
9347     * those provided by the rendering engine, @c EINA_FALSE if they
9348     * are being searched on the widget's theme, as well.
9349     *
9350     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9351     *
9352     * @ingroup Gengrid
9353     */
9354    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9355
9356    /**
9357     * Remove all items from a given gengrid widget
9358     *
9359     * @param obj The gengrid object.
9360     *
9361     * This removes (and deletes) all items in @p obj, leaving it
9362     * empty.
9363     *
9364     * @see elm_gengrid_item_del(), to remove just one item.
9365     *
9366     * @ingroup Gengrid
9367     */
9368    EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9369
9370    /**
9371     * Get the selected item in a given gengrid widget
9372     *
9373     * @param obj The gengrid object.
9374     * @return The selected item's handleor @c NULL, if none is
9375     * selected at the moment (and on errors)
9376     *
9377     * This returns the selected item in @p obj. If multi selection is
9378     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9379     * the first item in the list is selected, which might not be very
9380     * useful. For that case, see elm_gengrid_selected_items_get().
9381     *
9382     * @ingroup Gengrid
9383     */
9384    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9385
9386    /**
9387     * Get <b>a list</b> of selected items in a given gengrid
9388     *
9389     * @param obj The gengrid object.
9390     * @return The list of selected items or @c NULL, if none is
9391     * selected at the moment (and on errors)
9392     *
9393     * This returns a list of the selected items, in the order that
9394     * they appear in the grid. This list is only valid as long as no
9395     * more items are selected or unselected (or unselected implictly
9396     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9397     * data, naturally.
9398     *
9399     * @see elm_gengrid_selected_item_get()
9400     *
9401     * @ingroup Gengrid
9402     */
9403    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9404
9405    /**
9406     * @}
9407     */
9408
9409    /**
9410     * @defgroup Clock Clock
9411     *
9412     * @image html img/widget/clock/preview-00.png
9413     * @image latex img/widget/clock/preview-00.eps
9414     *
9415     * This is a @b digital clock widget. In its default theme, it has a
9416     * vintage "flipping numbers clock" appearance, which will animate
9417     * sheets of individual algarisms individually as time goes by.
9418     *
9419     * A newly created clock will fetch system's time (already
9420     * considering local time adjustments) to start with, and will tick
9421     * accondingly. It may or may not show seconds.
9422     *
9423     * Clocks have an @b edition mode. When in it, the sheets will
9424     * display extra arrow indications on the top and bottom and the
9425     * user may click on them to raise or lower the time values. After
9426     * it's told to exit edition mode, it will keep ticking with that
9427     * new time set (it keeps the difference from local time).
9428     *
9429     * Also, when under edition mode, user clicks on the cited arrows
9430     * which are @b held for some time will make the clock to flip the
9431     * sheet, thus editing the time, continuosly and automatically for
9432     * the user. The interval between sheet flips will keep growing in
9433     * time, so that it helps the user to reach a time which is distant
9434     * from the one set.
9435     *
9436     * The time display is, by default, in military mode (24h), but an
9437     * am/pm indicator may be optionally shown, too, when it will
9438     * switch to 12h.
9439     *
9440     * Smart callbacks one can register to:
9441     * - "changed" - the clock's user changed the time
9442     *
9443     * Here is an example on its usage:
9444     * @li @ref clock_example
9445     */
9446
9447    /**
9448     * @addtogroup Clock
9449     * @{
9450     */
9451
9452    /**
9453     * Identifiers for which clock digits should be editable, when a
9454     * clock widget is in edition mode. Values may be ORed together to
9455     * make a mask, naturally.
9456     *
9457     * @see elm_clock_edit_set()
9458     * @see elm_clock_digit_edit_set()
9459     */
9460    typedef enum _Elm_Clock_Digedit
9461      {
9462         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9463         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9464         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9465         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9466         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9467         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9468         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9469         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9470      } Elm_Clock_Digedit;
9471
9472    /**
9473     * Add a new clock widget to the given parent Elementary
9474     * (container) object
9475     *
9476     * @param parent The parent object
9477     * @return a new clock widget handle or @c NULL, on errors
9478     *
9479     * This function inserts a new clock widget on the canvas.
9480     *
9481     * @ingroup Clock
9482     */
9483    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9484
9485    /**
9486     * Set a clock widget's time, programmatically
9487     *
9488     * @param obj The clock widget object
9489     * @param hrs The hours to set
9490     * @param min The minutes to set
9491     * @param sec The secondes to set
9492     *
9493     * This function updates the time that is showed by the clock
9494     * widget.
9495     *
9496     *  Values @b must be set within the following ranges:
9497     * - 0 - 23, for hours
9498     * - 0 - 59, for minutes
9499     * - 0 - 59, for seconds,
9500     *
9501     * even if the clock is not in "military" mode.
9502     *
9503     * @warning The behavior for values set out of those ranges is @b
9504     * indefined.
9505     *
9506     * @ingroup Clock
9507     */
9508    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9509
9510    /**
9511     * Get a clock widget's time values
9512     *
9513     * @param obj The clock object
9514     * @param[out] hrs Pointer to the variable to get the hours value
9515     * @param[out] min Pointer to the variable to get the minutes value
9516     * @param[out] sec Pointer to the variable to get the seconds value
9517     *
9518     * This function gets the time set for @p obj, returning
9519     * it on the variables passed as the arguments to function
9520     *
9521     * @note Use @c NULL pointers on the time values you're not
9522     * interested in: they'll be ignored by the function.
9523     *
9524     * @ingroup Clock
9525     */
9526    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9527
9528    /**
9529     * Set whether a given clock widget is under <b>edition mode</b> or
9530     * under (default) displaying-only mode.
9531     *
9532     * @param obj The clock object
9533     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9534     * put it back to "displaying only" mode
9535     *
9536     * This function makes a clock's time to be editable or not <b>by
9537     * user interaction</b>. When in edition mode, clocks @b stop
9538     * ticking, until one brings them back to canonical mode. The
9539     * elm_clock_digit_edit_set() function will influence which digits
9540     * of the clock will be editable. By default, all of them will be
9541     * (#ELM_CLOCK_NONE).
9542     *
9543     * @note am/pm sheets, if being shown, will @b always be editable
9544     * under edition mode.
9545     *
9546     * @see elm_clock_edit_get()
9547     *
9548     * @ingroup Clock
9549     */
9550    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9551
9552    /**
9553     * Retrieve whether a given clock widget is under <b>edition
9554     * mode</b> or under (default) displaying-only mode.
9555     *
9556     * @param obj The clock object
9557     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9558     * otherwise
9559     *
9560     * This function retrieves whether the clock's time can be edited
9561     * or not by user interaction.
9562     *
9563     * @see elm_clock_edit_set() for more details
9564     *
9565     * @ingroup Clock
9566     */
9567    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9568
9569    /**
9570     * Set what digits of the given clock widget should be editable
9571     * when in edition mode.
9572     *
9573     * @param obj The clock object
9574     * @param digedit Bit mask indicating the digits to be editable
9575     * (values in #Elm_Clock_Digedit).
9576     *
9577     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9578     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9579     * EINA_FALSE).
9580     *
9581     * @see elm_clock_digit_edit_get()
9582     *
9583     * @ingroup Clock
9584     */
9585    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9586
9587    /**
9588     * Retrieve what digits of the given clock widget should be
9589     * editable when in edition mode.
9590     *
9591     * @param obj The clock object
9592     * @return Bit mask indicating the digits to be editable
9593     * (values in #Elm_Clock_Digedit).
9594     *
9595     * @see elm_clock_digit_edit_set() for more details
9596     *
9597     * @ingroup Clock
9598     */
9599    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9600
9601    /**
9602     * Set if the given clock widget must show hours in military or
9603     * am/pm mode
9604     *
9605     * @param obj The clock object
9606     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9607     * to military mode
9608     *
9609     * This function sets if the clock must show hours in military or
9610     * am/pm mode. In some countries like Brazil the military mode
9611     * (00-24h-format) is used, in opposition to the USA, where the
9612     * am/pm mode is more commonly used.
9613     *
9614     * @see elm_clock_show_am_pm_get()
9615     *
9616     * @ingroup Clock
9617     */
9618    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9619
9620    /**
9621     * Get if the given clock widget shows hours in military or am/pm
9622     * mode
9623     *
9624     * @param obj The clock object
9625     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9626     * military
9627     *
9628     * This function gets if the clock shows hours in military or am/pm
9629     * mode.
9630     *
9631     * @see elm_clock_show_am_pm_set() for more details
9632     *
9633     * @ingroup Clock
9634     */
9635    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9636
9637    /**
9638     * Set if the given clock widget must show time with seconds or not
9639     *
9640     * @param obj The clock object
9641     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9642     *
9643     * This function sets if the given clock must show or not elapsed
9644     * seconds. By default, they are @b not shown.
9645     *
9646     * @see elm_clock_show_seconds_get()
9647     *
9648     * @ingroup Clock
9649     */
9650    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9651
9652    /**
9653     * Get whether the given clock widget is showing time with seconds
9654     * or not
9655     *
9656     * @param obj The clock object
9657     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9658     *
9659     * This function gets whether @p obj is showing or not the elapsed
9660     * seconds.
9661     *
9662     * @see elm_clock_show_seconds_set()
9663     *
9664     * @ingroup Clock
9665     */
9666    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9667
9668    /**
9669     * Set the interval on time updates for an user mouse button hold
9670     * on clock widgets' time edition.
9671     *
9672     * @param obj The clock object
9673     * @param interval The (first) interval value in seconds
9674     *
9675     * This interval value is @b decreased while the user holds the
9676     * mouse pointer either incrementing or decrementing a given the
9677     * clock digit's value.
9678     *
9679     * This helps the user to get to a given time distant from the
9680     * current one easier/faster, as it will start to flip quicker and
9681     * quicker on mouse button holds.
9682     *
9683     * The calculation for the next flip interval value, starting from
9684     * the one set with this call, is the previous interval divided by
9685     * 1.05, so it decreases a little bit.
9686     *
9687     * The default starting interval value for automatic flips is
9688     * @b 0.85 seconds.
9689     *
9690     * @see elm_clock_interval_get()
9691     *
9692     * @ingroup Clock
9693     */
9694    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9695
9696    /**
9697     * Get the interval on time updates for an user mouse button hold
9698     * on clock widgets' time edition.
9699     *
9700     * @param obj The clock object
9701     * @return The (first) interval value, in seconds, set on it
9702     *
9703     * @see elm_clock_interval_set() for more details
9704     *
9705     * @ingroup Clock
9706     */
9707    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9708
9709    /**
9710     * @}
9711     */
9712
9713    /**
9714     * @defgroup Layout Layout
9715     *
9716     * @image html img/widget/layout/preview-00.png
9717     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9718     *
9719     * @image html img/layout-predefined.png
9720     * @image latex img/layout-predefined.eps width=\textwidth
9721     *
9722     * This is a container widget that takes a standard Edje design file and
9723     * wraps it very thinly in a widget.
9724     *
9725     * An Edje design (theme) file has a very wide range of possibilities to
9726     * describe the behavior of elements added to the Layout. Check out the Edje
9727     * documentation and the EDC reference to get more information about what can
9728     * be done with Edje.
9729     *
9730     * Just like @ref List, @ref Box, and other container widgets, any
9731     * object added to the Layout will become its child, meaning that it will be
9732     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9733     *
9734     * The Layout widget can contain as many Contents, Boxes or Tables as
9735     * described in its theme file. For instance, objects can be added to
9736     * different Tables by specifying the respective Table part names. The same
9737     * is valid for Content and Box.
9738     *
9739     * The objects added as child of the Layout will behave as described in the
9740     * part description where they were added. There are 3 possible types of
9741     * parts where a child can be added:
9742     *
9743     * @section secContent Content (SWALLOW part)
9744     *
9745     * Only one object can be added to the @c SWALLOW part (but you still can
9746     * have many @c SWALLOW parts and one object on each of them). Use the @c
9747     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9748     * objects as content of the @c SWALLOW. After being set to this part, the 
9749     * object size, position, visibility, clipping and other description 
9750     * properties will be totally controled by the description of the given part 
9751     * (inside the Edje theme file).
9752     *
9753     * One can use @c evas_object_size_hint_* functions on the child to have some
9754     * kind of control over its behavior, but the resulting behavior will still
9755     * depend heavily on the @c SWALLOW part description.
9756     *
9757     * The Edje theme also can change the part description, based on signals or
9758     * scripts running inside the theme. This change can also be animated. All of
9759     * this will affect the child object set as content accordingly. The object
9760     * size will be changed if the part size is changed, it will animate move if
9761     * the part is moving, and so on.
9762     *
9763     * The following picture demonstrates a Layout widget with a child object
9764     * added to its @c SWALLOW:
9765     *
9766     * @image html layout_swallow.png
9767     * @image latex layout_swallow.eps width=\textwidth
9768     *
9769     * @section secBox Box (BOX part)
9770     *
9771     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9772     * allows one to add objects to the box and have them distributed along its
9773     * area, accordingly to the specified @a layout property (now by @a layout we
9774     * mean the chosen layouting design of the Box, not the Layout widget
9775     * itself).
9776     *
9777     * A similar effect for having a box with its position, size and other things
9778     * controled by the Layout theme would be to create an Elementary @ref Box
9779     * widget and add it as a Content in the @c SWALLOW part.
9780     *
9781     * The main difference of using the Layout Box is that its behavior, the box
9782     * properties like layouting format, padding, align, etc. will be all
9783     * controled by the theme. This means, for example, that a signal could be
9784     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9785     * handled the signal by changing the box padding, or align, or both. Using
9786     * the Elementary @ref Box widget is not necessarily harder or easier, it
9787     * just depends on the circunstances and requirements.
9788     *
9789     * The Layout Box can be used through the @c elm_layout_box_* set of
9790     * functions.
9791     *
9792     * The following picture demonstrates a Layout widget with many child objects
9793     * added to its @c BOX part:
9794     *
9795     * @image html layout_box.png
9796     * @image latex layout_box.eps width=\textwidth
9797     *
9798     * @section secTable Table (TABLE part)
9799     *
9800     * Just like the @ref secBox, the Layout Table is very similar to the
9801     * Elementary @ref Table widget. It allows one to add objects to the Table
9802     * specifying the row and column where the object should be added, and any
9803     * column or row span if necessary.
9804     *
9805     * Again, we could have this design by adding a @ref Table widget to the @c
9806     * SWALLOW part using elm_object_content_part_set(). The same difference happens
9807     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9808     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9809     *
9810     * The Layout Table can be used through the @c elm_layout_table_* set of
9811     * functions.
9812     *
9813     * The following picture demonstrates a Layout widget with many child objects
9814     * added to its @c TABLE part:
9815     *
9816     * @image html layout_table.png
9817     * @image latex layout_table.eps width=\textwidth
9818     *
9819     * @section secPredef Predefined Layouts
9820     *
9821     * Another interesting thing about the Layout widget is that it offers some
9822     * predefined themes that come with the default Elementary theme. These
9823     * themes can be set by the call elm_layout_theme_set(), and provide some
9824     * basic functionality depending on the theme used.
9825     *
9826     * Most of them already send some signals, some already provide a toolbar or
9827     * back and next buttons.
9828     *
9829     * These are available predefined theme layouts. All of them have class = @c
9830     * layout, group = @c application, and style = one of the following options:
9831     *
9832     * @li @c toolbar-content - application with toolbar and main content area
9833     * @li @c toolbar-content-back - application with toolbar and main content
9834     * area with a back button and title area
9835     * @li @c toolbar-content-back-next - application with toolbar and main
9836     * content area with a back and next buttons and title area
9837     * @li @c content-back - application with a main content area with a back
9838     * button and title area
9839     * @li @c content-back-next - application with a main content area with a
9840     * back and next buttons and title area
9841     * @li @c toolbar-vbox - application with toolbar and main content area as a
9842     * vertical box
9843     * @li @c toolbar-table - application with toolbar and main content area as a
9844     * table
9845     *
9846     * @section secExamples Examples
9847     *
9848     * Some examples of the Layout widget can be found here:
9849     * @li @ref layout_example_01
9850     * @li @ref layout_example_02
9851     * @li @ref layout_example_03
9852     * @li @ref layout_example_edc
9853     *
9854     */
9855
9856    /**
9857     * Add a new layout to the parent
9858     *
9859     * @param parent The parent object
9860     * @return The new object or NULL if it cannot be created
9861     *
9862     * @see elm_layout_file_set()
9863     * @see elm_layout_theme_set()
9864     *
9865     * @ingroup Layout
9866     */
9867    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9868    /**
9869     * Set the file that will be used as layout
9870     *
9871     * @param obj The layout object
9872     * @param file The path to file (edj) that will be used as layout
9873     * @param group The group that the layout belongs in edje file
9874     *
9875     * @return (1 = success, 0 = error)
9876     *
9877     * @ingroup Layout
9878     */
9879    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9880    /**
9881     * Set the edje group from the elementary theme that will be used as layout
9882     *
9883     * @param obj The layout object
9884     * @param clas the clas of the group
9885     * @param group the group
9886     * @param style the style to used
9887     *
9888     * @return (1 = success, 0 = error)
9889     *
9890     * @ingroup Layout
9891     */
9892    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9893    /**
9894     * Set the layout content.
9895     *
9896     * @param obj The layout object
9897     * @param swallow The swallow part name in the edje file
9898     * @param content The child that will be added in this layout object
9899     *
9900     * Once the content object is set, a previously set one will be deleted.
9901     * If you want to keep that old content object, use the
9902     * elm_object_content_part_unset() function.
9903     *
9904     * @note In an Edje theme, the part used as a content container is called @c
9905     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9906     * expected to be a part name just like the second parameter of
9907     * elm_layout_box_append().
9908     *
9909     * @see elm_layout_box_append()
9910     * @see elm_object_content_part_get()
9911     * @see elm_object_content_part_unset()
9912     * @see @ref secBox
9913     *
9914     * @ingroup Layout
9915     */
9916    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9917    /**
9918     * Get the child object in the given content part.
9919     *
9920     * @param obj The layout object
9921     * @param swallow The SWALLOW part to get its content
9922     *
9923     * @return The swallowed object or NULL if none or an error occurred
9924     *
9925     * @see elm_object_content_part_set()
9926     *
9927     * @ingroup Layout
9928     */
9929    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9930    /**
9931     * Unset the layout content.
9932     *
9933     * @param obj The layout object
9934     * @param swallow The swallow part name in the edje file
9935     * @return The content that was being used
9936     *
9937     * Unparent and return the content object which was set for this part.
9938     *
9939     * @see elm_object_content_part_set()
9940     *
9941     * @ingroup Layout
9942     */
9943    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9944    /**
9945     * Set the text of the given part
9946     *
9947     * @param obj The layout object
9948     * @param part The TEXT part where to set the text
9949     * @param text The text to set
9950     *
9951     * @ingroup Layout
9952     * @deprecated use elm_object_text_* instead.
9953     */
9954    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9955    /**
9956     * Get the text set in the given part
9957     *
9958     * @param obj The layout object
9959     * @param part The TEXT part to retrieve the text off
9960     *
9961     * @return The text set in @p part
9962     *
9963     * @ingroup Layout
9964     * @deprecated use elm_object_text_* instead.
9965     */
9966    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9967    /**
9968     * Append child to layout box part.
9969     *
9970     * @param obj the layout object
9971     * @param part the box part to which the object will be appended.
9972     * @param child the child object to append to box.
9973     *
9974     * Once the object is appended, it will become child of the layout. Its
9975     * lifetime will be bound to the layout, whenever the layout dies the child
9976     * will be deleted automatically. One should use elm_layout_box_remove() to
9977     * make this layout forget about the object.
9978     *
9979     * @see elm_layout_box_prepend()
9980     * @see elm_layout_box_insert_before()
9981     * @see elm_layout_box_insert_at()
9982     * @see elm_layout_box_remove()
9983     *
9984     * @ingroup Layout
9985     */
9986    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9987    /**
9988     * Prepend child to layout box part.
9989     *
9990     * @param obj the layout object
9991     * @param part the box part to prepend.
9992     * @param child the child object to prepend to box.
9993     *
9994     * Once the object is prepended, it will become child of the layout. Its
9995     * lifetime will be bound to the layout, whenever the layout dies the child
9996     * will be deleted automatically. One should use elm_layout_box_remove() to
9997     * make this layout forget about the object.
9998     *
9999     * @see elm_layout_box_append()
10000     * @see elm_layout_box_insert_before()
10001     * @see elm_layout_box_insert_at()
10002     * @see elm_layout_box_remove()
10003     *
10004     * @ingroup Layout
10005     */
10006    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10007    /**
10008     * Insert child to layout box part before a reference object.
10009     *
10010     * @param obj the layout object
10011     * @param part the box part to insert.
10012     * @param child the child object to insert into box.
10013     * @param reference another reference object to insert before in box.
10014     *
10015     * Once the object is inserted, it will become child of the layout. Its
10016     * lifetime will be bound to the layout, whenever the layout dies the child
10017     * will be deleted automatically. One should use elm_layout_box_remove() to
10018     * make this layout forget about the object.
10019     *
10020     * @see elm_layout_box_append()
10021     * @see elm_layout_box_prepend()
10022     * @see elm_layout_box_insert_before()
10023     * @see elm_layout_box_remove()
10024     *
10025     * @ingroup Layout
10026     */
10027    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10028    /**
10029     * Insert child to layout box part at a given position.
10030     *
10031     * @param obj the layout object
10032     * @param part the box part to insert.
10033     * @param child the child object to insert into box.
10034     * @param pos the numeric position >=0 to insert the child.
10035     *
10036     * Once the object is inserted, it will become child of the layout. Its
10037     * lifetime will be bound to the layout, whenever the layout dies the child
10038     * will be deleted automatically. One should use elm_layout_box_remove() to
10039     * make this layout forget about the object.
10040     *
10041     * @see elm_layout_box_append()
10042     * @see elm_layout_box_prepend()
10043     * @see elm_layout_box_insert_before()
10044     * @see elm_layout_box_remove()
10045     *
10046     * @ingroup Layout
10047     */
10048    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10049    /**
10050     * Remove a child of the given part box.
10051     *
10052     * @param obj The layout object
10053     * @param part The box part name to remove child.
10054     * @param child The object to remove from box.
10055     * @return The object that was being used, or NULL if not found.
10056     *
10057     * The object will be removed from the box part and its lifetime will
10058     * not be handled by the layout anymore. This is equivalent to
10059     * elm_object_content_part_unset() for box.
10060     *
10061     * @see elm_layout_box_append()
10062     * @see elm_layout_box_remove_all()
10063     *
10064     * @ingroup Layout
10065     */
10066    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10067    /**
10068     * Remove all child of the given part box.
10069     *
10070     * @param obj The layout object
10071     * @param part The box part name to remove child.
10072     * @param clear If EINA_TRUE, then all objects will be deleted as
10073     *        well, otherwise they will just be removed and will be
10074     *        dangling on the canvas.
10075     *
10076     * The objects will be removed from the box part and their lifetime will
10077     * not be handled by the layout anymore. This is equivalent to
10078     * elm_layout_box_remove() for all box children.
10079     *
10080     * @see elm_layout_box_append()
10081     * @see elm_layout_box_remove()
10082     *
10083     * @ingroup Layout
10084     */
10085    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10086    /**
10087     * Insert child to layout table part.
10088     *
10089     * @param obj the layout object
10090     * @param part the box part to pack child.
10091     * @param child_obj the child object to pack into table.
10092     * @param col the column to which the child should be added. (>= 0)
10093     * @param row the row to which the child should be added. (>= 0)
10094     * @param colspan how many columns should be used to store this object. (>=
10095     *        1)
10096     * @param rowspan how many rows should be used to store this object. (>= 1)
10097     *
10098     * Once the object is inserted, it will become child of the table. Its
10099     * lifetime will be bound to the layout, and whenever the layout dies the
10100     * child will be deleted automatically. One should use
10101     * elm_layout_table_remove() to make this layout forget about the object.
10102     *
10103     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10104     * more space than a single cell. For instance, the following code:
10105     * @code
10106     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10107     * @endcode
10108     *
10109     * Would result in an object being added like the following picture:
10110     *
10111     * @image html layout_colspan.png
10112     * @image latex layout_colspan.eps width=\textwidth
10113     *
10114     * @see elm_layout_table_unpack()
10115     * @see elm_layout_table_clear()
10116     *
10117     * @ingroup Layout
10118     */
10119    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);
10120    /**
10121     * Unpack (remove) a child of the given part table.
10122     *
10123     * @param obj The layout object
10124     * @param part The table part name to remove child.
10125     * @param child_obj The object to remove from table.
10126     * @return The object that was being used, or NULL if not found.
10127     *
10128     * The object will be unpacked from the table part and its lifetime
10129     * will not be handled by the layout anymore. This is equivalent to
10130     * elm_object_content_part_unset() for table.
10131     *
10132     * @see elm_layout_table_pack()
10133     * @see elm_layout_table_clear()
10134     *
10135     * @ingroup Layout
10136     */
10137    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10138    /**
10139     * Remove all child of the given part table.
10140     *
10141     * @param obj The layout object
10142     * @param part The table part name to remove child.
10143     * @param clear If EINA_TRUE, then all objects will be deleted as
10144     *        well, otherwise they will just be removed and will be
10145     *        dangling on the canvas.
10146     *
10147     * The objects will be removed from the table part and their lifetime will
10148     * not be handled by the layout anymore. This is equivalent to
10149     * elm_layout_table_unpack() for all table children.
10150     *
10151     * @see elm_layout_table_pack()
10152     * @see elm_layout_table_unpack()
10153     *
10154     * @ingroup Layout
10155     */
10156    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10157    /**
10158     * Get the edje layout
10159     *
10160     * @param obj The layout object
10161     *
10162     * @return A Evas_Object with the edje layout settings loaded
10163     * with function elm_layout_file_set
10164     *
10165     * This returns the edje object. It is not expected to be used to then
10166     * swallow objects via edje_object_part_swallow() for example. Use
10167     * elm_object_content_part_set() instead so child object handling and sizing is
10168     * done properly.
10169     *
10170     * @note This function should only be used if you really need to call some
10171     * low level Edje function on this edje object. All the common stuff (setting
10172     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10173     * with proper elementary functions.
10174     *
10175     * @see elm_object_signal_callback_add()
10176     * @see elm_object_signal_emit()
10177     * @see elm_object_text_part_set()
10178     * @see elm_object_content_part_set()
10179     * @see elm_layout_box_append()
10180     * @see elm_layout_table_pack()
10181     * @see elm_layout_data_get()
10182     *
10183     * @ingroup Layout
10184     */
10185    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10186    /**
10187     * Get the edje data from the given layout
10188     *
10189     * @param obj The layout object
10190     * @param key The data key
10191     *
10192     * @return The edje data string
10193     *
10194     * This function fetches data specified inside the edje theme of this layout.
10195     * This function return NULL if data is not found.
10196     *
10197     * In EDC this comes from a data block within the group block that @p
10198     * obj was loaded from. E.g.
10199     *
10200     * @code
10201     * collections {
10202     *   group {
10203     *     name: "a_group";
10204     *     data {
10205     *       item: "key1" "value1";
10206     *       item: "key2" "value2";
10207     *     }
10208     *   }
10209     * }
10210     * @endcode
10211     *
10212     * @ingroup Layout
10213     */
10214    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10215    /**
10216     * Eval sizing
10217     *
10218     * @param obj The layout object
10219     *
10220     * Manually forces a sizing re-evaluation. This is useful when the minimum
10221     * size required by the edje theme of this layout has changed. The change on
10222     * the minimum size required by the edje theme is not immediately reported to
10223     * the elementary layout, so one needs to call this function in order to tell
10224     * the widget (layout) that it needs to reevaluate its own size.
10225     *
10226     * The minimum size of the theme is calculated based on minimum size of
10227     * parts, the size of elements inside containers like box and table, etc. All
10228     * of this can change due to state changes, and that's when this function
10229     * should be called.
10230     *
10231     * Also note that a standard signal of "size,eval" "elm" emitted from the
10232     * edje object will cause this to happen too.
10233     *
10234     * @ingroup Layout
10235     */
10236    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10237
10238    /**
10239     * Sets a specific cursor for an edje part.
10240     *
10241     * @param obj The layout object.
10242     * @param part_name a part from loaded edje group.
10243     * @param cursor cursor name to use, see Elementary_Cursor.h
10244     *
10245     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10246     *         part not exists or it has "mouse_events: 0".
10247     *
10248     * @ingroup Layout
10249     */
10250    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10251
10252    /**
10253     * Get the cursor to be shown when mouse is over an edje part
10254     *
10255     * @param obj The layout object.
10256     * @param part_name a part from loaded edje group.
10257     * @return the cursor name.
10258     *
10259     * @ingroup Layout
10260     */
10261    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10262
10263    /**
10264     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10265     *
10266     * @param obj The layout object.
10267     * @param part_name a part from loaded edje group, that had a cursor set
10268     *        with elm_layout_part_cursor_set().
10269     *
10270     * @ingroup Layout
10271     */
10272    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10273
10274    /**
10275     * Sets a specific cursor style for an edje part.
10276     *
10277     * @param obj The layout object.
10278     * @param part_name a part from loaded edje group.
10279     * @param style the theme style to use (default, transparent, ...)
10280     *
10281     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10282     *         part not exists or it did not had a cursor set.
10283     *
10284     * @ingroup Layout
10285     */
10286    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10287
10288    /**
10289     * Gets a specific cursor style for an edje part.
10290     *
10291     * @param obj The layout object.
10292     * @param part_name a part from loaded edje group.
10293     *
10294     * @return the theme style in use, defaults to "default". If the
10295     *         object does not have a cursor set, then NULL is returned.
10296     *
10297     * @ingroup Layout
10298     */
10299    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10300
10301    /**
10302     * Sets if the cursor set should be searched on the theme or should use
10303     * the provided by the engine, only.
10304     *
10305     * @note before you set if should look on theme you should define a
10306     * cursor with elm_layout_part_cursor_set(). By default it will only
10307     * look for cursors provided by the engine.
10308     *
10309     * @param obj The layout object.
10310     * @param part_name a part from loaded edje group.
10311     * @param engine_only if cursors should be just provided by the engine
10312     *        or should also search on widget's theme as well
10313     *
10314     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10315     *         part not exists or it did not had a cursor set.
10316     *
10317     * @ingroup Layout
10318     */
10319    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);
10320
10321    /**
10322     * Gets a specific cursor engine_only for an edje part.
10323     *
10324     * @param obj The layout object.
10325     * @param part_name a part from loaded edje group.
10326     *
10327     * @return whenever the cursor is just provided by engine or also from theme.
10328     *
10329     * @ingroup Layout
10330     */
10331    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10332
10333 /**
10334  * @def elm_layout_icon_set
10335  * Convienience macro to set the icon object in a layout that follows the
10336  * Elementary naming convention for its parts.
10337  *
10338  * @ingroup Layout
10339  */
10340 #define elm_layout_icon_set(_ly, _obj) \
10341   do { \
10342     const char *sig; \
10343     elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10344     if ((_obj)) sig = "elm,state,icon,visible"; \
10345     else sig = "elm,state,icon,hidden"; \
10346     elm_object_signal_emit((_ly), sig, "elm"); \
10347   } while (0)
10348
10349 /**
10350  * @def elm_layout_icon_get
10351  * Convienience macro to get the icon object from a layout that follows the
10352  * Elementary naming convention for its parts.
10353  *
10354  * @ingroup Layout
10355  */
10356 #define elm_layout_icon_get(_ly) \
10357   elm_object_content_part_get((_ly), "elm.swallow.icon")
10358
10359 /**
10360  * @def elm_layout_end_set
10361  * Convienience macro to set the end object in a layout that follows the
10362  * Elementary naming convention for its parts.
10363  *
10364  * @ingroup Layout
10365  */
10366 #define elm_layout_end_set(_ly, _obj) \
10367   do { \
10368     const char *sig; \
10369     elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10370     if ((_obj)) sig = "elm,state,end,visible"; \
10371     else sig = "elm,state,end,hidden"; \
10372     elm_object_signal_emit((_ly), sig, "elm"); \
10373   } while (0)
10374
10375 /**
10376  * @def elm_layout_end_get
10377  * Convienience macro to get the end object in a layout that follows the
10378  * Elementary naming convention for its parts.
10379  *
10380  * @ingroup Layout
10381  */
10382 #define elm_layout_end_get(_ly) \
10383   elm_object_content_part_get((_ly), "elm.swallow.end")
10384
10385 /**
10386  * @def elm_layout_label_set
10387  * Convienience macro to set the label in a layout that follows the
10388  * Elementary naming convention for its parts.
10389  *
10390  * @ingroup Layout
10391  * @deprecated use elm_object_text_* instead.
10392  */
10393 #define elm_layout_label_set(_ly, _txt) \
10394   elm_layout_text_set((_ly), "elm.text", (_txt))
10395
10396 /**
10397  * @def elm_layout_label_get
10398  * Convienience macro to get the label in a layout that follows the
10399  * Elementary naming convention for its parts.
10400  *
10401  * @ingroup Layout
10402  * @deprecated use elm_object_text_* instead.
10403  */
10404 #define elm_layout_label_get(_ly) \
10405   elm_layout_text_get((_ly), "elm.text")
10406
10407    /* smart callbacks called:
10408     * "theme,changed" - when elm theme is changed.
10409     */
10410
10411    /**
10412     * @defgroup Notify Notify
10413     *
10414     * @image html img/widget/notify/preview-00.png
10415     * @image latex img/widget/notify/preview-00.eps
10416     *
10417     * Display a container in a particular region of the parent(top, bottom,
10418     * etc.  A timeout can be set to automatically hide the notify. This is so
10419     * that, after an evas_object_show() on a notify object, if a timeout was set
10420     * on it, it will @b automatically get hidden after that time.
10421     *
10422     * Signals that you can add callbacks for are:
10423     * @li "timeout" - when timeout happens on notify and it's hidden
10424     * @li "block,clicked" - when a click outside of the notify happens
10425     *
10426     * Default contents parts of the notify widget that you can use for are:
10427     * @li "elm.swallow.content" - A content of the notify
10428     *
10429     * @ref tutorial_notify show usage of the API.
10430     *
10431     * @{
10432     */
10433    /**
10434     * @brief Possible orient values for notify.
10435     *
10436     * This values should be used in conjunction to elm_notify_orient_set() to
10437     * set the position in which the notify should appear(relative to its parent)
10438     * and in conjunction with elm_notify_orient_get() to know where the notify
10439     * is appearing.
10440     */
10441    typedef enum _Elm_Notify_Orient
10442      {
10443         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10444         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10445         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10446         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10447         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10448         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10449         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10450         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10451         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10452         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10453      } Elm_Notify_Orient;
10454    /**
10455     * @brief Add a new notify to the parent
10456     *
10457     * @param parent The parent object
10458     * @return The new object or NULL if it cannot be created
10459     */
10460    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10461    /**
10462     * @brief Set the content of the notify widget
10463     *
10464     * @param obj The notify object
10465     * @param content The content will be filled in this notify object
10466     *
10467     * Once the content object is set, a previously set one will be deleted. If
10468     * you want to keep that old content object, use the
10469     * elm_notify_content_unset() function.
10470     */
10471    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10472    /**
10473     * @brief Unset the content of the notify widget
10474     *
10475     * @param obj The notify object
10476     * @return The content that was being used
10477     *
10478     * Unparent and return the content object which was set for this widget
10479     *
10480     * @see elm_notify_content_set()
10481     */
10482    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10483    /**
10484     * @brief Return the content of the notify widget
10485     *
10486     * @param obj The notify object
10487     * @return The content that is being used
10488     *
10489     * @see elm_notify_content_set()
10490     */
10491    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10492    /**
10493     * @brief Set the notify parent
10494     *
10495     * @param obj The notify object
10496     * @param content The new parent
10497     *
10498     * Once the parent object is set, a previously set one will be disconnected
10499     * and replaced.
10500     */
10501    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10502    /**
10503     * @brief Get the notify parent
10504     *
10505     * @param obj The notify object
10506     * @return The parent
10507     *
10508     * @see elm_notify_parent_set()
10509     */
10510    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10511    /**
10512     * @brief Set the orientation
10513     *
10514     * @param obj The notify object
10515     * @param orient The new orientation
10516     *
10517     * Sets the position in which the notify will appear in its parent.
10518     *
10519     * @see @ref Elm_Notify_Orient for possible values.
10520     */
10521    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10522    /**
10523     * @brief Return the orientation
10524     * @param obj The notify object
10525     * @return The orientation of the notification
10526     *
10527     * @see elm_notify_orient_set()
10528     * @see Elm_Notify_Orient
10529     */
10530    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10531    /**
10532     * @brief Set the time interval after which the notify window is going to be
10533     * hidden.
10534     *
10535     * @param obj The notify object
10536     * @param time The timeout in seconds
10537     *
10538     * This function sets a timeout and starts the timer controlling when the
10539     * notify is hidden. Since calling evas_object_show() on a notify restarts
10540     * the timer controlling when the notify is hidden, setting this before the
10541     * notify is shown will in effect mean starting the timer when the notify is
10542     * shown.
10543     *
10544     * @note Set a value <= 0.0 to disable a running timer.
10545     *
10546     * @note If the value > 0.0 and the notify is previously visible, the
10547     * timer will be started with this value, canceling any running timer.
10548     */
10549    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10550    /**
10551     * @brief Return the timeout value (in seconds)
10552     * @param obj the notify object
10553     *
10554     * @see elm_notify_timeout_set()
10555     */
10556    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10557    /**
10558     * @brief Sets whether events should be passed to by a click outside
10559     * its area.
10560     *
10561     * @param obj The notify object
10562     * @param repeats EINA_TRUE Events are repeats, else no
10563     *
10564     * When true if the user clicks outside the window the events will be caught
10565     * by the others widgets, else the events are blocked.
10566     *
10567     * @note The default value is EINA_TRUE.
10568     */
10569    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10570    /**
10571     * @brief Return true if events are repeat below the notify object
10572     * @param obj the notify object
10573     *
10574     * @see elm_notify_repeat_events_set()
10575     */
10576    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10577    /**
10578     * @}
10579     */
10580
10581    /**
10582     * @defgroup Hover Hover
10583     *
10584     * @image html img/widget/hover/preview-00.png
10585     * @image latex img/widget/hover/preview-00.eps
10586     *
10587     * A Hover object will hover over its @p parent object at the @p target
10588     * location. Anything in the background will be given a darker coloring to
10589     * indicate that the hover object is on top (at the default theme). When the
10590     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10591     * clicked that @b doesn't cause the hover to be dismissed.
10592     *
10593     * A Hover object has two parents. One parent that owns it during creation
10594     * and the other parent being the one over which the hover object spans.
10595     *
10596     *
10597     * @note The hover object will take up the entire space of @p target
10598     * object.
10599     *
10600     * Elementary has the following styles for the hover widget:
10601     * @li default
10602     * @li popout
10603     * @li menu
10604     * @li hoversel_vertical
10605     *
10606     * The following are the available position for content:
10607     * @li left
10608     * @li top-left
10609     * @li top
10610     * @li top-right
10611     * @li right
10612     * @li bottom-right
10613     * @li bottom
10614     * @li bottom-left
10615     * @li middle
10616     * @li smart
10617     *
10618     * Signals that you can add callbacks for are:
10619     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10620     * @li "smart,changed" - a content object placed under the "smart"
10621     *                   policy was replaced to a new slot direction.
10622     *
10623     * See @ref tutorial_hover for more information.
10624     *
10625     * @{
10626     */
10627    typedef enum _Elm_Hover_Axis
10628      {
10629         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10630         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10631         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10632         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10633      } Elm_Hover_Axis;
10634    /**
10635     * @brief Adds a hover object to @p parent
10636     *
10637     * @param parent The parent object
10638     * @return The hover object or NULL if one could not be created
10639     */
10640    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10641    /**
10642     * @brief Sets the target object for the hover.
10643     *
10644     * @param obj The hover object
10645     * @param target The object to center the hover onto. The hover
10646     *
10647     * This function will cause the hover to be centered on the target object.
10648     */
10649    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10650    /**
10651     * @brief Gets the target object for the hover.
10652     *
10653     * @param obj The hover object
10654     * @param parent The object to locate the hover over.
10655     *
10656     * @see elm_hover_target_set()
10657     */
10658    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10659    /**
10660     * @brief Sets the parent object for the hover.
10661     *
10662     * @param obj The hover object
10663     * @param parent The object to locate the hover over.
10664     *
10665     * This function will cause the hover to take up the entire space that the
10666     * parent object fills.
10667     */
10668    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10669    /**
10670     * @brief Gets the parent object for the hover.
10671     *
10672     * @param obj The hover object
10673     * @return The parent object to locate the hover over.
10674     *
10675     * @see elm_hover_parent_set()
10676     */
10677    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10678    /**
10679     * @brief Sets the content of the hover object and the direction in which it
10680     * will pop out.
10681     *
10682     * @param obj The hover object
10683     * @param swallow The direction that the object will be displayed
10684     * at. Accepted values are "left", "top-left", "top", "top-right",
10685     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10686     * "smart".
10687     * @param content The content to place at @p swallow
10688     *
10689     * Once the content object is set for a given direction, a previously
10690     * set one (on the same direction) will be deleted. If you want to
10691     * keep that old content object, use the elm_hover_content_unset()
10692     * function.
10693     *
10694     * All directions may have contents at the same time, except for
10695     * "smart". This is a special placement hint and its use case
10696     * independs of the calculations coming from
10697     * elm_hover_best_content_location_get(). Its use is for cases when
10698     * one desires only one hover content, but with a dinamic special
10699     * placement within the hover area. The content's geometry, whenever
10700     * it changes, will be used to decide on a best location not
10701     * extrapolating the hover's parent object view to show it in (still
10702     * being the hover's target determinant of its medium part -- move and
10703     * resize it to simulate finger sizes, for example). If one of the
10704     * directions other than "smart" are used, a previously content set
10705     * using it will be deleted, and vice-versa.
10706     */
10707    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10708    /**
10709     * @brief Get the content of the hover object, in a given direction.
10710     *
10711     * Return the content object which was set for this widget in the
10712     * @p swallow direction.
10713     *
10714     * @param obj The hover object
10715     * @param swallow The direction that the object was display at.
10716     * @return The content that was being used
10717     *
10718     * @see elm_hover_content_set()
10719     */
10720    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10721    /**
10722     * @brief Unset the content of the hover object, in a given direction.
10723     *
10724     * Unparent and return the content object set at @p swallow direction.
10725     *
10726     * @param obj The hover object
10727     * @param swallow The direction that the object was display at.
10728     * @return The content that was being used.
10729     *
10730     * @see elm_hover_content_set()
10731     */
10732    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10733    /**
10734     * @brief Returns the best swallow location for content in the hover.
10735     *
10736     * @param obj The hover object
10737     * @param pref_axis The preferred orientation axis for the hover object to use
10738     * @return The edje location to place content into the hover or @c
10739     *         NULL, on errors.
10740     *
10741     * Best is defined here as the location at which there is the most available
10742     * space.
10743     *
10744     * @p pref_axis may be one of
10745     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10746     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10747     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10748     * - @c ELM_HOVER_AXIS_BOTH -- both
10749     *
10750     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10751     * nescessarily be along the horizontal axis("left" or "right"). If
10752     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10753     * be along the vertical axis("top" or "bottom"). Chossing
10754     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10755     * returned position may be in either axis.
10756     *
10757     * @see elm_hover_content_set()
10758     */
10759    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10760    /**
10761     * @}
10762     */
10763
10764    /* entry */
10765    /**
10766     * @defgroup Entry Entry
10767     *
10768     * @image html img/widget/entry/preview-00.png
10769     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10770     * @image html img/widget/entry/preview-01.png
10771     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10772     * @image html img/widget/entry/preview-02.png
10773     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10774     * @image html img/widget/entry/preview-03.png
10775     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10776     *
10777     * An entry is a convenience widget which shows a box that the user can
10778     * enter text into. Entries by default don't scroll, so they grow to
10779     * accomodate the entire text, resizing the parent window as needed. This
10780     * can be changed with the elm_entry_scrollable_set() function.
10781     *
10782     * They can also be single line or multi line (the default) and when set
10783     * to multi line mode they support text wrapping in any of the modes
10784     * indicated by #Elm_Wrap_Type.
10785     *
10786     * Other features include password mode, filtering of inserted text with
10787     * elm_entry_text_filter_append() and related functions, inline "items" and
10788     * formatted markup text.
10789     *
10790     * @section entry-markup Formatted text
10791     *
10792     * The markup tags supported by the Entry are defined by the theme, but
10793     * even when writing new themes or extensions it's a good idea to stick to
10794     * a sane default, to maintain coherency and avoid application breakages.
10795     * Currently defined by the default theme are the following tags:
10796     * @li \<br\>: Inserts a line break.
10797     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10798     * breaks.
10799     * @li \<tab\>: Inserts a tab.
10800     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10801     * enclosed text.
10802     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10803     * @li \<link\>...\</link\>: Underlines the enclosed text.
10804     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10805     *
10806     * @section entry-special Special markups
10807     *
10808     * Besides those used to format text, entries support two special markup
10809     * tags used to insert clickable portions of text or items inlined within
10810     * the text.
10811     *
10812     * @subsection entry-anchors Anchors
10813     *
10814     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10815     * \</a\> tags and an event will be generated when this text is clicked,
10816     * like this:
10817     *
10818     * @code
10819     * This text is outside <a href=anc-01>but this one is an anchor</a>
10820     * @endcode
10821     *
10822     * The @c href attribute in the opening tag gives the name that will be
10823     * used to identify the anchor and it can be any valid utf8 string.
10824     *
10825     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10826     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10827     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10828     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10829     * an anchor.
10830     *
10831     * @subsection entry-items Items
10832     *
10833     * Inlined in the text, any other @c Evas_Object can be inserted by using
10834     * \<item\> tags this way:
10835     *
10836     * @code
10837     * <item size=16x16 vsize=full href=emoticon/haha></item>
10838     * @endcode
10839     *
10840     * Just like with anchors, the @c href identifies each item, but these need,
10841     * in addition, to indicate their size, which is done using any one of
10842     * @c size, @c absize or @c relsize attributes. These attributes take their
10843     * value in the WxH format, where W is the width and H the height of the
10844     * item.
10845     *
10846     * @li absize: Absolute pixel size for the item. Whatever value is set will
10847     * be the item's size regardless of any scale value the object may have
10848     * been set to. The final line height will be adjusted to fit larger items.
10849     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10850     * for the object.
10851     * @li relsize: Size is adjusted for the item to fit within the current
10852     * line height.
10853     *
10854     * Besides their size, items are specificed a @c vsize value that affects
10855     * how their final size and position are calculated. The possible values
10856     * are:
10857     * @li ascent: Item will be placed within the line's baseline and its
10858     * ascent. That is, the height between the line where all characters are
10859     * positioned and the highest point in the line. For @c size and @c absize
10860     * items, the descent value will be added to the total line height to make
10861     * them fit. @c relsize items will be adjusted to fit within this space.
10862     * @li full: Items will be placed between the descent and ascent, or the
10863     * lowest point in the line and its highest.
10864     *
10865     * The next image shows different configurations of items and how they
10866     * are the previously mentioned options affect their sizes. In all cases,
10867     * the green line indicates the ascent, blue for the baseline and red for
10868     * the descent.
10869     *
10870     * @image html entry_item.png
10871     * @image latex entry_item.eps width=\textwidth
10872     *
10873     * And another one to show how size differs from absize. In the first one,
10874     * the scale value is set to 1.0, while the second one is using one of 2.0.
10875     *
10876     * @image html entry_item_scale.png
10877     * @image latex entry_item_scale.eps width=\textwidth
10878     *
10879     * After the size for an item is calculated, the entry will request an
10880     * object to place in its space. For this, the functions set with
10881     * elm_entry_item_provider_append() and related functions will be called
10882     * in order until one of them returns a @c non-NULL value. If no providers
10883     * are available, or all of them return @c NULL, then the entry falls back
10884     * to one of the internal defaults, provided the name matches with one of
10885     * them.
10886     *
10887     * All of the following are currently supported:
10888     *
10889     * - emoticon/angry
10890     * - emoticon/angry-shout
10891     * - emoticon/crazy-laugh
10892     * - emoticon/evil-laugh
10893     * - emoticon/evil
10894     * - emoticon/goggle-smile
10895     * - emoticon/grumpy
10896     * - emoticon/grumpy-smile
10897     * - emoticon/guilty
10898     * - emoticon/guilty-smile
10899     * - emoticon/haha
10900     * - emoticon/half-smile
10901     * - emoticon/happy-panting
10902     * - emoticon/happy
10903     * - emoticon/indifferent
10904     * - emoticon/kiss
10905     * - emoticon/knowing-grin
10906     * - emoticon/laugh
10907     * - emoticon/little-bit-sorry
10908     * - emoticon/love-lots
10909     * - emoticon/love
10910     * - emoticon/minimal-smile
10911     * - emoticon/not-happy
10912     * - emoticon/not-impressed
10913     * - emoticon/omg
10914     * - emoticon/opensmile
10915     * - emoticon/smile
10916     * - emoticon/sorry
10917     * - emoticon/squint-laugh
10918     * - emoticon/surprised
10919     * - emoticon/suspicious
10920     * - emoticon/tongue-dangling
10921     * - emoticon/tongue-poke
10922     * - emoticon/uh
10923     * - emoticon/unhappy
10924     * - emoticon/very-sorry
10925     * - emoticon/what
10926     * - emoticon/wink
10927     * - emoticon/worried
10928     * - emoticon/wtf
10929     *
10930     * Alternatively, an item may reference an image by its path, using
10931     * the URI form @c file:///path/to/an/image.png and the entry will then
10932     * use that image for the item.
10933     *
10934     * @section entry-files Loading and saving files
10935     *
10936     * Entries have convinience functions to load text from a file and save
10937     * changes back to it after a short delay. The automatic saving is enabled
10938     * by default, but can be disabled with elm_entry_autosave_set() and files
10939     * can be loaded directly as plain text or have any markup in them
10940     * recognized. See elm_entry_file_set() for more details.
10941     *
10942     * @section entry-signals Emitted signals
10943     *
10944     * This widget emits the following signals:
10945     *
10946     * @li "changed": The text within the entry was changed.
10947     * @li "changed,user": The text within the entry was changed because of user interaction.
10948     * @li "activated": The enter key was pressed on a single line entry.
10949     * @li "press": A mouse button has been pressed on the entry.
10950     * @li "longpressed": A mouse button has been pressed and held for a couple
10951     * seconds.
10952     * @li "clicked": The entry has been clicked (mouse press and release).
10953     * @li "clicked,double": The entry has been double clicked.
10954     * @li "clicked,triple": The entry has been triple clicked.
10955     * @li "focused": The entry has received focus.
10956     * @li "unfocused": The entry has lost focus.
10957     * @li "selection,paste": A paste of the clipboard contents was requested.
10958     * @li "selection,copy": A copy of the selected text into the clipboard was
10959     * requested.
10960     * @li "selection,cut": A cut of the selected text into the clipboard was
10961     * requested.
10962     * @li "selection,start": A selection has begun and no previous selection
10963     * existed.
10964     * @li "selection,changed": The current selection has changed.
10965     * @li "selection,cleared": The current selection has been cleared.
10966     * @li "cursor,changed": The cursor has changed position.
10967     * @li "anchor,clicked": An anchor has been clicked. The event_info
10968     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10969     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10970     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10971     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10972     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10973     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10974     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10975     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10976     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10977     * @li "preedit,changed": The preedit string has changed.
10978     * @li "language,changed": Program language changed.
10979     *
10980     * @section entry-examples
10981     *
10982     * An overview of the Entry API can be seen in @ref entry_example_01
10983     *
10984     * @{
10985     */
10986    /**
10987     * @typedef Elm_Entry_Anchor_Info
10988     *
10989     * The info sent in the callback for the "anchor,clicked" signals emitted
10990     * by entries.
10991     */
10992    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10993    /**
10994     * @struct _Elm_Entry_Anchor_Info
10995     *
10996     * The info sent in the callback for the "anchor,clicked" signals emitted
10997     * by entries.
10998     */
10999    struct _Elm_Entry_Anchor_Info
11000      {
11001         const char *name; /**< The name of the anchor, as stated in its href */
11002         int         button; /**< The mouse button used to click on it */
11003         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11004                     y, /**< Anchor geometry, relative to canvas */
11005                     w, /**< Anchor geometry, relative to canvas */
11006                     h; /**< Anchor geometry, relative to canvas */
11007      };
11008    /**
11009     * @typedef Elm_Entry_Filter_Cb
11010     * This callback type is used by entry filters to modify text.
11011     * @param data The data specified as the last param when adding the filter
11012     * @param entry The entry object
11013     * @param text A pointer to the location of the text being filtered. This data can be modified,
11014     * but any additional allocations must be managed by the user.
11015     * @see elm_entry_text_filter_append
11016     * @see elm_entry_text_filter_prepend
11017     */
11018    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11019
11020    /**
11021     * This adds an entry to @p parent object.
11022     *
11023     * By default, entries are:
11024     * @li not scrolled
11025     * @li multi-line
11026     * @li word wrapped
11027     * @li autosave is enabled
11028     *
11029     * @param parent The parent object
11030     * @return The new object or NULL if it cannot be created
11031     */
11032    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11033    /**
11034     * Sets the entry to single line mode.
11035     *
11036     * In single line mode, entries don't ever wrap when the text reaches the
11037     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11038     * key will generate an @c "activate" event instead of adding a new line.
11039     *
11040     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11041     * and pressing enter will break the text into a different line
11042     * without generating any events.
11043     *
11044     * @param obj The entry object
11045     * @param single_line If true, the text in the entry
11046     * will be on a single line.
11047     */
11048    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11049    /**
11050     * Gets whether the entry is set to be single line.
11051     *
11052     * @param obj The entry object
11053     * @return single_line If true, the text in the entry is set to display
11054     * on a single line.
11055     *
11056     * @see elm_entry_single_line_set()
11057     */
11058    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11059    /**
11060     * Sets the entry to password mode.
11061     *
11062     * In password mode, entries are implicitly single line and the display of
11063     * any text in them is replaced with asterisks (*).
11064     *
11065     * @param obj The entry object
11066     * @param password If true, password mode is enabled.
11067     */
11068    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11069    /**
11070     * Gets whether the entry is set to password mode.
11071     *
11072     * @param obj The entry object
11073     * @return If true, the entry is set to display all characters
11074     * as asterisks (*).
11075     *
11076     * @see elm_entry_password_set()
11077     */
11078    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11079    /**
11080     * This sets the text displayed within the entry to @p entry.
11081     *
11082     * @param obj The entry object
11083     * @param entry The text to be displayed
11084     *
11085     * @deprecated Use elm_object_text_set() instead.
11086     * @note Using this function bypasses text filters
11087     */
11088    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11089    /**
11090     * This returns the text currently shown in object @p entry.
11091     * See also elm_entry_entry_set().
11092     *
11093     * @param obj The entry object
11094     * @return The currently displayed text or NULL on failure
11095     *
11096     * @deprecated Use elm_object_text_get() instead.
11097     */
11098    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11099    /**
11100     * Appends @p entry to the text of the entry.
11101     *
11102     * Adds the text in @p entry to the end of any text already present in the
11103     * widget.
11104     *
11105     * The appended text is subject to any filters set for the widget.
11106     *
11107     * @param obj The entry object
11108     * @param entry The text to be displayed
11109     *
11110     * @see elm_entry_text_filter_append()
11111     */
11112    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11113    /**
11114     * Gets whether the entry is empty.
11115     *
11116     * Empty means no text at all. If there are any markup tags, like an item
11117     * tag for which no provider finds anything, and no text is displayed, this
11118     * function still returns EINA_FALSE.
11119     *
11120     * @param obj The entry object
11121     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11122     */
11123    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11124    /**
11125     * Gets any selected text within the entry.
11126     *
11127     * If there's any selected text in the entry, this function returns it as
11128     * a string in markup format. NULL is returned if no selection exists or
11129     * if an error occurred.
11130     *
11131     * The returned value points to an internal string and should not be freed
11132     * or modified in any way. If the @p entry object is deleted or its
11133     * contents are changed, the returned pointer should be considered invalid.
11134     *
11135     * @param obj The entry object
11136     * @return The selected text within the entry or NULL on failure
11137     */
11138    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11139    /**
11140     * Inserts the given text into the entry at the current cursor position.
11141     *
11142     * This inserts text at the cursor position as if it was typed
11143     * by the user (note that this also allows markup which a user
11144     * can't just "type" as it would be converted to escaped text, so this
11145     * call can be used to insert things like emoticon items or bold push/pop
11146     * tags, other font and color change tags etc.)
11147     *
11148     * If any selection exists, it will be replaced by the inserted text.
11149     *
11150     * The inserted text is subject to any filters set for the widget.
11151     *
11152     * @param obj The entry object
11153     * @param entry The text to insert
11154     *
11155     * @see elm_entry_text_filter_append()
11156     */
11157    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11158    /**
11159     * Set the line wrap type to use on multi-line entries.
11160     *
11161     * Sets the wrap type used by the entry to any of the specified in
11162     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11163     * line (without inserting a line break or paragraph separator) when it
11164     * reaches the far edge of the widget.
11165     *
11166     * Note that this only makes sense for multi-line entries. A widget set
11167     * to be single line will never wrap.
11168     *
11169     * @param obj The entry object
11170     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11171     */
11172    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type 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    /**
11847     * @}
11848     */
11849
11850    /* composite widgets - these basically put together basic widgets above
11851     * in convenient packages that do more than basic stuff */
11852
11853    /* anchorview */
11854    /**
11855     * @defgroup Anchorview Anchorview
11856     *
11857     * @image html img/widget/anchorview/preview-00.png
11858     * @image latex img/widget/anchorview/preview-00.eps
11859     *
11860     * Anchorview is for displaying text that contains markup with anchors
11861     * like <c>\<a href=1234\>something\</\></c> in it.
11862     *
11863     * Besides being styled differently, the anchorview widget provides the
11864     * necessary functionality so that clicking on these anchors brings up a
11865     * popup with user defined content such as "call", "add to contacts" or
11866     * "open web page". This popup is provided using the @ref Hover widget.
11867     *
11868     * This widget is very similar to @ref Anchorblock, so refer to that
11869     * widget for an example. The only difference Anchorview has is that the
11870     * widget is already provided with scrolling functionality, so if the
11871     * text set to it is too large to fit in the given space, it will scroll,
11872     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11873     * text can be displayed.
11874     *
11875     * This widget emits the following signals:
11876     * @li "anchor,clicked": will be called when an anchor is clicked. The
11877     * @p event_info parameter on the callback will be a pointer of type
11878     * ::Elm_Entry_Anchorview_Info.
11879     *
11880     * See @ref Anchorblock for an example on how to use both of them.
11881     *
11882     * @see Anchorblock
11883     * @see Entry
11884     * @see Hover
11885     *
11886     * @{
11887     */
11888    /**
11889     * @typedef Elm_Entry_Anchorview_Info
11890     *
11891     * The info sent in the callback for "anchor,clicked" signals emitted by
11892     * the Anchorview widget.
11893     */
11894    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11895    /**
11896     * @struct _Elm_Entry_Anchorview_Info
11897     *
11898     * The info sent in the callback for "anchor,clicked" signals emitted by
11899     * the Anchorview widget.
11900     */
11901    struct _Elm_Entry_Anchorview_Info
11902      {
11903         const char     *name; /**< Name of the anchor, as indicated in its href
11904                                    attribute */
11905         int             button; /**< The mouse button used to click on it */
11906         Evas_Object    *hover; /**< The hover object to use for the popup */
11907         struct {
11908              Evas_Coord    x, y, w, h;
11909         } anchor, /**< Geometry selection of text used as anchor */
11910           hover_parent; /**< Geometry of the object used as parent by the
11911                              hover */
11912         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11913                                              for content on the left side of
11914                                              the hover. Before calling the
11915                                              callback, the widget will make the
11916                                              necessary calculations to check
11917                                              which sides are fit to be set with
11918                                              content, based on the position the
11919                                              hover is activated and its distance
11920                                              to the edges of its parent object
11921                                              */
11922         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11923                                               the right side of the hover.
11924                                               See @ref hover_left */
11925         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11926                                             of the hover. See @ref hover_left */
11927         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11928                                                below the hover. See @ref
11929                                                hover_left */
11930      };
11931    /**
11932     * Add a new Anchorview object
11933     *
11934     * @param parent The parent object
11935     * @return The new object or NULL if it cannot be created
11936     */
11937    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11938    /**
11939     * Set the text to show in the anchorview
11940     *
11941     * Sets the text of the anchorview to @p text. This text can include markup
11942     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11943     * text that will be specially styled and react to click events, ended with
11944     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11945     * "anchor,clicked" signal that you can attach a callback to with
11946     * evas_object_smart_callback_add(). The name of the anchor given in the
11947     * event info struct will be the one set in the href attribute, in this
11948     * case, anchorname.
11949     *
11950     * Other markup can be used to style the text in different ways, but it's
11951     * up to the style defined in the theme which tags do what.
11952     * @deprecated use elm_object_text_set() instead.
11953     */
11954    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11955    /**
11956     * Get the markup text set for the anchorview
11957     *
11958     * Retrieves the text set on the anchorview, with markup tags included.
11959     *
11960     * @param obj The anchorview object
11961     * @return The markup text set or @c NULL if nothing was set or an error
11962     * occurred
11963     * @deprecated use elm_object_text_set() instead.
11964     */
11965    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11966    /**
11967     * Set the parent of the hover popup
11968     *
11969     * Sets the parent object to use by the hover created by the anchorview
11970     * when an anchor is clicked. See @ref Hover for more details on this.
11971     * If no parent is set, the same anchorview object will be used.
11972     *
11973     * @param obj The anchorview object
11974     * @param parent The object to use as parent for the hover
11975     */
11976    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11977    /**
11978     * Get the parent of the hover popup
11979     *
11980     * Get the object used as parent for the hover created by the anchorview
11981     * widget. See @ref Hover for more details on this.
11982     *
11983     * @param obj The anchorview object
11984     * @return The object used as parent for the hover, NULL if none is set.
11985     */
11986    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11987    /**
11988     * Set the style that the hover should use
11989     *
11990     * When creating the popup hover, anchorview will request that it's
11991     * themed according to @p style.
11992     *
11993     * @param obj The anchorview object
11994     * @param style The style to use for the underlying hover
11995     *
11996     * @see elm_object_style_set()
11997     */
11998    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11999    /**
12000     * Get the style that the hover should use
12001     *
12002     * Get the style the hover created by anchorview will use.
12003     *
12004     * @param obj The anchorview object
12005     * @return The style to use by the hover. NULL means the default is used.
12006     *
12007     * @see elm_object_style_set()
12008     */
12009    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12010    /**
12011     * Ends the hover popup in the anchorview
12012     *
12013     * When an anchor is clicked, the anchorview widget will create a hover
12014     * object to use as a popup with user provided content. This function
12015     * terminates this popup, returning the anchorview to its normal state.
12016     *
12017     * @param obj The anchorview object
12018     */
12019    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12020    /**
12021     * Set bouncing behaviour when the scrolled content reaches an edge
12022     *
12023     * Tell the internal scroller object whether it should bounce or not
12024     * when it reaches the respective edges for each axis.
12025     *
12026     * @param obj The anchorview object
12027     * @param h_bounce Whether to bounce or not in the horizontal axis
12028     * @param v_bounce Whether to bounce or not in the vertical axis
12029     *
12030     * @see elm_scroller_bounce_set()
12031     */
12032    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12033    /**
12034     * Get the set bouncing behaviour of the internal scroller
12035     *
12036     * Get whether the internal scroller should bounce when the edge of each
12037     * axis is reached scrolling.
12038     *
12039     * @param obj The anchorview object
12040     * @param h_bounce Pointer where to store the bounce state of the horizontal
12041     *                 axis
12042     * @param v_bounce Pointer where to store the bounce state of the vertical
12043     *                 axis
12044     *
12045     * @see elm_scroller_bounce_get()
12046     */
12047    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12048    /**
12049     * Appends a custom item provider to the given anchorview
12050     *
12051     * Appends the given function to the list of items providers. This list is
12052     * called, one function at a time, with the given @p data pointer, the
12053     * anchorview object and, in the @p item parameter, the item name as
12054     * referenced in its href string. Following functions in the list will be
12055     * called in order until one of them returns something different to NULL,
12056     * which should be an Evas_Object which will be used in place of the item
12057     * element.
12058     *
12059     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12060     * href=item/name\>\</item\>
12061     *
12062     * @param obj The anchorview object
12063     * @param func The function to add to the list of providers
12064     * @param data User data that will be passed to the callback function
12065     *
12066     * @see elm_entry_item_provider_append()
12067     */
12068    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);
12069    /**
12070     * Prepend a custom item provider to the given anchorview
12071     *
12072     * Like elm_anchorview_item_provider_append(), but it adds the function
12073     * @p func to the beginning of the list, instead of the end.
12074     *
12075     * @param obj The anchorview object
12076     * @param func The function to add to the list of providers
12077     * @param data User data that will be passed to the callback function
12078     */
12079    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);
12080    /**
12081     * Remove a custom item provider from the list of the given anchorview
12082     *
12083     * Removes the function and data pairing that matches @p func and @p data.
12084     * That is, unless the same function and same user data are given, the
12085     * function will not be removed from the list. This allows us to add the
12086     * same callback several times, with different @p data pointers and be
12087     * able to remove them later without conflicts.
12088     *
12089     * @param obj The anchorview object
12090     * @param func The function to remove from the list
12091     * @param data The data matching the function to remove from the list
12092     */
12093    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);
12094    /**
12095     * @}
12096     */
12097
12098    /* anchorblock */
12099    /**
12100     * @defgroup Anchorblock Anchorblock
12101     *
12102     * @image html img/widget/anchorblock/preview-00.png
12103     * @image latex img/widget/anchorblock/preview-00.eps
12104     *
12105     * Anchorblock is for displaying text that contains markup with anchors
12106     * like <c>\<a href=1234\>something\</\></c> in it.
12107     *
12108     * Besides being styled differently, the anchorblock widget provides the
12109     * necessary functionality so that clicking on these anchors brings up a
12110     * popup with user defined content such as "call", "add to contacts" or
12111     * "open web page". This popup is provided using the @ref Hover widget.
12112     *
12113     * This widget emits the following signals:
12114     * @li "anchor,clicked": will be called when an anchor is clicked. The
12115     * @p event_info parameter on the callback will be a pointer of type
12116     * ::Elm_Entry_Anchorblock_Info.
12117     *
12118     * @see Anchorview
12119     * @see Entry
12120     * @see Hover
12121     *
12122     * Since examples are usually better than plain words, we might as well
12123     * try @ref tutorial_anchorblock_example "one".
12124     */
12125    /**
12126     * @addtogroup Anchorblock
12127     * @{
12128     */
12129    /**
12130     * @typedef Elm_Entry_Anchorblock_Info
12131     *
12132     * The info sent in the callback for "anchor,clicked" signals emitted by
12133     * the Anchorblock widget.
12134     */
12135    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12136    /**
12137     * @struct _Elm_Entry_Anchorblock_Info
12138     *
12139     * The info sent in the callback for "anchor,clicked" signals emitted by
12140     * the Anchorblock widget.
12141     */
12142    struct _Elm_Entry_Anchorblock_Info
12143      {
12144         const char     *name; /**< Name of the anchor, as indicated in its href
12145                                    attribute */
12146         int             button; /**< The mouse button used to click on it */
12147         Evas_Object    *hover; /**< The hover object to use for the popup */
12148         struct {
12149              Evas_Coord    x, y, w, h;
12150         } anchor, /**< Geometry selection of text used as anchor */
12151           hover_parent; /**< Geometry of the object used as parent by the
12152                              hover */
12153         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12154                                              for content on the left side of
12155                                              the hover. Before calling the
12156                                              callback, the widget will make the
12157                                              necessary calculations to check
12158                                              which sides are fit to be set with
12159                                              content, based on the position the
12160                                              hover is activated and its distance
12161                                              to the edges of its parent object
12162                                              */
12163         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12164                                               the right side of the hover.
12165                                               See @ref hover_left */
12166         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12167                                             of the hover. See @ref hover_left */
12168         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12169                                                below the hover. See @ref
12170                                                hover_left */
12171      };
12172    /**
12173     * Add a new Anchorblock object
12174     *
12175     * @param parent The parent object
12176     * @return The new object or NULL if it cannot be created
12177     */
12178    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12179    /**
12180     * Set the text to show in the anchorblock
12181     *
12182     * Sets the text of the anchorblock to @p text. This text can include markup
12183     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12184     * of text that will be specially styled and react to click events, ended
12185     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12186     * "anchor,clicked" signal that you can attach a callback to with
12187     * evas_object_smart_callback_add(). The name of the anchor given in the
12188     * event info struct will be the one set in the href attribute, in this
12189     * case, anchorname.
12190     *
12191     * Other markup can be used to style the text in different ways, but it's
12192     * up to the style defined in the theme which tags do what.
12193     * @deprecated use elm_object_text_set() instead.
12194     */
12195    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12196    /**
12197     * Get the markup text set for the anchorblock
12198     *
12199     * Retrieves the text set on the anchorblock, with markup tags included.
12200     *
12201     * @param obj The anchorblock object
12202     * @return The markup text set or @c NULL if nothing was set or an error
12203     * occurred
12204     * @deprecated use elm_object_text_set() instead.
12205     */
12206    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12207    /**
12208     * Set the parent of the hover popup
12209     *
12210     * Sets the parent object to use by the hover created by the anchorblock
12211     * when an anchor is clicked. See @ref Hover for more details on this.
12212     *
12213     * @param obj The anchorblock object
12214     * @param parent The object to use as parent for the hover
12215     */
12216    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12217    /**
12218     * Get the parent of the hover popup
12219     *
12220     * Get the object used as parent for the hover created by the anchorblock
12221     * widget. See @ref Hover for more details on this.
12222     * If no parent is set, the same anchorblock object will be used.
12223     *
12224     * @param obj The anchorblock object
12225     * @return The object used as parent for the hover, NULL if none is set.
12226     */
12227    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12228    /**
12229     * Set the style that the hover should use
12230     *
12231     * When creating the popup hover, anchorblock will request that it's
12232     * themed according to @p style.
12233     *
12234     * @param obj The anchorblock object
12235     * @param style The style to use for the underlying hover
12236     *
12237     * @see elm_object_style_set()
12238     */
12239    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12240    /**
12241     * Get the style that the hover should use
12242     *
12243     * Get the style, the hover created by anchorblock will use.
12244     *
12245     * @param obj The anchorblock object
12246     * @return The style to use by the hover. NULL means the default is used.
12247     *
12248     * @see elm_object_style_set()
12249     */
12250    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12251    /**
12252     * Ends the hover popup in the anchorblock
12253     *
12254     * When an anchor is clicked, the anchorblock widget will create a hover
12255     * object to use as a popup with user provided content. This function
12256     * terminates this popup, returning the anchorblock to its normal state.
12257     *
12258     * @param obj The anchorblock object
12259     */
12260    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12261    /**
12262     * Appends a custom item provider to the given anchorblock
12263     *
12264     * Appends the given function to the list of items providers. This list is
12265     * called, one function at a time, with the given @p data pointer, the
12266     * anchorblock object and, in the @p item parameter, the item name as
12267     * referenced in its href string. Following functions in the list will be
12268     * called in order until one of them returns something different to NULL,
12269     * which should be an Evas_Object which will be used in place of the item
12270     * element.
12271     *
12272     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12273     * href=item/name\>\</item\>
12274     *
12275     * @param obj The anchorblock object
12276     * @param func The function to add to the list of providers
12277     * @param data User data that will be passed to the callback function
12278     *
12279     * @see elm_entry_item_provider_append()
12280     */
12281    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);
12282    /**
12283     * Prepend a custom item provider to the given anchorblock
12284     *
12285     * Like elm_anchorblock_item_provider_append(), but it adds the function
12286     * @p func to the beginning of the list, instead of the end.
12287     *
12288     * @param obj The anchorblock object
12289     * @param func The function to add to the list of providers
12290     * @param data User data that will be passed to the callback function
12291     */
12292    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);
12293    /**
12294     * Remove a custom item provider from the list of the given anchorblock
12295     *
12296     * Removes the function and data pairing that matches @p func and @p data.
12297     * That is, unless the same function and same user data are given, the
12298     * function will not be removed from the list. This allows us to add the
12299     * same callback several times, with different @p data pointers and be
12300     * able to remove them later without conflicts.
12301     *
12302     * @param obj The anchorblock object
12303     * @param func The function to remove from the list
12304     * @param data The data matching the function to remove from the list
12305     */
12306    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);
12307    /**
12308     * @}
12309     */
12310
12311    /**
12312     * @defgroup Bubble Bubble
12313     *
12314     * @image html img/widget/bubble/preview-00.png
12315     * @image latex img/widget/bubble/preview-00.eps
12316     * @image html img/widget/bubble/preview-01.png
12317     * @image latex img/widget/bubble/preview-01.eps
12318     * @image html img/widget/bubble/preview-02.png
12319     * @image latex img/widget/bubble/preview-02.eps
12320     *
12321     * @brief The Bubble is a widget to show text similar to how speech is
12322     * represented in comics.
12323     *
12324     * The bubble widget contains 5 important visual elements:
12325     * @li The frame is a rectangle with rounded edjes and an "arrow".
12326     * @li The @p icon is an image to which the frame's arrow points to.
12327     * @li The @p label is a text which appears to the right of the icon if the
12328     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12329     * otherwise.
12330     * @li The @p info is a text which appears to the right of the label. Info's
12331     * font is of a ligther color than label.
12332     * @li The @p content is an evas object that is shown inside the frame.
12333     *
12334     * The position of the arrow, icon, label and info depends on which corner is
12335     * selected. The four available corners are:
12336     * @li "top_left" - Default
12337     * @li "top_right"
12338     * @li "bottom_left"
12339     * @li "bottom_right"
12340     *
12341     * Signals that you can add callbacks for are:
12342     * @li "clicked" - This is called when a user has clicked the bubble.
12343     *
12344     * For an example of using a buble see @ref bubble_01_example_page "this".
12345     *
12346     * @{
12347     */
12348    /**
12349     * Add a new bubble to the parent
12350     *
12351     * @param parent The parent object
12352     * @return The new object or NULL if it cannot be created
12353     *
12354     * This function adds a text bubble to the given parent evas object.
12355     */
12356    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12357    /**
12358     * Set the label of the bubble
12359     *
12360     * @param obj The bubble object
12361     * @param label The string to set in the label
12362     *
12363     * This function sets the title of the bubble. Where this appears depends on
12364     * the selected corner.
12365     * @deprecated use elm_object_text_set() instead.
12366     */
12367    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12368    /**
12369     * Get the label of the bubble
12370     *
12371     * @param obj The bubble object
12372     * @return The string of set in the label
12373     *
12374     * This function gets the title of the bubble.
12375     * @deprecated use elm_object_text_get() instead.
12376     */
12377    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12378    /**
12379     * Set the info of the bubble
12380     *
12381     * @param obj The bubble object
12382     * @param info The given info about the bubble
12383     *
12384     * This function sets the info of the bubble. Where this appears depends on
12385     * the selected corner.
12386     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12387     */
12388    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12389    /**
12390     * Get the info of the bubble
12391     *
12392     * @param obj The bubble object
12393     *
12394     * @return The "info" string of the bubble
12395     *
12396     * This function gets the info text.
12397     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12398     */
12399    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12400    /**
12401     * Set the content to be shown in the bubble
12402     *
12403     * Once the content object is set, a previously set one will be deleted.
12404     * If you want to keep the old content object, use the
12405     * elm_bubble_content_unset() function.
12406     *
12407     * @param obj The bubble object
12408     * @param content The given content of the bubble
12409     *
12410     * This function sets the content shown on the middle of the bubble.
12411     */
12412    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12413    /**
12414     * Get the content shown in the bubble
12415     *
12416     * Return the content object which is set for this widget.
12417     *
12418     * @param obj The bubble object
12419     * @return The content that is being used
12420     */
12421    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12422    /**
12423     * Unset the content shown in the bubble
12424     *
12425     * Unparent and return the content object which was set for this widget.
12426     *
12427     * @param obj The bubble object
12428     * @return The content that was being used
12429     */
12430    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12431    /**
12432     * Set the icon of the bubble
12433     *
12434     * Once the icon object is set, a previously set one will be deleted.
12435     * If you want to keep the old content object, use the
12436     * elm_icon_content_unset() function.
12437     *
12438     * @param obj The bubble object
12439     * @param icon The given icon for the bubble
12440     */
12441    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12442    /**
12443     * Get the icon of the bubble
12444     *
12445     * @param obj The bubble object
12446     * @return The icon for the bubble
12447     *
12448     * This function gets the icon shown on the top left of bubble.
12449     */
12450    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12451    /**
12452     * Unset the icon of the bubble
12453     *
12454     * Unparent and return the icon object which was set for this widget.
12455     *
12456     * @param obj The bubble object
12457     * @return The icon that was being used
12458     */
12459    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12460    /**
12461     * Set the corner of the bubble
12462     *
12463     * @param obj The bubble object.
12464     * @param corner The given corner for the bubble.
12465     *
12466     * This function sets the corner of the bubble. The corner will be used to
12467     * determine where the arrow in the frame points to and where label, icon and
12468     * info are shown.
12469     *
12470     * Possible values for corner are:
12471     * @li "top_left" - Default
12472     * @li "top_right"
12473     * @li "bottom_left"
12474     * @li "bottom_right"
12475     */
12476    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12477    /**
12478     * Get the corner of the bubble
12479     *
12480     * @param obj The bubble object.
12481     * @return The given corner for the bubble.
12482     *
12483     * This function gets the selected corner of the bubble.
12484     */
12485    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12486    /**
12487     * @}
12488     */
12489
12490    /**
12491     * @defgroup Photo Photo
12492     *
12493     * For displaying the photo of a person (contact). Simple, yet
12494     * with a very specific purpose.
12495     *
12496     * Signals that you can add callbacks for are:
12497     *
12498     * "clicked" - This is called when a user has clicked the photo
12499     * "drag,start" - Someone started dragging the image out of the object
12500     * "drag,end" - Dragged item was dropped (somewhere)
12501     *
12502     * @{
12503     */
12504
12505    /**
12506     * Add a new photo to the parent
12507     *
12508     * @param parent The parent object
12509     * @return The new object or NULL if it cannot be created
12510     *
12511     * @ingroup Photo
12512     */
12513    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12514
12515    /**
12516     * Set the file that will be used as photo
12517     *
12518     * @param obj The photo object
12519     * @param file The path to file that will be used as photo
12520     *
12521     * @return (1 = success, 0 = error)
12522     *
12523     * @ingroup Photo
12524     */
12525    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12526
12527     /**
12528     * Set the file that will be used as thumbnail in the photo.
12529     *
12530     * @param obj The photo object.
12531     * @param file The path to file that will be used as thumb.
12532     * @param group The key used in case of an EET file.
12533     *
12534     * @ingroup Photo
12535     */
12536    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12537
12538    /**
12539     * Set the size that will be used on the photo
12540     *
12541     * @param obj The photo object
12542     * @param size The size that the photo will be
12543     *
12544     * @ingroup Photo
12545     */
12546    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12547
12548    /**
12549     * Set if the photo should be completely visible or not.
12550     *
12551     * @param obj The photo object
12552     * @param fill if true the photo will be completely visible
12553     *
12554     * @ingroup Photo
12555     */
12556    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12557
12558    /**
12559     * Set editability of the photo.
12560     *
12561     * An editable photo can be dragged to or from, and can be cut or
12562     * pasted too.  Note that pasting an image or dropping an item on
12563     * the image will delete the existing content.
12564     *
12565     * @param obj The photo object.
12566     * @param set To set of clear editablity.
12567     */
12568    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12569
12570    /**
12571     * @}
12572     */
12573
12574    /* gesture layer */
12575    /**
12576     * @defgroup Elm_Gesture_Layer Gesture Layer
12577     * Gesture Layer Usage:
12578     *
12579     * Use Gesture Layer to detect gestures.
12580     * The advantage is that you don't have to implement
12581     * gesture detection, just set callbacks of gesture state.
12582     * By using gesture layer we make standard interface.
12583     *
12584     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12585     * with a parent object parameter.
12586     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12587     * call. Usually with same object as target (2nd parameter).
12588     *
12589     * Now you need to tell gesture layer what gestures you follow.
12590     * This is done with @ref elm_gesture_layer_cb_set call.
12591     * By setting the callback you actually saying to gesture layer:
12592     * I would like to know when the gesture @ref Elm_Gesture_Types
12593     * switches to state @ref Elm_Gesture_State.
12594     *
12595     * Next, you need to implement the actual action that follows the input
12596     * in your callback.
12597     *
12598     * Note that if you like to stop being reported about a gesture, just set
12599     * all callbacks referring this gesture to NULL.
12600     * (again with @ref elm_gesture_layer_cb_set)
12601     *
12602     * The information reported by gesture layer to your callback is depending
12603     * on @ref Elm_Gesture_Types:
12604     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12605     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12606     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12607     *
12608     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12609     * @ref ELM_GESTURE_MOMENTUM.
12610     *
12611     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12612     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12613     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12614     * Note that we consider a flick as a line-gesture that should be completed
12615     * in flick-time-limit as defined in @ref Config.
12616     *
12617     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12618     *
12619     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12620     *
12621     *
12622     * Gesture Layer Tweaks:
12623     *
12624     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12625     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12626     *
12627     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12628     * so gesture starts when user touches (a *DOWN event) touch-surface
12629     * and ends when no fingers touches surface (a *UP event).
12630     */
12631
12632    /**
12633     * @enum _Elm_Gesture_Types
12634     * Enum of supported gesture types.
12635     * @ingroup Elm_Gesture_Layer
12636     */
12637    enum _Elm_Gesture_Types
12638      {
12639         ELM_GESTURE_FIRST = 0,
12640
12641         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12642         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12643         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12644         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12645
12646         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12647
12648         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12649         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12650
12651         ELM_GESTURE_ZOOM, /**< Zoom */
12652         ELM_GESTURE_ROTATE, /**< Rotate */
12653
12654         ELM_GESTURE_LAST
12655      };
12656
12657    /**
12658     * @typedef Elm_Gesture_Types
12659     * gesture types enum
12660     * @ingroup Elm_Gesture_Layer
12661     */
12662    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12663
12664    /**
12665     * @enum _Elm_Gesture_State
12666     * Enum of gesture states.
12667     * @ingroup Elm_Gesture_Layer
12668     */
12669    enum _Elm_Gesture_State
12670      {
12671         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12672         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12673         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12674         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12675         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12676      };
12677
12678    /**
12679     * @typedef Elm_Gesture_State
12680     * gesture states enum
12681     * @ingroup Elm_Gesture_Layer
12682     */
12683    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12684
12685    /**
12686     * @struct _Elm_Gesture_Taps_Info
12687     * Struct holds taps info for user
12688     * @ingroup Elm_Gesture_Layer
12689     */
12690    struct _Elm_Gesture_Taps_Info
12691      {
12692         Evas_Coord x, y;         /**< Holds center point between fingers */
12693         unsigned int n;          /**< Number of fingers tapped           */
12694         unsigned int timestamp;  /**< event timestamp       */
12695      };
12696
12697    /**
12698     * @typedef Elm_Gesture_Taps_Info
12699     * holds taps info for user
12700     * @ingroup Elm_Gesture_Layer
12701     */
12702    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12703
12704    /**
12705     * @struct _Elm_Gesture_Momentum_Info
12706     * Struct holds momentum info for user
12707     * x1 and y1 are not necessarily in sync
12708     * x1 holds x value of x direction starting point
12709     * and same holds for y1.
12710     * This is noticeable when doing V-shape movement
12711     * @ingroup Elm_Gesture_Layer
12712     */
12713    struct _Elm_Gesture_Momentum_Info
12714      {  /* Report line ends, timestamps, and momentum computed        */
12715         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12716         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12717         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12718         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12719
12720         unsigned int tx; /**< Timestamp of start of final x-swipe */
12721         unsigned int ty; /**< Timestamp of start of final y-swipe */
12722
12723         Evas_Coord mx; /**< Momentum on X */
12724         Evas_Coord my; /**< Momentum on Y */
12725
12726         unsigned int n;  /**< Number of fingers */
12727      };
12728
12729    /**
12730     * @typedef Elm_Gesture_Momentum_Info
12731     * holds momentum info for user
12732     * @ingroup Elm_Gesture_Layer
12733     */
12734     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12735
12736    /**
12737     * @struct _Elm_Gesture_Line_Info
12738     * Struct holds line info for user
12739     * @ingroup Elm_Gesture_Layer
12740     */
12741    struct _Elm_Gesture_Line_Info
12742      {  /* Report line ends, timestamps, and momentum computed      */
12743         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12744         /* FIXME should be radians, bot degrees */
12745         double angle;              /**< Angle (direction) of lines  */
12746      };
12747
12748    /**
12749     * @typedef Elm_Gesture_Line_Info
12750     * Holds line info for user
12751     * @ingroup Elm_Gesture_Layer
12752     */
12753     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12754
12755    /**
12756     * @struct _Elm_Gesture_Zoom_Info
12757     * Struct holds zoom info for user
12758     * @ingroup Elm_Gesture_Layer
12759     */
12760    struct _Elm_Gesture_Zoom_Info
12761      {
12762         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12763         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12764         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12765         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12766      };
12767
12768    /**
12769     * @typedef Elm_Gesture_Zoom_Info
12770     * Holds zoom info for user
12771     * @ingroup Elm_Gesture_Layer
12772     */
12773    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12774
12775    /**
12776     * @struct _Elm_Gesture_Rotate_Info
12777     * Struct holds rotation info for user
12778     * @ingroup Elm_Gesture_Layer
12779     */
12780    struct _Elm_Gesture_Rotate_Info
12781      {
12782         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12783         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12784         double base_angle; /**< Holds start-angle */
12785         double angle;      /**< Rotation value: 0.0 means no rotation         */
12786         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12787      };
12788
12789    /**
12790     * @typedef Elm_Gesture_Rotate_Info
12791     * Holds rotation info for user
12792     * @ingroup Elm_Gesture_Layer
12793     */
12794    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12795
12796    /**
12797     * @typedef Elm_Gesture_Event_Cb
12798     * User callback used to stream gesture info from gesture layer
12799     * @param data user data
12800     * @param event_info gesture report info
12801     * Returns a flag field to be applied on the causing event.
12802     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12803     * upon the event, in an irreversible way.
12804     *
12805     * @ingroup Elm_Gesture_Layer
12806     */
12807    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12808
12809    /**
12810     * Use function to set callbacks to be notified about
12811     * change of state of gesture.
12812     * When a user registers a callback with this function
12813     * this means this gesture has to be tested.
12814     *
12815     * When ALL callbacks for a gesture are set to NULL
12816     * it means user isn't interested in gesture-state
12817     * and it will not be tested.
12818     *
12819     * @param obj Pointer to gesture-layer.
12820     * @param idx The gesture you would like to track its state.
12821     * @param cb callback function pointer.
12822     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12823     * @param data user info to be sent to callback (usually, Smart Data)
12824     *
12825     * @ingroup Elm_Gesture_Layer
12826     */
12827    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);
12828
12829    /**
12830     * Call this function to get repeat-events settings.
12831     *
12832     * @param obj Pointer to gesture-layer.
12833     *
12834     * @return repeat events settings.
12835     * @see elm_gesture_layer_hold_events_set()
12836     * @ingroup Elm_Gesture_Layer
12837     */
12838    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12839
12840    /**
12841     * This function called in order to make gesture-layer repeat events.
12842     * Set this of you like to get the raw events only if gestures were not detected.
12843     * Clear this if you like gesture layer to fwd events as testing gestures.
12844     *
12845     * @param obj Pointer to gesture-layer.
12846     * @param r Repeat: TRUE/FALSE
12847     *
12848     * @ingroup Elm_Gesture_Layer
12849     */
12850    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12851
12852    /**
12853     * This function sets step-value for zoom action.
12854     * Set step to any positive value.
12855     * Cancel step setting by setting to 0.0
12856     *
12857     * @param obj Pointer to gesture-layer.
12858     * @param s new zoom step value.
12859     *
12860     * @ingroup Elm_Gesture_Layer
12861     */
12862    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12863
12864    /**
12865     * This function sets step-value for rotate action.
12866     * Set step to any positive value.
12867     * Cancel step setting by setting to 0.0
12868     *
12869     * @param obj Pointer to gesture-layer.
12870     * @param s new roatate step value.
12871     *
12872     * @ingroup Elm_Gesture_Layer
12873     */
12874    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12875
12876    /**
12877     * This function called to attach gesture-layer to an Evas_Object.
12878     * @param obj Pointer to gesture-layer.
12879     * @param t Pointer to underlying object (AKA Target)
12880     *
12881     * @return TRUE, FALSE on success, failure.
12882     *
12883     * @ingroup Elm_Gesture_Layer
12884     */
12885    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12886
12887    /**
12888     * Call this function to construct a new gesture-layer object.
12889     * This does not activate the gesture layer. You have to
12890     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12891     *
12892     * @param parent the parent object.
12893     *
12894     * @return Pointer to new gesture-layer object.
12895     *
12896     * @ingroup Elm_Gesture_Layer
12897     */
12898    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12899
12900    /**
12901     * @defgroup Thumb Thumb
12902     *
12903     * @image html img/widget/thumb/preview-00.png
12904     * @image latex img/widget/thumb/preview-00.eps
12905     *
12906     * A thumb object is used for displaying the thumbnail of an image or video.
12907     * You must have compiled Elementary with Ethumb_Client support and the DBus
12908     * service must be present and auto-activated in order to have thumbnails to
12909     * be generated.
12910     *
12911     * Once the thumbnail object becomes visible, it will check if there is a
12912     * previously generated thumbnail image for the file set on it. If not, it
12913     * will start generating this thumbnail.
12914     *
12915     * Different config settings will cause different thumbnails to be generated
12916     * even on the same file.
12917     *
12918     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12919     * Ethumb documentation to change this path, and to see other configuration
12920     * options.
12921     *
12922     * Signals that you can add callbacks for are:
12923     *
12924     * - "clicked" - This is called when a user has clicked the thumb without dragging
12925     *             around.
12926     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12927     * - "press" - This is called when a user has pressed down the thumb.
12928     * - "generate,start" - The thumbnail generation started.
12929     * - "generate,stop" - The generation process stopped.
12930     * - "generate,error" - The generation failed.
12931     * - "load,error" - The thumbnail image loading failed.
12932     *
12933     * available styles:
12934     * - default
12935     * - noframe
12936     *
12937     * An example of use of thumbnail:
12938     *
12939     * - @ref thumb_example_01
12940     */
12941
12942    /**
12943     * @addtogroup Thumb
12944     * @{
12945     */
12946
12947    /**
12948     * @enum _Elm_Thumb_Animation_Setting
12949     * @typedef Elm_Thumb_Animation_Setting
12950     *
12951     * Used to set if a video thumbnail is animating or not.
12952     *
12953     * @ingroup Thumb
12954     */
12955    typedef enum _Elm_Thumb_Animation_Setting
12956      {
12957         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12958         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12959         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12960         ELM_THUMB_ANIMATION_LAST
12961      } Elm_Thumb_Animation_Setting;
12962
12963    /**
12964     * Add a new thumb object to the parent.
12965     *
12966     * @param parent The parent object.
12967     * @return The new object or NULL if it cannot be created.
12968     *
12969     * @see elm_thumb_file_set()
12970     * @see elm_thumb_ethumb_client_get()
12971     *
12972     * @ingroup Thumb
12973     */
12974    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12975    /**
12976     * Reload thumbnail if it was generated before.
12977     *
12978     * @param obj The thumb object to reload
12979     *
12980     * This is useful if the ethumb client configuration changed, like its
12981     * size, aspect or any other property one set in the handle returned
12982     * by elm_thumb_ethumb_client_get().
12983     *
12984     * If the options didn't change, the thumbnail won't be generated again, but
12985     * the old one will still be used.
12986     *
12987     * @see elm_thumb_file_set()
12988     *
12989     * @ingroup Thumb
12990     */
12991    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12992    /**
12993     * Set the file that will be used as thumbnail.
12994     *
12995     * @param obj The thumb object.
12996     * @param file The path to file that will be used as thumb.
12997     * @param key The key used in case of an EET file.
12998     *
12999     * The file can be an image or a video (in that case, acceptable extensions are:
13000     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13001     * function elm_thumb_animate().
13002     *
13003     * @see elm_thumb_file_get()
13004     * @see elm_thumb_reload()
13005     * @see elm_thumb_animate()
13006     *
13007     * @ingroup Thumb
13008     */
13009    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13010    /**
13011     * Get the image or video path and key used to generate the thumbnail.
13012     *
13013     * @param obj The thumb object.
13014     * @param file Pointer to filename.
13015     * @param key Pointer to key.
13016     *
13017     * @see elm_thumb_file_set()
13018     * @see elm_thumb_path_get()
13019     *
13020     * @ingroup Thumb
13021     */
13022    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13023    /**
13024     * Get the path and key to the image or video generated by ethumb.
13025     *
13026     * One just need to make sure that the thumbnail was generated before getting
13027     * its path; otherwise, the path will be NULL. One way to do that is by asking
13028     * for the path when/after the "generate,stop" smart callback is called.
13029     *
13030     * @param obj The thumb object.
13031     * @param file Pointer to thumb path.
13032     * @param key Pointer to thumb key.
13033     *
13034     * @see elm_thumb_file_get()
13035     *
13036     * @ingroup Thumb
13037     */
13038    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13039    /**
13040     * Set the animation state for the thumb object. If its content is an animated
13041     * video, you may start/stop the animation or tell it to play continuously and
13042     * looping.
13043     *
13044     * @param obj The thumb object.
13045     * @param setting The animation setting.
13046     *
13047     * @see elm_thumb_file_set()
13048     *
13049     * @ingroup Thumb
13050     */
13051    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13052    /**
13053     * Get the animation state for the thumb object.
13054     *
13055     * @param obj The thumb object.
13056     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13057     * on errors.
13058     *
13059     * @see elm_thumb_animate_set()
13060     *
13061     * @ingroup Thumb
13062     */
13063    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13064    /**
13065     * Get the ethumb_client handle so custom configuration can be made.
13066     *
13067     * @return Ethumb_Client instance or NULL.
13068     *
13069     * This must be called before the objects are created to be sure no object is
13070     * visible and no generation started.
13071     *
13072     * Example of usage:
13073     *
13074     * @code
13075     * #include <Elementary.h>
13076     * #ifndef ELM_LIB_QUICKLAUNCH
13077     * EAPI_MAIN int
13078     * elm_main(int argc, char **argv)
13079     * {
13080     *    Ethumb_Client *client;
13081     *
13082     *    elm_need_ethumb();
13083     *
13084     *    // ... your code
13085     *
13086     *    client = elm_thumb_ethumb_client_get();
13087     *    if (!client)
13088     *      {
13089     *         ERR("could not get ethumb_client");
13090     *         return 1;
13091     *      }
13092     *    ethumb_client_size_set(client, 100, 100);
13093     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13094     *    // ... your code
13095     *
13096     *    // Create elm_thumb objects here
13097     *
13098     *    elm_run();
13099     *    elm_shutdown();
13100     *    return 0;
13101     * }
13102     * #endif
13103     * ELM_MAIN()
13104     * @endcode
13105     *
13106     * @note There's only one client handle for Ethumb, so once a configuration
13107     * change is done to it, any other request for thumbnails (for any thumbnail
13108     * object) will use that configuration. Thus, this configuration is global.
13109     *
13110     * @ingroup Thumb
13111     */
13112    EAPI void                        *elm_thumb_ethumb_client_get(void);
13113    /**
13114     * Get the ethumb_client connection state.
13115     *
13116     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13117     * otherwise.
13118     */
13119    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13120    /**
13121     * Make the thumbnail 'editable'.
13122     *
13123     * @param obj Thumb object.
13124     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13125     *
13126     * This means the thumbnail is a valid drag target for drag and drop, and can be
13127     * cut or pasted too.
13128     *
13129     * @see elm_thumb_editable_get()
13130     *
13131     * @ingroup Thumb
13132     */
13133    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13134    /**
13135     * Make the thumbnail 'editable'.
13136     *
13137     * @param obj Thumb object.
13138     * @return Editability.
13139     *
13140     * This means the thumbnail is a valid drag target for drag and drop, and can be
13141     * cut or pasted too.
13142     *
13143     * @see elm_thumb_editable_set()
13144     *
13145     * @ingroup Thumb
13146     */
13147    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13148
13149    /**
13150     * @}
13151     */
13152
13153    /**
13154     * @defgroup Web Web
13155     *
13156     * @image html img/widget/web/preview-00.png
13157     * @image latex img/widget/web/preview-00.eps
13158     *
13159     * A web object is used for displaying web pages (HTML/CSS/JS)
13160     * using WebKit-EFL. You must have compiled Elementary with
13161     * ewebkit support.
13162     *
13163     * Signals that you can add callbacks for are:
13164     * @li "download,request": A file download has been requested. Event info is
13165     * a pointer to a Elm_Web_Download
13166     * @li "editorclient,contents,changed": Editor client's contents changed
13167     * @li "editorclient,selection,changed": Editor client's selection changed
13168     * @li "frame,created": A new frame was created. Event info is an
13169     * Evas_Object which can be handled with WebKit's ewk_frame API
13170     * @li "icon,received": An icon was received by the main frame
13171     * @li "inputmethod,changed": Input method changed. Event info is an
13172     * Eina_Bool indicating whether it's enabled or not
13173     * @li "js,windowobject,clear": JS window object has been cleared
13174     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13175     * is a char *link[2], where the first string contains the URL the link
13176     * points to, and the second one the title of the link
13177     * @li "link,hover,out": Mouse cursor left the link
13178     * @li "load,document,finished": Loading of a document finished. Event info
13179     * is the frame that finished loading
13180     * @li "load,error": Load failed. Event info is a pointer to
13181     * Elm_Web_Frame_Load_Error
13182     * @li "load,finished": Load finished. Event info is NULL on success, on
13183     * error it's a pointer to Elm_Web_Frame_Load_Error
13184     * @li "load,newwindow,show": A new window was created and is ready to be
13185     * shown
13186     * @li "load,progress": Overall load progress. Event info is a pointer to
13187     * a double containing a value between 0.0 and 1.0
13188     * @li "load,provisional": Started provisional load
13189     * @li "load,started": Loading of a document started
13190     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13191     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13192     * the menubar is visible, or EINA_FALSE in case it's not
13193     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13194     * an Eina_Bool indicating the visibility
13195     * @li "popup,created": A dropdown widget was activated, requesting its
13196     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13197     * @li "popup,willdelete": The web object is ready to destroy the popup
13198     * object created. Event info is a pointer to Elm_Web_Menu
13199     * @li "ready": Page is fully loaded
13200     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13201     * info is a pointer to Eina_Bool where the visibility state should be set
13202     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13203     * is an Eina_Bool with the visibility state set
13204     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13205     * a string with the new text
13206     * @li "statusbar,visible,get": Queries visibility of the status bar.
13207     * Event info is a pointer to Eina_Bool where the visibility state should be
13208     * set.
13209     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13210     * an Eina_Bool with the visibility value
13211     * @li "title,changed": Title of the main frame changed. Event info is a
13212     * string with the new title
13213     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13214     * is a pointer to Eina_Bool where the visibility state should be set
13215     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13216     * info is an Eina_Bool with the visibility state
13217     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13218     * a string with the text to show
13219     * @li "uri,changed": URI of the main frame changed. Event info is a string
13220     * with the new URI
13221     * @li "view,resized": The web object internal's view changed sized
13222     * @li "windows,close,request": A JavaScript request to close the current
13223     * window was requested
13224     * @li "zoom,animated,end": Animated zoom finished
13225     *
13226     * available styles:
13227     * - default
13228     *
13229     * An example of use of web:
13230     *
13231     * - @ref web_example_01 TBD
13232     */
13233
13234    /**
13235     * @addtogroup Web
13236     * @{
13237     */
13238
13239    /**
13240     * Structure used to report load errors.
13241     *
13242     * Load errors are reported as signal by elm_web. All the strings are
13243     * temporary references and should @b not be used after the signal
13244     * callback returns. If it's required, make copies with strdup() or
13245     * eina_stringshare_add() (they are not even guaranteed to be
13246     * stringshared, so must use eina_stringshare_add() and not
13247     * eina_stringshare_ref()).
13248     */
13249    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13250    /**
13251     * Structure used to report load errors.
13252     *
13253     * Load errors are reported as signal by elm_web. All the strings are
13254     * temporary references and should @b not be used after the signal
13255     * callback returns. If it's required, make copies with strdup() or
13256     * eina_stringshare_add() (they are not even guaranteed to be
13257     * stringshared, so must use eina_stringshare_add() and not
13258     * eina_stringshare_ref()).
13259     */
13260    struct _Elm_Web_Frame_Load_Error
13261      {
13262         int code; /**< Numeric error code */
13263         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13264         const char *domain; /**< Error domain name */
13265         const char *description; /**< Error description (already localized) */
13266         const char *failing_url; /**< The URL that failed to load */
13267         Evas_Object *frame; /**< Frame object that produced the error */
13268      };
13269
13270    /**
13271     * The possibles types that the items in a menu can be
13272     */
13273    typedef enum _Elm_Web_Menu_Item_Type
13274      {
13275         ELM_WEB_MENU_SEPARATOR,
13276         ELM_WEB_MENU_GROUP,
13277         ELM_WEB_MENU_OPTION
13278      } Elm_Web_Menu_Item_Type;
13279
13280    /**
13281     * Structure describing the items in a menu
13282     */
13283    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13284    /**
13285     * Structure describing the items in a menu
13286     */
13287    struct _Elm_Web_Menu_Item
13288      {
13289         const char *text; /**< The text for the item */
13290         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13291      };
13292
13293    /**
13294     * Structure describing the menu of a popup
13295     *
13296     * This structure will be passed as the @c event_info for the "popup,create"
13297     * signal, which is emitted when a dropdown menu is opened. Users wanting
13298     * to handle these popups by themselves should listen to this signal and
13299     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13300     * property as @c EINA_FALSE means that the user will not handle the popup
13301     * and the default implementation will be used.
13302     *
13303     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13304     * will be emitted to notify the user that it can destroy any objects and
13305     * free all data related to it.
13306     *
13307     * @see elm_web_popup_selected_set()
13308     * @see elm_web_popup_destroy()
13309     */
13310    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13311    /**
13312     * Structure describing the menu of a popup
13313     *
13314     * This structure will be passed as the @c event_info for the "popup,create"
13315     * signal, which is emitted when a dropdown menu is opened. Users wanting
13316     * to handle these popups by themselves should listen to this signal and
13317     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13318     * property as @c EINA_FALSE means that the user will not handle the popup
13319     * and the default implementation will be used.
13320     *
13321     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13322     * will be emitted to notify the user that it can destroy any objects and
13323     * free all data related to it.
13324     *
13325     * @see elm_web_popup_selected_set()
13326     * @see elm_web_popup_destroy()
13327     */
13328    struct _Elm_Web_Menu
13329      {
13330         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13331         int x; /**< The X position of the popup, relative to the elm_web object */
13332         int y; /**< The Y position of the popup, relative to the elm_web object */
13333         int width; /**< Width of the popup menu */
13334         int height; /**< Height of the popup menu */
13335
13336         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. */
13337      };
13338
13339    typedef struct _Elm_Web_Download Elm_Web_Download;
13340    struct _Elm_Web_Download
13341      {
13342         const char *url;
13343      };
13344
13345    /**
13346     * Types of zoom available.
13347     */
13348    typedef enum _Elm_Web_Zoom_Mode
13349      {
13350         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13351         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13352         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13353         ELM_WEB_ZOOM_MODE_LAST
13354      } Elm_Web_Zoom_Mode;
13355    /**
13356     * Opaque handler containing the features (such as statusbar, menubar, etc)
13357     * that are to be set on a newly requested window.
13358     */
13359    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13360    /**
13361     * Callback type for the create_window hook.
13362     *
13363     * The function parameters are:
13364     * @li @p data User data pointer set when setting the hook function
13365     * @li @p obj The elm_web object requesting the new window
13366     * @li @p js Set to @c EINA_TRUE if the request was originated from
13367     * JavaScript. @c EINA_FALSE otherwise.
13368     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13369     * the features requested for the new window.
13370     *
13371     * The returned value of the function should be the @c elm_web widget where
13372     * the request will be loaded. That is, if a new window or tab is created,
13373     * the elm_web widget in it should be returned, and @b NOT the window
13374     * object.
13375     * Returning @c NULL should cancel the request.
13376     *
13377     * @see elm_web_window_create_hook_set()
13378     */
13379    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13380    /**
13381     * Callback type for the JS alert hook.
13382     *
13383     * The function parameters are:
13384     * @li @p data User data pointer set when setting the hook function
13385     * @li @p obj The elm_web object requesting the new window
13386     * @li @p message The message to show in the alert dialog
13387     *
13388     * The function should return the object representing the alert dialog.
13389     * Elm_Web will run a second main loop to handle the dialog and normal
13390     * flow of the application will be restored when the object is deleted, so
13391     * the user should handle the popup properly in order to delete the object
13392     * when the action is finished.
13393     * If the function returns @c NULL the popup will be ignored.
13394     *
13395     * @see elm_web_dialog_alert_hook_set()
13396     */
13397    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13398    /**
13399     * Callback type for the JS confirm hook.
13400     *
13401     * The function parameters are:
13402     * @li @p data User data pointer set when setting the hook function
13403     * @li @p obj The elm_web object requesting the new window
13404     * @li @p message The message to show in the confirm dialog
13405     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13406     * the user selected @c Ok, @c EINA_FALSE otherwise.
13407     *
13408     * The function should return the object representing the confirm dialog.
13409     * Elm_Web will run a second main loop to handle the dialog and normal
13410     * flow of the application will be restored when the object is deleted, so
13411     * the user should handle the popup properly in order to delete the object
13412     * when the action is finished.
13413     * If the function returns @c NULL the popup will be ignored.
13414     *
13415     * @see elm_web_dialog_confirm_hook_set()
13416     */
13417    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13418    /**
13419     * Callback type for the JS prompt hook.
13420     *
13421     * The function parameters are:
13422     * @li @p data User data pointer set when setting the hook function
13423     * @li @p obj The elm_web object requesting the new window
13424     * @li @p message The message to show in the prompt dialog
13425     * @li @p def_value The default value to present the user in the entry
13426     * @li @p value Pointer where to store the value given by the user. Must
13427     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13428     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13429     * the user selected @c Ok, @c EINA_FALSE otherwise.
13430     *
13431     * The function should return the object representing the prompt dialog.
13432     * Elm_Web will run a second main loop to handle the dialog and normal
13433     * flow of the application will be restored when the object is deleted, so
13434     * the user should handle the popup properly in order to delete the object
13435     * when the action is finished.
13436     * If the function returns @c NULL the popup will be ignored.
13437     *
13438     * @see elm_web_dialog_prompt_hook_set()
13439     */
13440    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13441    /**
13442     * Callback type for the JS file selector hook.
13443     *
13444     * The function parameters are:
13445     * @li @p data User data pointer set when setting the hook function
13446     * @li @p obj The elm_web object requesting the new window
13447     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13448     * @li @p accept_types Mime types accepted
13449     * @li @p selected Pointer where to store the list of malloc'ed strings
13450     * containing the path to each file selected. Must be @c NULL if the file
13451     * dialog is cancelled
13452     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13453     * the user selected @c Ok, @c EINA_FALSE otherwise.
13454     *
13455     * The function should return the object representing the file selector
13456     * dialog.
13457     * Elm_Web will run a second main loop to handle the dialog and normal
13458     * flow of the application will be restored when the object is deleted, so
13459     * the user should handle the popup properly in order to delete the object
13460     * when the action is finished.
13461     * If the function returns @c NULL the popup will be ignored.
13462     *
13463     * @see elm_web_dialog_file selector_hook_set()
13464     */
13465    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);
13466    /**
13467     * Callback type for the JS console message hook.
13468     *
13469     * When a console message is added from JavaScript, any set function to the
13470     * console message hook will be called for the user to handle. There is no
13471     * default implementation of this hook.
13472     *
13473     * The function parameters are:
13474     * @li @p data User data pointer set when setting the hook function
13475     * @li @p obj The elm_web object that originated the message
13476     * @li @p message The message sent
13477     * @li @p line_number The line number
13478     * @li @p source_id Source id
13479     *
13480     * @see elm_web_console_message_hook_set()
13481     */
13482    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13483    /**
13484     * Add a new web object to the parent.
13485     *
13486     * @param parent The parent object.
13487     * @return The new object or NULL if it cannot be created.
13488     *
13489     * @see elm_web_uri_set()
13490     * @see elm_web_webkit_view_get()
13491     */
13492    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13493
13494    /**
13495     * Get internal ewk_view object from web object.
13496     *
13497     * Elementary may not provide some low level features of EWebKit,
13498     * instead of cluttering the API with proxy methods we opted to
13499     * return the internal reference. Be careful using it as it may
13500     * interfere with elm_web behavior.
13501     *
13502     * @param obj The web object.
13503     * @return The internal ewk_view object or NULL if it does not
13504     *         exist. (Failure to create or Elementary compiled without
13505     *         ewebkit)
13506     *
13507     * @see elm_web_add()
13508     */
13509    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13510
13511    /**
13512     * Sets the function to call when a new window is requested
13513     *
13514     * This hook will be called when a request to create a new window is
13515     * issued from the web page loaded.
13516     * There is no default implementation for this feature, so leaving this
13517     * unset or passing @c NULL in @p func will prevent new windows from
13518     * opening.
13519     *
13520     * @param obj The web object where to set the hook function
13521     * @param func The hook function to be called when a window is requested
13522     * @param data User data
13523     */
13524    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13525    /**
13526     * Sets the function to call when an alert dialog
13527     *
13528     * This hook will be called when a JavaScript alert dialog is requested.
13529     * If no function is set or @c NULL is passed in @p func, the default
13530     * implementation will take place.
13531     *
13532     * @param obj The web object where to set the hook function
13533     * @param func The callback function to be used
13534     * @param data User data
13535     *
13536     * @see elm_web_inwin_mode_set()
13537     */
13538    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13539    /**
13540     * Sets the function to call when an confirm dialog
13541     *
13542     * This hook will be called when a JavaScript confirm dialog is requested.
13543     * If no function is set or @c NULL is passed in @p func, the default
13544     * implementation will take place.
13545     *
13546     * @param obj The web object where to set the hook function
13547     * @param func The callback function to be used
13548     * @param data User data
13549     *
13550     * @see elm_web_inwin_mode_set()
13551     */
13552    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13553    /**
13554     * Sets the function to call when an prompt dialog
13555     *
13556     * This hook will be called when a JavaScript prompt dialog is requested.
13557     * If no function is set or @c NULL is passed in @p func, the default
13558     * implementation will take place.
13559     *
13560     * @param obj The web object where to set the hook function
13561     * @param func The callback function to be used
13562     * @param data User data
13563     *
13564     * @see elm_web_inwin_mode_set()
13565     */
13566    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13567    /**
13568     * Sets the function to call when an file selector dialog
13569     *
13570     * This hook will be called when a JavaScript file selector dialog is
13571     * requested.
13572     * If no function is set or @c NULL is passed in @p func, the default
13573     * implementation will take place.
13574     *
13575     * @param obj The web object where to set the hook function
13576     * @param func The callback function to be used
13577     * @param data User data
13578     *
13579     * @see elm_web_inwin_mode_set()
13580     */
13581    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13582    /**
13583     * Sets the function to call when a console message is emitted from JS
13584     *
13585     * This hook will be called when a console message is emitted from
13586     * JavaScript. There is no default implementation for this feature.
13587     *
13588     * @param obj The web object where to set the hook function
13589     * @param func The callback function to be used
13590     * @param data User data
13591     */
13592    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13593    /**
13594     * Gets the status of the tab propagation
13595     *
13596     * @param obj The web object to query
13597     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13598     *
13599     * @see elm_web_tab_propagate_set()
13600     */
13601    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13602    /**
13603     * Sets whether to use tab propagation
13604     *
13605     * If tab propagation is enabled, whenever the user presses the Tab key,
13606     * Elementary will handle it and switch focus to the next widget.
13607     * The default value is disabled, where WebKit will handle the Tab key to
13608     * cycle focus though its internal objects, jumping to the next widget
13609     * only when that cycle ends.
13610     *
13611     * @param obj The web object
13612     * @param propagate Whether to propagate Tab keys to Elementary or not
13613     */
13614    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13615    /**
13616     * Sets the URI for the web object
13617     *
13618     * It must be a full URI, with resource included, in the form
13619     * http://www.enlightenment.org or file:///tmp/something.html
13620     *
13621     * @param obj The web object
13622     * @param uri The URI to set
13623     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13624     */
13625    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13626    /**
13627     * Gets the current URI for the object
13628     *
13629     * The returned string must not be freed and is guaranteed to be
13630     * stringshared.
13631     *
13632     * @param obj The web object
13633     * @return A stringshared internal string with the current URI, or NULL on
13634     * failure
13635     */
13636    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13637    /**
13638     * Gets the current title
13639     *
13640     * The returned string must not be freed and is guaranteed to be
13641     * stringshared.
13642     *
13643     * @param obj The web object
13644     * @return A stringshared internal string with the current title, or NULL on
13645     * failure
13646     */
13647    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13648    /**
13649     * Sets the background color to be used by the web object
13650     *
13651     * This is the color that will be used by default when the loaded page
13652     * does not set it's own. Color values are pre-multiplied.
13653     *
13654     * @param obj The web object
13655     * @param r Red component
13656     * @param g Green component
13657     * @param b Blue component
13658     * @param a Alpha component
13659     */
13660    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13661    /**
13662     * Gets the background color to be used by the web object
13663     *
13664     * This is the color that will be used by default when the loaded page
13665     * does not set it's own. Color values are pre-multiplied.
13666     *
13667     * @param obj The web object
13668     * @param r Red component
13669     * @param g Green component
13670     * @param b Blue component
13671     * @param a Alpha component
13672     */
13673    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13674    /**
13675     * Gets a copy of the currently selected text
13676     *
13677     * The string returned must be freed by the user when it's done with it.
13678     *
13679     * @param obj The web object
13680     * @return A newly allocated string, or NULL if nothing is selected or an
13681     * error occurred
13682     */
13683    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13684    /**
13685     * Tells the web object which index in the currently open popup was selected
13686     *
13687     * When the user handles the popup creation from the "popup,created" signal,
13688     * it needs to tell the web object which item was selected by calling this
13689     * function with the index corresponding to the item.
13690     *
13691     * @param obj The web object
13692     * @param index The index selected
13693     *
13694     * @see elm_web_popup_destroy()
13695     */
13696    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13697    /**
13698     * Dismisses an open dropdown popup
13699     *
13700     * When the popup from a dropdown widget is to be dismissed, either after
13701     * selecting an option or to cancel it, this function must be called, which
13702     * will later emit an "popup,willdelete" signal to notify the user that
13703     * any memory and objects related to this popup can be freed.
13704     *
13705     * @param obj The web object
13706     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13707     * if there was no menu to destroy
13708     */
13709    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13710    /**
13711     * Searches the given string in a document.
13712     *
13713     * @param obj The web object where to search the text
13714     * @param string String to search
13715     * @param case_sensitive If search should be case sensitive or not
13716     * @param forward If search is from cursor and on or backwards
13717     * @param wrap If search should wrap at the end
13718     *
13719     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13720     * or failure
13721     */
13722    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13723    /**
13724     * Marks matches of the given string in a document.
13725     *
13726     * @param obj The web object where to search text
13727     * @param string String to match
13728     * @param case_sensitive If match should be case sensitive or not
13729     * @param highlight If matches should be highlighted
13730     * @param limit Maximum amount of matches, or zero to unlimited
13731     *
13732     * @return number of matched @a string
13733     */
13734    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13735    /**
13736     * Clears all marked matches in the document
13737     *
13738     * @param obj The web object
13739     *
13740     * @return EINA_TRUE on success, EINA_FALSE otherwise
13741     */
13742    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13743    /**
13744     * Sets whether to highlight the matched marks
13745     *
13746     * If enabled, marks set with elm_web_text_matches_mark() will be
13747     * highlighted.
13748     *
13749     * @param obj The web object
13750     * @param highlight Whether to highlight the marks or not
13751     *
13752     * @return EINA_TRUE on success, EINA_FALSE otherwise
13753     */
13754    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13755    /**
13756     * Gets whether highlighting marks is enabled
13757     *
13758     * @param The web object
13759     *
13760     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13761     * otherwise
13762     */
13763    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13764    /**
13765     * Gets the overall loading progress of the page
13766     *
13767     * Returns the estimated loading progress of the page, with a value between
13768     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13769     * included in the page.
13770     *
13771     * @param The web object
13772     *
13773     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13774     * failure
13775     */
13776    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13777    /**
13778     * Stops loading the current page
13779     *
13780     * Cancels the loading of the current page in the web object. This will
13781     * cause a "load,error" signal to be emitted, with the is_cancellation
13782     * flag set to EINA_TRUE.
13783     *
13784     * @param obj The web object
13785     *
13786     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13787     */
13788    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13789    /**
13790     * Requests a reload of the current document in the object
13791     *
13792     * @param obj The web object
13793     *
13794     * @return EINA_TRUE on success, EINA_FALSE otherwise
13795     */
13796    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13797    /**
13798     * Requests a reload of the current document, avoiding any existing caches
13799     *
13800     * @param obj The web object
13801     *
13802     * @return EINA_TRUE on success, EINA_FALSE otherwise
13803     */
13804    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13805    /**
13806     * Goes back one step in the browsing history
13807     *
13808     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13809     *
13810     * @param obj The web object
13811     *
13812     * @return EINA_TRUE on success, EINA_FALSE otherwise
13813     *
13814     * @see elm_web_history_enable_set()
13815     * @see elm_web_back_possible()
13816     * @see elm_web_forward()
13817     * @see elm_web_navigate()
13818     */
13819    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13820    /**
13821     * Goes forward one step in the browsing history
13822     *
13823     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13824     *
13825     * @param obj The web object
13826     *
13827     * @return EINA_TRUE on success, EINA_FALSE otherwise
13828     *
13829     * @see elm_web_history_enable_set()
13830     * @see elm_web_forward_possible()
13831     * @see elm_web_back()
13832     * @see elm_web_navigate()
13833     */
13834    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13835    /**
13836     * Jumps the given number of steps in the browsing history
13837     *
13838     * The @p steps value can be a negative integer to back in history, or a
13839     * positive to move forward.
13840     *
13841     * @param obj The web object
13842     * @param steps The number of steps to jump
13843     *
13844     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13845     * history exists to jump the given number of steps
13846     *
13847     * @see elm_web_history_enable_set()
13848     * @see elm_web_navigate_possible()
13849     * @see elm_web_back()
13850     * @see elm_web_forward()
13851     */
13852    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13853    /**
13854     * Queries whether it's possible to go back in history
13855     *
13856     * @param obj The web object
13857     *
13858     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13859     * otherwise
13860     */
13861    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13862    /**
13863     * Queries whether it's possible to go forward in history
13864     *
13865     * @param obj The web object
13866     *
13867     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13868     * otherwise
13869     */
13870    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13871    /**
13872     * Queries whether it's possible to jump the given number of steps
13873     *
13874     * The @p steps value can be a negative integer to back in history, or a
13875     * positive to move forward.
13876     *
13877     * @param obj The web object
13878     * @param steps The number of steps to check for
13879     *
13880     * @return EINA_TRUE if enough history exists to perform the given jump,
13881     * EINA_FALSE otherwise
13882     */
13883    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13884    /**
13885     * Gets whether browsing history is enabled for the given object
13886     *
13887     * @param obj The web object
13888     *
13889     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13890     */
13891    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13892    /**
13893     * Enables or disables the browsing history
13894     *
13895     * @param obj The web object
13896     * @param enable Whether to enable or disable the browsing history
13897     */
13898    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13899    /**
13900     * Sets the zoom level of the web object
13901     *
13902     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13903     * values meaning zoom in and lower meaning zoom out. This function will
13904     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13905     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13906     *
13907     * @param obj The web object
13908     * @param zoom The zoom level to set
13909     */
13910    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13911    /**
13912     * Gets the current zoom level set on the web object
13913     *
13914     * Note that this is the zoom level set on the web object and not that
13915     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13916     * the two zoom levels should match, but for the other two modes the
13917     * Webkit zoom is calculated internally to match the chosen mode without
13918     * changing the zoom level set for the web object.
13919     *
13920     * @param obj The web object
13921     *
13922     * @return The zoom level set on the object
13923     */
13924    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13925    /**
13926     * Sets the zoom mode to use
13927     *
13928     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13929     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13930     *
13931     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13932     * with the elm_web_zoom_set() function.
13933     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13934     * make sure the entirety of the web object's contents are shown.
13935     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13936     * fit the contents in the web object's size, without leaving any space
13937     * unused.
13938     *
13939     * @param obj The web object
13940     * @param mode The mode to set
13941     */
13942    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13943    /**
13944     * Gets the currently set zoom mode
13945     *
13946     * @param obj The web object
13947     *
13948     * @return The current zoom mode set for the object, or
13949     * ::ELM_WEB_ZOOM_MODE_LAST on error
13950     */
13951    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13952    /**
13953     * Shows the given region in the web object
13954     *
13955     * @param obj The web object
13956     * @param x The x coordinate of the region to show
13957     * @param y The y coordinate of the region to show
13958     * @param w The width of the region to show
13959     * @param h The height of the region to show
13960     */
13961    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13962    /**
13963     * Brings in the region to the visible area
13964     *
13965     * Like elm_web_region_show(), but it animates the scrolling of the object
13966     * to show the area
13967     *
13968     * @param obj The web object
13969     * @param x The x coordinate of the region to show
13970     * @param y The y coordinate of the region to show
13971     * @param w The width of the region to show
13972     * @param h The height of the region to show
13973     */
13974    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13975    /**
13976     * Sets the default dialogs to use an Inwin instead of a normal window
13977     *
13978     * If set, then the default implementation for the JavaScript dialogs and
13979     * file selector will be opened in an Inwin. Otherwise they will use a
13980     * normal separated window.
13981     *
13982     * @param obj The web object
13983     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13984     */
13985    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13986    /**
13987     * Gets whether Inwin mode is set for the current object
13988     *
13989     * @param obj The web object
13990     *
13991     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13992     */
13993    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13994
13995    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13996    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13997    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);
13998    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13999
14000    /**
14001     * @}
14002     */
14003
14004    /**
14005     * @defgroup Hoversel Hoversel
14006     *
14007     * @image html img/widget/hoversel/preview-00.png
14008     * @image latex img/widget/hoversel/preview-00.eps
14009     *
14010     * A hoversel is a button that pops up a list of items (automatically
14011     * choosing the direction to display) that have a label and, optionally, an
14012     * icon to select from. It is a convenience widget to avoid the need to do
14013     * all the piecing together yourself. It is intended for a small number of
14014     * items in the hoversel menu (no more than 8), though is capable of many
14015     * more.
14016     *
14017     * Signals that you can add callbacks for are:
14018     * "clicked" - the user clicked the hoversel button and popped up the sel
14019     * "selected" - an item in the hoversel list is selected. event_info is the item
14020     * "dismissed" - the hover is dismissed
14021     *
14022     * See @ref tutorial_hoversel for an example.
14023     * @{
14024     */
14025    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14026    /**
14027     * @brief Add a new Hoversel object
14028     *
14029     * @param parent The parent object
14030     * @return The new object or NULL if it cannot be created
14031     */
14032    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14033    /**
14034     * @brief This sets the hoversel to expand horizontally.
14035     *
14036     * @param obj The hoversel object
14037     * @param horizontal If true, the hover will expand horizontally to the
14038     * right.
14039     *
14040     * @note The initial button will display horizontally regardless of this
14041     * setting.
14042     */
14043    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14044    /**
14045     * @brief This returns whether the hoversel is set to expand horizontally.
14046     *
14047     * @param obj The hoversel object
14048     * @return If true, the hover will expand horizontally to the right.
14049     *
14050     * @see elm_hoversel_horizontal_set()
14051     */
14052    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14053    /**
14054     * @brief Set the Hover parent
14055     *
14056     * @param obj The hoversel object
14057     * @param parent The parent to use
14058     *
14059     * Sets the hover parent object, the area that will be darkened when the
14060     * hoversel is clicked. Should probably be the window that the hoversel is
14061     * in. See @ref Hover objects for more information.
14062     */
14063    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14064    /**
14065     * @brief Get the Hover parent
14066     *
14067     * @param obj The hoversel object
14068     * @return The used parent
14069     *
14070     * Gets the hover parent object.
14071     *
14072     * @see elm_hoversel_hover_parent_set()
14073     */
14074    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14075    /**
14076     * @brief Set the hoversel button label
14077     *
14078     * @param obj The hoversel object
14079     * @param label The label text.
14080     *
14081     * This sets the label of the button that is always visible (before it is
14082     * clicked and expanded).
14083     *
14084     * @deprecated elm_object_text_set()
14085     */
14086    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14087    /**
14088     * @brief Get the hoversel button label
14089     *
14090     * @param obj The hoversel object
14091     * @return The label text.
14092     *
14093     * @deprecated elm_object_text_get()
14094     */
14095    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14096    /**
14097     * @brief Set the icon of the hoversel button
14098     *
14099     * @param obj The hoversel object
14100     * @param icon The icon object
14101     *
14102     * Sets the icon of the button that is always visible (before it is clicked
14103     * and expanded).  Once the icon object is set, a previously set one will be
14104     * deleted, if you want to keep that old content object, use the
14105     * elm_hoversel_icon_unset() function.
14106     *
14107     * @see elm_object_content_set() for the button widget
14108     */
14109    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14110    /**
14111     * @brief Get the icon of the hoversel button
14112     *
14113     * @param obj The hoversel object
14114     * @return The icon object
14115     *
14116     * Get the icon of the button that is always visible (before it is clicked
14117     * and expanded). Also see elm_object_content_get() for the button widget.
14118     *
14119     * @see elm_hoversel_icon_set()
14120     */
14121    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14122    /**
14123     * @brief Get and unparent the icon of the hoversel button
14124     *
14125     * @param obj The hoversel object
14126     * @return The icon object that was being used
14127     *
14128     * Unparent and return the icon of the button that is always visible
14129     * (before it is clicked and expanded).
14130     *
14131     * @see elm_hoversel_icon_set()
14132     * @see elm_object_content_unset() for the button widget
14133     */
14134    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14135    /**
14136     * @brief This triggers the hoversel popup from code, the same as if the user
14137     * had clicked the button.
14138     *
14139     * @param obj The hoversel object
14140     */
14141    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14142    /**
14143     * @brief This dismisses the hoversel popup as if the user had clicked
14144     * outside the hover.
14145     *
14146     * @param obj The hoversel object
14147     */
14148    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14149    /**
14150     * @brief Returns whether the hoversel is expanded.
14151     *
14152     * @param obj The hoversel object
14153     * @return  This will return EINA_TRUE if the hoversel is expanded or
14154     * EINA_FALSE if it is not expanded.
14155     */
14156    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14157    /**
14158     * @brief This will remove all the children items from the hoversel.
14159     *
14160     * @param obj The hoversel object
14161     *
14162     * @warning Should @b not be called while the hoversel is active; use
14163     * elm_hoversel_expanded_get() to check first.
14164     *
14165     * @see elm_hoversel_item_del_cb_set()
14166     * @see elm_hoversel_item_del()
14167     */
14168    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14169    /**
14170     * @brief Get the list of items within the given hoversel.
14171     *
14172     * @param obj The hoversel object
14173     * @return Returns a list of Elm_Hoversel_Item*
14174     *
14175     * @see elm_hoversel_item_add()
14176     */
14177    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14178    /**
14179     * @brief Add an item to the hoversel button
14180     *
14181     * @param obj The hoversel object
14182     * @param label The text label to use for the item (NULL if not desired)
14183     * @param icon_file An image file path on disk to use for the icon or standard
14184     * icon name (NULL if not desired)
14185     * @param icon_type The icon type if relevant
14186     * @param func Convenience function to call when this item is selected
14187     * @param data Data to pass to item-related functions
14188     * @return A handle to the item added.
14189     *
14190     * This adds an item to the hoversel to show when it is clicked. Note: if you
14191     * need to use an icon from an edje file then use
14192     * elm_hoversel_item_icon_set() right after the this function, and set
14193     * icon_file to NULL here.
14194     *
14195     * For more information on what @p icon_file and @p icon_type are see the
14196     * @ref Icon "icon documentation".
14197     */
14198    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);
14199    /**
14200     * @brief Delete an item from the hoversel
14201     *
14202     * @param item The item to delete
14203     *
14204     * This deletes the item from the hoversel (should not be called while the
14205     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14206     *
14207     * @see elm_hoversel_item_add()
14208     * @see elm_hoversel_item_del_cb_set()
14209     */
14210    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14211    /**
14212     * @brief Set the function to be called when an item from the hoversel is
14213     * freed.
14214     *
14215     * @param item The item to set the callback on
14216     * @param func The function called
14217     *
14218     * That function will receive these parameters:
14219     * @li void *item_data
14220     * @li Evas_Object *the_item_object
14221     * @li Elm_Hoversel_Item *the_object_struct
14222     *
14223     * @see elm_hoversel_item_add()
14224     */
14225    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14226    /**
14227     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14228     * that will be passed to associated function callbacks.
14229     *
14230     * @param item The item to get the data from
14231     * @return The data pointer set with elm_hoversel_item_add()
14232     *
14233     * @see elm_hoversel_item_add()
14234     */
14235    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14236    /**
14237     * @brief This returns the label text of the given hoversel item.
14238     *
14239     * @param item The item to get the label
14240     * @return The label text of the hoversel item
14241     *
14242     * @see elm_hoversel_item_add()
14243     */
14244    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14245    /**
14246     * @brief This sets the icon for the given hoversel item.
14247     *
14248     * @param item The item to set the icon
14249     * @param icon_file An image file path on disk to use for the icon or standard
14250     * icon name
14251     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14252     * to NULL if the icon is not an edje file
14253     * @param icon_type The icon type
14254     *
14255     * The icon can be loaded from the standard set, from an image file, or from
14256     * an edje file.
14257     *
14258     * @see elm_hoversel_item_add()
14259     */
14260    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);
14261    /**
14262     * @brief Get the icon object of the hoversel item
14263     *
14264     * @param item The item to get the icon from
14265     * @param icon_file The image file path on disk used for the icon or standard
14266     * icon name
14267     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14268     * if the icon is not an edje file
14269     * @param icon_type The icon type
14270     *
14271     * @see elm_hoversel_item_icon_set()
14272     * @see elm_hoversel_item_add()
14273     */
14274    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);
14275    /**
14276     * @}
14277     */
14278
14279    /**
14280     * @defgroup Toolbar Toolbar
14281     * @ingroup Elementary
14282     *
14283     * @image html img/widget/toolbar/preview-00.png
14284     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14285     *
14286     * @image html img/toolbar.png
14287     * @image latex img/toolbar.eps width=\textwidth
14288     *
14289     * A toolbar is a widget that displays a list of items inside
14290     * a box. It can be scrollable, show a menu with items that don't fit
14291     * to toolbar size or even crop them.
14292     *
14293     * Only one item can be selected at a time.
14294     *
14295     * Items can have multiple states, or show menus when selected by the user.
14296     *
14297     * Smart callbacks one can listen to:
14298     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14299     * - "language,changed" - when the program language changes
14300     *
14301     * Available styles for it:
14302     * - @c "default"
14303     * - @c "transparent" - no background or shadow, just show the content
14304     *
14305     * List of examples:
14306     * @li @ref toolbar_example_01
14307     * @li @ref toolbar_example_02
14308     * @li @ref toolbar_example_03
14309     */
14310
14311    /**
14312     * @addtogroup Toolbar
14313     * @{
14314     */
14315
14316    /**
14317     * @enum _Elm_Toolbar_Shrink_Mode
14318     * @typedef Elm_Toolbar_Shrink_Mode
14319     *
14320     * Set toolbar's items display behavior, it can be scrollabel,
14321     * show a menu with exceeding items, or simply hide them.
14322     *
14323     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14324     * from elm config.
14325     *
14326     * Values <b> don't </b> work as bitmask, only one can be choosen.
14327     *
14328     * @see elm_toolbar_mode_shrink_set()
14329     * @see elm_toolbar_mode_shrink_get()
14330     *
14331     * @ingroup Toolbar
14332     */
14333    typedef enum _Elm_Toolbar_Shrink_Mode
14334      {
14335         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14336         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14337         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14338         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
14339      } Elm_Toolbar_Shrink_Mode;
14340
14341    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(). */
14342
14343    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(). */
14344
14345    /**
14346     * Add a new toolbar widget to the given parent Elementary
14347     * (container) object.
14348     *
14349     * @param parent The parent object.
14350     * @return a new toolbar widget handle or @c NULL, on errors.
14351     *
14352     * This function inserts a new toolbar widget on the canvas.
14353     *
14354     * @ingroup Toolbar
14355     */
14356    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14357
14358    /**
14359     * Set the icon size, in pixels, to be used by toolbar items.
14360     *
14361     * @param obj The toolbar object
14362     * @param icon_size The icon size in pixels
14363     *
14364     * @note Default value is @c 32. It reads value from elm config.
14365     *
14366     * @see elm_toolbar_icon_size_get()
14367     *
14368     * @ingroup Toolbar
14369     */
14370    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14371
14372    /**
14373     * Get the icon size, in pixels, to be used by toolbar items.
14374     *
14375     * @param obj The toolbar object.
14376     * @return The icon size in pixels.
14377     *
14378     * @see elm_toolbar_icon_size_set() for details.
14379     *
14380     * @ingroup Toolbar
14381     */
14382    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14383
14384    /**
14385     * Sets icon lookup order, for toolbar items' icons.
14386     *
14387     * @param obj The toolbar object.
14388     * @param order The icon lookup order.
14389     *
14390     * Icons added before calling this function will not be affected.
14391     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14392     *
14393     * @see elm_toolbar_icon_order_lookup_get()
14394     *
14395     * @ingroup Toolbar
14396     */
14397    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14398
14399    /**
14400     * Gets the icon lookup order.
14401     *
14402     * @param obj The toolbar object.
14403     * @return The icon lookup order.
14404     *
14405     * @see elm_toolbar_icon_order_lookup_set() for details.
14406     *
14407     * @ingroup Toolbar
14408     */
14409    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14410
14411    /**
14412     * Set whether the toolbar should always have an item selected.
14413     *
14414     * @param obj The toolbar object.
14415     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14416     * disable it.
14417     *
14418     * This will cause the toolbar to always have an item selected, and clicking
14419     * the selected item will not cause a selected event to be emitted. Enabling this mode
14420     * will immediately select the first toolbar item.
14421     *
14422     * Always-selected is disabled by default.
14423     *
14424     * @see elm_toolbar_always_select_mode_get().
14425     *
14426     * @ingroup Toolbar
14427     */
14428    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14429
14430    /**
14431     * Get whether the toolbar should always have an item selected.
14432     *
14433     * @param obj The toolbar object.
14434     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14435     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14436     *
14437     * @see elm_toolbar_always_select_mode_set() for details.
14438     *
14439     * @ingroup Toolbar
14440     */
14441    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14442
14443    /**
14444     * Set whether the toolbar items' should be selected by the user or not.
14445     *
14446     * @param obj The toolbar object.
14447     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14448     * enable it.
14449     *
14450     * This will turn off the ability to select items entirely and they will
14451     * neither appear selected nor emit selected signals. The clicked
14452     * callback function will still be called.
14453     *
14454     * Selection is enabled by default.
14455     *
14456     * @see elm_toolbar_no_select_mode_get().
14457     *
14458     * @ingroup Toolbar
14459     */
14460    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14461
14462    /**
14463     * Set whether the toolbar items' should be selected by the user or not.
14464     *
14465     * @param obj The toolbar object.
14466     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14467     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14468     *
14469     * @see elm_toolbar_no_select_mode_set() for details.
14470     *
14471     * @ingroup Toolbar
14472     */
14473    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14474
14475    /**
14476     * Append item to the toolbar.
14477     *
14478     * @param obj The toolbar object.
14479     * @param icon A string with icon name or the absolute path of an image file.
14480     * @param label The label of the item.
14481     * @param func The function to call when the item is clicked.
14482     * @param data The data to associate with the item for related callbacks.
14483     * @return The created item or @c NULL upon failure.
14484     *
14485     * A new item will be created and appended to the toolbar, i.e., will
14486     * be set as @b last item.
14487     *
14488     * Items created with this method can be deleted with
14489     * elm_toolbar_item_del().
14490     *
14491     * Associated @p data can be properly freed when item is deleted if a
14492     * callback function is set with elm_toolbar_item_del_cb_set().
14493     *
14494     * If a function is passed as argument, it will be called everytime this item
14495     * is selected, i.e., the user clicks over an unselected item.
14496     * If such function isn't needed, just passing
14497     * @c NULL as @p func is enough. The same should be done for @p data.
14498     *
14499     * Toolbar will load icon image from fdo or current theme.
14500     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14501     * If an absolute path is provided it will load it direct from a file.
14502     *
14503     * @see elm_toolbar_item_icon_set()
14504     * @see elm_toolbar_item_del()
14505     * @see elm_toolbar_item_del_cb_set()
14506     *
14507     * @ingroup Toolbar
14508     */
14509    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);
14510
14511    /**
14512     * Prepend item to the toolbar.
14513     *
14514     * @param obj The toolbar object.
14515     * @param icon A string with icon name or the absolute path of an image file.
14516     * @param label The label of the item.
14517     * @param func The function to call when the item is clicked.
14518     * @param data The data to associate with the item for related callbacks.
14519     * @return The created item or @c NULL upon failure.
14520     *
14521     * A new item will be created and prepended to the toolbar, i.e., will
14522     * be set as @b first item.
14523     *
14524     * Items created with this method can be deleted with
14525     * elm_toolbar_item_del().
14526     *
14527     * Associated @p data can be properly freed when item is deleted if a
14528     * callback function is set with elm_toolbar_item_del_cb_set().
14529     *
14530     * If a function is passed as argument, it will be called everytime this item
14531     * is selected, i.e., the user clicks over an unselected item.
14532     * If such function isn't needed, just passing
14533     * @c NULL as @p func is enough. The same should be done for @p data.
14534     *
14535     * Toolbar will load icon image from fdo or current theme.
14536     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14537     * If an absolute path is provided it will load it direct from a file.
14538     *
14539     * @see elm_toolbar_item_icon_set()
14540     * @see elm_toolbar_item_del()
14541     * @see elm_toolbar_item_del_cb_set()
14542     *
14543     * @ingroup Toolbar
14544     */
14545    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);
14546
14547    /**
14548     * Insert a new item into the toolbar object before item @p before.
14549     *
14550     * @param obj The toolbar object.
14551     * @param before The toolbar item to insert before.
14552     * @param icon A string with icon name or the absolute path of an image file.
14553     * @param label The label of the item.
14554     * @param func The function to call when the item is clicked.
14555     * @param data The data to associate with the item for related callbacks.
14556     * @return The created item or @c NULL upon failure.
14557     *
14558     * A new item will be created and added to the toolbar. Its position in
14559     * this toolbar will be just before item @p before.
14560     *
14561     * Items created with this method can be deleted with
14562     * elm_toolbar_item_del().
14563     *
14564     * Associated @p data can be properly freed when item is deleted if a
14565     * callback function is set with elm_toolbar_item_del_cb_set().
14566     *
14567     * If a function is passed as argument, it will be called everytime this item
14568     * is selected, i.e., the user clicks over an unselected item.
14569     * If such function isn't needed, just passing
14570     * @c NULL as @p func is enough. The same should be done for @p data.
14571     *
14572     * Toolbar will load icon image from fdo or current theme.
14573     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14574     * If an absolute path is provided it will load it direct from a file.
14575     *
14576     * @see elm_toolbar_item_icon_set()
14577     * @see elm_toolbar_item_del()
14578     * @see elm_toolbar_item_del_cb_set()
14579     *
14580     * @ingroup Toolbar
14581     */
14582    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);
14583
14584    /**
14585     * Insert a new item into the toolbar object after item @p after.
14586     *
14587     * @param obj The toolbar object.
14588     * @param before The toolbar item to insert before.
14589     * @param icon A string with icon name or the absolute path of an image file.
14590     * @param label The label of the item.
14591     * @param func The function to call when the item is clicked.
14592     * @param data The data to associate with the item for related callbacks.
14593     * @return The created item or @c NULL upon failure.
14594     *
14595     * A new item will be created and added to the toolbar. Its position in
14596     * this toolbar will be just after item @p after.
14597     *
14598     * Items created with this method can be deleted with
14599     * elm_toolbar_item_del().
14600     *
14601     * Associated @p data can be properly freed when item is deleted if a
14602     * callback function is set with elm_toolbar_item_del_cb_set().
14603     *
14604     * If a function is passed as argument, it will be called everytime this item
14605     * is selected, i.e., the user clicks over an unselected item.
14606     * If such function isn't needed, just passing
14607     * @c NULL as @p func is enough. The same should be done for @p data.
14608     *
14609     * Toolbar will load icon image from fdo or current theme.
14610     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14611     * If an absolute path is provided it will load it direct from a file.
14612     *
14613     * @see elm_toolbar_item_icon_set()
14614     * @see elm_toolbar_item_del()
14615     * @see elm_toolbar_item_del_cb_set()
14616     *
14617     * @ingroup Toolbar
14618     */
14619    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);
14620
14621    /**
14622     * Get the first item in the given toolbar widget's list of
14623     * items.
14624     *
14625     * @param obj The toolbar object
14626     * @return The first item or @c NULL, if it has no items (and on
14627     * errors)
14628     *
14629     * @see elm_toolbar_item_append()
14630     * @see elm_toolbar_last_item_get()
14631     *
14632     * @ingroup Toolbar
14633     */
14634    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14635
14636    /**
14637     * Get the last item in the given toolbar widget's list of
14638     * items.
14639     *
14640     * @param obj The toolbar object
14641     * @return The last item or @c NULL, if it has no items (and on
14642     * errors)
14643     *
14644     * @see elm_toolbar_item_prepend()
14645     * @see elm_toolbar_first_item_get()
14646     *
14647     * @ingroup Toolbar
14648     */
14649    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14650
14651    /**
14652     * Get the item after @p item in toolbar.
14653     *
14654     * @param item The toolbar item.
14655     * @return The item after @p item, or @c NULL if none or on failure.
14656     *
14657     * @note If it is the last item, @c NULL will be returned.
14658     *
14659     * @see elm_toolbar_item_append()
14660     *
14661     * @ingroup Toolbar
14662     */
14663    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14664
14665    /**
14666     * Get the item before @p item in toolbar.
14667     *
14668     * @param item The toolbar item.
14669     * @return The item before @p item, or @c NULL if none or on failure.
14670     *
14671     * @note If it is the first item, @c NULL will be returned.
14672     *
14673     * @see elm_toolbar_item_prepend()
14674     *
14675     * @ingroup Toolbar
14676     */
14677    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14678
14679    /**
14680     * Get the toolbar object from an item.
14681     *
14682     * @param item The item.
14683     * @return The toolbar object.
14684     *
14685     * This returns the toolbar object itself that an item belongs to.
14686     *
14687     * @ingroup Toolbar
14688     */
14689    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14690
14691    /**
14692     * Set the priority of a toolbar item.
14693     *
14694     * @param item The toolbar item.
14695     * @param priority The item priority. The default is zero.
14696     *
14697     * This is used only when the toolbar shrink mode is set to
14698     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14699     * When space is less than required, items with low priority
14700     * will be removed from the toolbar and added to a dynamically-created menu,
14701     * while items with higher priority will remain on the toolbar,
14702     * with the same order they were added.
14703     *
14704     * @see elm_toolbar_item_priority_get()
14705     *
14706     * @ingroup Toolbar
14707     */
14708    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14709
14710    /**
14711     * Get the priority of a toolbar item.
14712     *
14713     * @param item The toolbar item.
14714     * @return The @p item priority, or @c 0 on failure.
14715     *
14716     * @see elm_toolbar_item_priority_set() for details.
14717     *
14718     * @ingroup Toolbar
14719     */
14720    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14721
14722    /**
14723     * Get the label of item.
14724     *
14725     * @param item The item of toolbar.
14726     * @return The label of item.
14727     *
14728     * The return value is a pointer to the label associated to @p item when
14729     * it was created, with function elm_toolbar_item_append() or similar,
14730     * or later,
14731     * with function elm_toolbar_item_label_set. If no label
14732     * was passed as argument, it will return @c NULL.
14733     *
14734     * @see elm_toolbar_item_label_set() for more details.
14735     * @see elm_toolbar_item_append()
14736     *
14737     * @ingroup Toolbar
14738     */
14739    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14740
14741    /**
14742     * Set the label of item.
14743     *
14744     * @param item The item of toolbar.
14745     * @param text The label of item.
14746     *
14747     * The label to be displayed by the item.
14748     * Label will be placed at icons bottom (if set).
14749     *
14750     * If a label was passed as argument on item creation, with function
14751     * elm_toolbar_item_append() or similar, it will be already
14752     * displayed by the item.
14753     *
14754     * @see elm_toolbar_item_label_get()
14755     * @see elm_toolbar_item_append()
14756     *
14757     * @ingroup Toolbar
14758     */
14759    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14760
14761    /**
14762     * Return the data associated with a given toolbar widget item.
14763     *
14764     * @param item The toolbar widget item handle.
14765     * @return The data associated with @p item.
14766     *
14767     * @see elm_toolbar_item_data_set()
14768     *
14769     * @ingroup Toolbar
14770     */
14771    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14772
14773    /**
14774     * Set the data associated with a given toolbar widget item.
14775     *
14776     * @param item The toolbar widget item handle.
14777     * @param data The new data pointer to set to @p item.
14778     *
14779     * This sets new item data on @p item.
14780     *
14781     * @warning The old data pointer won't be touched by this function, so
14782     * the user had better to free that old data himself/herself.
14783     *
14784     * @ingroup Toolbar
14785     */
14786    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14787
14788    /**
14789     * Returns a pointer to a toolbar item by its label.
14790     *
14791     * @param obj The toolbar object.
14792     * @param label The label of the item to find.
14793     *
14794     * @return The pointer to the toolbar item matching @p label or @c NULL
14795     * on failure.
14796     *
14797     * @ingroup Toolbar
14798     */
14799    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14800
14801    /*
14802     * Get whether the @p item is selected or not.
14803     *
14804     * @param item The toolbar item.
14805     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14806     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14807     *
14808     * @see elm_toolbar_selected_item_set() for details.
14809     * @see elm_toolbar_item_selected_get()
14810     *
14811     * @ingroup Toolbar
14812     */
14813    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14814
14815    /**
14816     * Set the selected state of an item.
14817     *
14818     * @param item The toolbar item
14819     * @param selected The selected state
14820     *
14821     * This sets the selected state of the given item @p it.
14822     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14823     *
14824     * If a new item is selected the previosly selected will be unselected.
14825     * Previoulsy selected item can be get with function
14826     * elm_toolbar_selected_item_get().
14827     *
14828     * Selected items will be highlighted.
14829     *
14830     * @see elm_toolbar_item_selected_get()
14831     * @see elm_toolbar_selected_item_get()
14832     *
14833     * @ingroup Toolbar
14834     */
14835    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14836
14837    /**
14838     * Get the selected item.
14839     *
14840     * @param obj The toolbar object.
14841     * @return The selected toolbar item.
14842     *
14843     * The selected item can be unselected with function
14844     * elm_toolbar_item_selected_set().
14845     *
14846     * The selected item always will be highlighted on toolbar.
14847     *
14848     * @see elm_toolbar_selected_items_get()
14849     *
14850     * @ingroup Toolbar
14851     */
14852    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14853
14854    /**
14855     * Set the icon associated with @p item.
14856     *
14857     * @param obj The parent of this item.
14858     * @param item The toolbar item.
14859     * @param icon A string with icon name or the absolute path of an image file.
14860     *
14861     * Toolbar will load icon image from fdo or current theme.
14862     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14863     * If an absolute path is provided it will load it direct from a file.
14864     *
14865     * @see elm_toolbar_icon_order_lookup_set()
14866     * @see elm_toolbar_icon_order_lookup_get()
14867     *
14868     * @ingroup Toolbar
14869     */
14870    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14871
14872    /**
14873     * Get the string used to set the icon of @p item.
14874     *
14875     * @param item The toolbar item.
14876     * @return The string associated with the icon object.
14877     *
14878     * @see elm_toolbar_item_icon_set() for details.
14879     *
14880     * @ingroup Toolbar
14881     */
14882    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14883
14884    /**
14885     * Get the object of @p item.
14886     *
14887     * @param item The toolbar item.
14888     * @return The object
14889     *
14890     * @ingroup Toolbar
14891     */
14892    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14893
14894    /**
14895     * Get the icon object of @p item.
14896     *
14897     * @param item The toolbar item.
14898     * @return The icon object
14899     *
14900     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14901     *
14902     * @ingroup Toolbar
14903     */
14904    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14905
14906    /**
14907     * Set the icon associated with @p item to an image in a binary buffer.
14908     *
14909     * @param item The toolbar item.
14910     * @param img The binary data that will be used as an image
14911     * @param size The size of binary data @p img
14912     * @param format Optional format of @p img to pass to the image loader
14913     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14914     *
14915     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14916     *
14917     * @note The icon image set by this function can be changed by
14918     * elm_toolbar_item_icon_set().
14919     * 
14920     * @ingroup Toolbar
14921     */
14922    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);
14923
14924    /**
14925     * Delete them item from the toolbar.
14926     *
14927     * @param item The item of toolbar to be deleted.
14928     *
14929     * @see elm_toolbar_item_append()
14930     * @see elm_toolbar_item_del_cb_set()
14931     *
14932     * @ingroup Toolbar
14933     */
14934    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14935
14936    /**
14937     * Set the function called when a toolbar item is freed.
14938     *
14939     * @param item The item to set the callback on.
14940     * @param func The function called.
14941     *
14942     * If there is a @p func, then it will be called prior item's memory release.
14943     * That will be called with the following arguments:
14944     * @li item's data;
14945     * @li item's Evas object;
14946     * @li item itself;
14947     *
14948     * This way, a data associated to a toolbar item could be properly freed.
14949     *
14950     * @ingroup Toolbar
14951     */
14952    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14953
14954    /**
14955     * Get a value whether toolbar item is disabled or not.
14956     *
14957     * @param item The item.
14958     * @return The disabled state.
14959     *
14960     * @see elm_toolbar_item_disabled_set() for more details.
14961     *
14962     * @ingroup Toolbar
14963     */
14964    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14965
14966    /**
14967     * Sets the disabled/enabled state of a toolbar item.
14968     *
14969     * @param item The item.
14970     * @param disabled The disabled state.
14971     *
14972     * A disabled item cannot be selected or unselected. It will also
14973     * change its appearance (generally greyed out). This sets the
14974     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14975     * enabled).
14976     *
14977     * @ingroup Toolbar
14978     */
14979    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14980
14981    /**
14982     * Set or unset item as a separator.
14983     *
14984     * @param item The toolbar item.
14985     * @param setting @c EINA_TRUE to set item @p item as separator or
14986     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14987     *
14988     * Items aren't set as separator by default.
14989     *
14990     * If set as separator it will display separator theme, so won't display
14991     * icons or label.
14992     *
14993     * @see elm_toolbar_item_separator_get()
14994     *
14995     * @ingroup Toolbar
14996     */
14997    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14998
14999    /**
15000     * Get a value whether item is a separator or not.
15001     *
15002     * @param item The toolbar item.
15003     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15004     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15005     *
15006     * @see elm_toolbar_item_separator_set() for details.
15007     *
15008     * @ingroup Toolbar
15009     */
15010    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15011
15012    /**
15013     * Set the shrink state of toolbar @p obj.
15014     *
15015     * @param obj The toolbar object.
15016     * @param shrink_mode Toolbar's items display behavior.
15017     *
15018     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15019     * but will enforce a minimun size so all the items will fit, won't scroll
15020     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15021     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15022     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15023     *
15024     * @ingroup Toolbar
15025     */
15026    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15027
15028    /**
15029     * Get the shrink mode of toolbar @p obj.
15030     *
15031     * @param obj The toolbar object.
15032     * @return Toolbar's items display behavior.
15033     *
15034     * @see elm_toolbar_mode_shrink_set() for details.
15035     *
15036     * @ingroup Toolbar
15037     */
15038    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15039
15040    /**
15041     * Enable/disable homogenous mode.
15042     *
15043     * @param obj The toolbar object
15044     * @param homogeneous Assume the items within the toolbar are of the
15045     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15046     *
15047     * This will enable the homogeneous mode where items are of the same size.
15048     * @see elm_toolbar_homogeneous_get()
15049     *
15050     * @ingroup Toolbar
15051     */
15052    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15053
15054    /**
15055     * Get whether the homogenous mode is enabled.
15056     *
15057     * @param obj The toolbar object.
15058     * @return Assume the items within the toolbar are of the same height
15059     * and width (EINA_TRUE = on, EINA_FALSE = off).
15060     *
15061     * @see elm_toolbar_homogeneous_set()
15062     *
15063     * @ingroup Toolbar
15064     */
15065    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15066
15067    /**
15068     * Enable/disable homogenous mode.
15069     *
15070     * @param obj The toolbar object
15071     * @param homogeneous Assume the items within the toolbar are of the
15072     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15073     *
15074     * This will enable the homogeneous mode where items are of the same size.
15075     * @see elm_toolbar_homogeneous_get()
15076     *
15077     * @deprecated use elm_toolbar_homogeneous_set() instead.
15078     *
15079     * @ingroup Toolbar
15080     */
15081    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15082
15083    /**
15084     * Get whether the homogenous mode is enabled.
15085     *
15086     * @param obj The toolbar object.
15087     * @return Assume the items within the toolbar are of the same height
15088     * and width (EINA_TRUE = on, EINA_FALSE = off).
15089     *
15090     * @see elm_toolbar_homogeneous_set()
15091     * @deprecated use elm_toolbar_homogeneous_get() instead.
15092     *
15093     * @ingroup Toolbar
15094     */
15095    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15096
15097    /**
15098     * Set the parent object of the toolbar items' menus.
15099     *
15100     * @param obj The toolbar object.
15101     * @param parent The parent of the menu objects.
15102     *
15103     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15104     *
15105     * For more details about setting the parent for toolbar menus, see
15106     * elm_menu_parent_set().
15107     *
15108     * @see elm_menu_parent_set() for details.
15109     * @see elm_toolbar_item_menu_set() for details.
15110     *
15111     * @ingroup Toolbar
15112     */
15113    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15114
15115    /**
15116     * Get the parent object of the toolbar items' menus.
15117     *
15118     * @param obj The toolbar object.
15119     * @return The parent of the menu objects.
15120     *
15121     * @see elm_toolbar_menu_parent_set() for details.
15122     *
15123     * @ingroup Toolbar
15124     */
15125    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15126
15127    /**
15128     * Set the alignment of the items.
15129     *
15130     * @param obj The toolbar object.
15131     * @param align The new alignment, a float between <tt> 0.0 </tt>
15132     * and <tt> 1.0 </tt>.
15133     *
15134     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15135     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15136     * items.
15137     *
15138     * Centered items by default.
15139     *
15140     * @see elm_toolbar_align_get()
15141     *
15142     * @ingroup Toolbar
15143     */
15144    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15145
15146    /**
15147     * Get the alignment of the items.
15148     *
15149     * @param obj The toolbar object.
15150     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15151     * <tt> 1.0 </tt>.
15152     *
15153     * @see elm_toolbar_align_set() for details.
15154     *
15155     * @ingroup Toolbar
15156     */
15157    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15158
15159    /**
15160     * Set whether the toolbar item opens a menu.
15161     *
15162     * @param item The toolbar item.
15163     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15164     *
15165     * A toolbar item can be set to be a menu, using this function.
15166     *
15167     * Once it is set to be a menu, it can be manipulated through the
15168     * menu-like function elm_toolbar_menu_parent_set() and the other
15169     * elm_menu functions, using the Evas_Object @c menu returned by
15170     * elm_toolbar_item_menu_get().
15171     *
15172     * So, items to be displayed in this item's menu should be added with
15173     * elm_menu_item_add().
15174     *
15175     * The following code exemplifies the most basic usage:
15176     * @code
15177     * tb = elm_toolbar_add(win)
15178     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15179     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15180     * elm_toolbar_menu_parent_set(tb, win);
15181     * menu = elm_toolbar_item_menu_get(item);
15182     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15183     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15184     * NULL);
15185     * @endcode
15186     *
15187     * @see elm_toolbar_item_menu_get()
15188     *
15189     * @ingroup Toolbar
15190     */
15191    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15192
15193    /**
15194     * Get toolbar item's menu.
15195     *
15196     * @param item The toolbar item.
15197     * @return Item's menu object or @c NULL on failure.
15198     *
15199     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15200     * this function will set it.
15201     *
15202     * @see elm_toolbar_item_menu_set() for details.
15203     *
15204     * @ingroup Toolbar
15205     */
15206    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15207
15208    /**
15209     * Add a new state to @p item.
15210     *
15211     * @param item The item.
15212     * @param icon A string with icon name or the absolute path of an image file.
15213     * @param label The label of the new state.
15214     * @param func The function to call when the item is clicked when this
15215     * state is selected.
15216     * @param data The data to associate with the state.
15217     * @return The toolbar item state, or @c NULL upon failure.
15218     *
15219     * Toolbar will load icon image from fdo or current theme.
15220     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15221     * If an absolute path is provided it will load it direct from a file.
15222     *
15223     * States created with this function can be removed with
15224     * elm_toolbar_item_state_del().
15225     *
15226     * @see elm_toolbar_item_state_del()
15227     * @see elm_toolbar_item_state_sel()
15228     * @see elm_toolbar_item_state_get()
15229     *
15230     * @ingroup Toolbar
15231     */
15232    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);
15233
15234    /**
15235     * Delete a previoulsy added state to @p item.
15236     *
15237     * @param item The toolbar item.
15238     * @param state The state to be deleted.
15239     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15240     *
15241     * @see elm_toolbar_item_state_add()
15242     */
15243    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15244
15245    /**
15246     * Set @p state as the current state of @p it.
15247     *
15248     * @param it The item.
15249     * @param state The state to use.
15250     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15251     *
15252     * If @p state is @c NULL, it won't select any state and the default item's
15253     * icon and label will be used. It's the same behaviour than
15254     * elm_toolbar_item_state_unser().
15255     *
15256     * @see elm_toolbar_item_state_unset()
15257     *
15258     * @ingroup Toolbar
15259     */
15260    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15261
15262    /**
15263     * Unset the state of @p it.
15264     *
15265     * @param it The item.
15266     *
15267     * The default icon and label from this item will be displayed.
15268     *
15269     * @see elm_toolbar_item_state_set() for more details.
15270     *
15271     * @ingroup Toolbar
15272     */
15273    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15274
15275    /**
15276     * Get the current state of @p it.
15277     *
15278     * @param item The item.
15279     * @return The selected state or @c NULL if none is selected or on failure.
15280     *
15281     * @see elm_toolbar_item_state_set() for details.
15282     * @see elm_toolbar_item_state_unset()
15283     * @see elm_toolbar_item_state_add()
15284     *
15285     * @ingroup Toolbar
15286     */
15287    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15288
15289    /**
15290     * Get the state after selected state in toolbar's @p item.
15291     *
15292     * @param it The toolbar item to change state.
15293     * @return The state after current state, or @c NULL on failure.
15294     *
15295     * If last state is selected, this function will return first state.
15296     *
15297     * @see elm_toolbar_item_state_set()
15298     * @see elm_toolbar_item_state_add()
15299     *
15300     * @ingroup Toolbar
15301     */
15302    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15303
15304    /**
15305     * Get the state before selected state in toolbar's @p item.
15306     *
15307     * @param it The toolbar item to change state.
15308     * @return The state before current state, or @c NULL on failure.
15309     *
15310     * If first state is selected, this function will return last state.
15311     *
15312     * @see elm_toolbar_item_state_set()
15313     * @see elm_toolbar_item_state_add()
15314     *
15315     * @ingroup Toolbar
15316     */
15317    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15318
15319    /**
15320     * Set the text to be shown in a given toolbar item's tooltips.
15321     *
15322     * @param item Target item.
15323     * @param text The text to set in the content.
15324     *
15325     * Setup the text as tooltip to object. The item can have only one tooltip,
15326     * so any previous tooltip data - set with this function or
15327     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15328     *
15329     * @see elm_object_tooltip_text_set() for more details.
15330     *
15331     * @ingroup Toolbar
15332     */
15333    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15334
15335    /**
15336     * Set the content to be shown in the tooltip item.
15337     *
15338     * Setup the tooltip to item. The item can have only one tooltip,
15339     * so any previous tooltip data is removed. @p func(with @p data) will
15340     * be called every time that need show the tooltip and it should
15341     * return a valid Evas_Object. This object is then managed fully by
15342     * tooltip system and is deleted when the tooltip is gone.
15343     *
15344     * @param item the toolbar item being attached a tooltip.
15345     * @param func the function used to create the tooltip contents.
15346     * @param data what to provide to @a func as callback data/context.
15347     * @param del_cb called when data is not needed anymore, either when
15348     *        another callback replaces @a func, the tooltip is unset with
15349     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15350     *        dies. This callback receives as the first parameter the
15351     *        given @a data, and @c event_info is the item.
15352     *
15353     * @see elm_object_tooltip_content_cb_set() for more details.
15354     *
15355     * @ingroup Toolbar
15356     */
15357    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);
15358
15359    /**
15360     * Unset tooltip from item.
15361     *
15362     * @param item toolbar item to remove previously set tooltip.
15363     *
15364     * Remove tooltip from item. The callback provided as del_cb to
15365     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15366     * it is not used anymore.
15367     *
15368     * @see elm_object_tooltip_unset() for more details.
15369     * @see elm_toolbar_item_tooltip_content_cb_set()
15370     *
15371     * @ingroup Toolbar
15372     */
15373    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15374
15375    /**
15376     * Sets a different style for this item tooltip.
15377     *
15378     * @note before you set a style you should define a tooltip with
15379     *       elm_toolbar_item_tooltip_content_cb_set() or
15380     *       elm_toolbar_item_tooltip_text_set()
15381     *
15382     * @param item toolbar item with tooltip already set.
15383     * @param style the theme style to use (default, transparent, ...)
15384     *
15385     * @see elm_object_tooltip_style_set() for more details.
15386     *
15387     * @ingroup Toolbar
15388     */
15389    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15390
15391    /**
15392     * Get the style for this item tooltip.
15393     *
15394     * @param item toolbar item with tooltip already set.
15395     * @return style the theme style in use, defaults to "default". If the
15396     *         object does not have a tooltip set, then NULL is returned.
15397     *
15398     * @see elm_object_tooltip_style_get() for more details.
15399     * @see elm_toolbar_item_tooltip_style_set()
15400     *
15401     * @ingroup Toolbar
15402     */
15403    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15404
15405    /**
15406     * Set the type of mouse pointer/cursor decoration to be shown,
15407     * when the mouse pointer is over the given toolbar widget item
15408     *
15409     * @param item toolbar item to customize cursor on
15410     * @param cursor the cursor type's name
15411     *
15412     * This function works analogously as elm_object_cursor_set(), but
15413     * here the cursor's changing area is restricted to the item's
15414     * area, and not the whole widget's. Note that that item cursors
15415     * have precedence over widget cursors, so that a mouse over an
15416     * item with custom cursor set will always show @b that cursor.
15417     *
15418     * If this function is called twice for an object, a previously set
15419     * cursor will be unset on the second call.
15420     *
15421     * @see elm_object_cursor_set()
15422     * @see elm_toolbar_item_cursor_get()
15423     * @see elm_toolbar_item_cursor_unset()
15424     *
15425     * @ingroup Toolbar
15426     */
15427    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15428
15429    /*
15430     * Get the type of mouse pointer/cursor decoration set to be shown,
15431     * when the mouse pointer is over the given toolbar widget item
15432     *
15433     * @param item toolbar item with custom cursor set
15434     * @return the cursor type's name or @c NULL, if no custom cursors
15435     * were set to @p item (and on errors)
15436     *
15437     * @see elm_object_cursor_get()
15438     * @see elm_toolbar_item_cursor_set()
15439     * @see elm_toolbar_item_cursor_unset()
15440     *
15441     * @ingroup Toolbar
15442     */
15443    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15444
15445    /**
15446     * Unset any custom mouse pointer/cursor decoration set to be
15447     * shown, when the mouse pointer is over the given toolbar widget
15448     * item, thus making it show the @b default cursor again.
15449     *
15450     * @param item a toolbar item
15451     *
15452     * Use this call to undo any custom settings on this item's cursor
15453     * decoration, bringing it back to defaults (no custom style set).
15454     *
15455     * @see elm_object_cursor_unset()
15456     * @see elm_toolbar_item_cursor_set()
15457     *
15458     * @ingroup Toolbar
15459     */
15460    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15461
15462    /**
15463     * Set a different @b style for a given custom cursor set for a
15464     * toolbar item.
15465     *
15466     * @param item toolbar item with custom cursor set
15467     * @param style the <b>theme style</b> to use (e.g. @c "default",
15468     * @c "transparent", etc)
15469     *
15470     * This function only makes sense when one is using custom mouse
15471     * cursor decorations <b>defined in a theme file</b>, which can have,
15472     * given a cursor name/type, <b>alternate styles</b> on it. It
15473     * works analogously as elm_object_cursor_style_set(), but here
15474     * applyed only to toolbar item objects.
15475     *
15476     * @warning Before you set a cursor style you should have definen a
15477     *       custom cursor previously on the item, with
15478     *       elm_toolbar_item_cursor_set()
15479     *
15480     * @see elm_toolbar_item_cursor_engine_only_set()
15481     * @see elm_toolbar_item_cursor_style_get()
15482     *
15483     * @ingroup Toolbar
15484     */
15485    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15486
15487    /**
15488     * Get the current @b style set for a given toolbar item's custom
15489     * cursor
15490     *
15491     * @param item toolbar item with custom cursor set.
15492     * @return style the cursor style in use. If the object does not
15493     *         have a cursor set, then @c NULL is returned.
15494     *
15495     * @see elm_toolbar_item_cursor_style_set() for more details
15496     *
15497     * @ingroup Toolbar
15498     */
15499    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15500
15501    /**
15502     * Set if the (custom)cursor for a given toolbar item should be
15503     * searched in its theme, also, or should only rely on the
15504     * rendering engine.
15505     *
15506     * @param item item with custom (custom) cursor already set on
15507     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15508     * only on those provided by the rendering engine, @c EINA_FALSE to
15509     * have them searched on the widget's theme, as well.
15510     *
15511     * @note This call is of use only if you've set a custom cursor
15512     * for toolbar items, with elm_toolbar_item_cursor_set().
15513     *
15514     * @note By default, cursors will only be looked for between those
15515     * provided by the rendering engine.
15516     *
15517     * @ingroup Toolbar
15518     */
15519    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15520
15521    /**
15522     * Get if the (custom) cursor for a given toolbar item is being
15523     * searched in its theme, also, or is only relying on the rendering
15524     * engine.
15525     *
15526     * @param item a toolbar item
15527     * @return @c EINA_TRUE, if cursors are being looked for only on
15528     * those provided by the rendering engine, @c EINA_FALSE if they
15529     * are being searched on the widget's theme, as well.
15530     *
15531     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15532     *
15533     * @ingroup Toolbar
15534     */
15535    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15536
15537    /**
15538     * Change a toolbar's orientation
15539     * @param obj The toolbar object
15540     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15541     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15542     * @ingroup Toolbar
15543     */
15544    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15545
15546    /**
15547     * Get a toolbar's orientation
15548     * @param obj The toolbar object
15549     * @return If @c EINA_TRUE, the toolbar is vertical
15550     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15551     * @ingroup Toolbar
15552     */
15553    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15554
15555    /**
15556     * @}
15557     */
15558
15559    /**
15560     * @defgroup Tooltips Tooltips
15561     *
15562     * The Tooltip is an (internal, for now) smart object used to show a
15563     * content in a frame on mouse hover of objects(or widgets), with
15564     * tips/information about them.
15565     *
15566     * @{
15567     */
15568
15569    EAPI double       elm_tooltip_delay_get(void);
15570    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15571    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15572    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15573    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15574    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15575 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15576    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);
15577    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15578    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15579    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15580    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15581    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15582
15583    /**
15584     * @}
15585     */
15586
15587    /**
15588     * @defgroup Cursors Cursors
15589     *
15590     * The Elementary cursor is an internal smart object used to
15591     * customize the mouse cursor displayed over objects (or
15592     * widgets). In the most common scenario, the cursor decoration
15593     * comes from the graphical @b engine Elementary is running
15594     * on. Those engines may provide different decorations for cursors,
15595     * and Elementary provides functions to choose them (think of X11
15596     * cursors, as an example).
15597     *
15598     * There's also the possibility of, besides using engine provided
15599     * cursors, also use ones coming from Edje theming files. Both
15600     * globally and per widget, Elementary makes it possible for one to
15601     * make the cursors lookup to be held on engines only or on
15602     * Elementary's theme file, too.
15603     *
15604     * @{
15605     */
15606
15607    /**
15608     * Set the cursor to be shown when mouse is over the object
15609     *
15610     * Set the cursor that will be displayed when mouse is over the
15611     * object. The object can have only one cursor set to it, so if
15612     * this function is called twice for an object, the previous set
15613     * will be unset.
15614     * If using X cursors, a definition of all the valid cursor names
15615     * is listed on Elementary_Cursors.h. If an invalid name is set
15616     * the default cursor will be used.
15617     *
15618     * @param obj the object being set a cursor.
15619     * @param cursor the cursor name to be used.
15620     *
15621     * @ingroup Cursors
15622     */
15623    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15624
15625    /**
15626     * Get the cursor to be shown when mouse is over the object
15627     *
15628     * @param obj an object with cursor already set.
15629     * @return the cursor name.
15630     *
15631     * @ingroup Cursors
15632     */
15633    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15634
15635    /**
15636     * Unset cursor for object
15637     *
15638     * Unset cursor for object, and set the cursor to default if the mouse
15639     * was over this object.
15640     *
15641     * @param obj Target object
15642     * @see elm_object_cursor_set()
15643     *
15644     * @ingroup Cursors
15645     */
15646    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15647
15648    /**
15649     * Sets a different style for this object cursor.
15650     *
15651     * @note before you set a style you should define a cursor with
15652     *       elm_object_cursor_set()
15653     *
15654     * @param obj an object with cursor already set.
15655     * @param style the theme style to use (default, transparent, ...)
15656     *
15657     * @ingroup Cursors
15658     */
15659    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15660
15661    /**
15662     * Get the style for this object cursor.
15663     *
15664     * @param obj an object with cursor already set.
15665     * @return style the theme style in use, defaults to "default". If the
15666     *         object does not have a cursor set, then NULL is returned.
15667     *
15668     * @ingroup Cursors
15669     */
15670    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15671
15672    /**
15673     * Set if the cursor set should be searched on the theme or should use
15674     * the provided by the engine, only.
15675     *
15676     * @note before you set if should look on theme you should define a cursor
15677     * with elm_object_cursor_set(). By default it will only look for cursors
15678     * provided by the engine.
15679     *
15680     * @param obj an object with cursor already set.
15681     * @param engine_only boolean to define it cursors should be looked only
15682     * between the provided by the engine or searched on widget's theme as well.
15683     *
15684     * @ingroup Cursors
15685     */
15686    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15687
15688    /**
15689     * Get the cursor engine only usage for this object cursor.
15690     *
15691     * @param obj an object with cursor already set.
15692     * @return engine_only boolean to define it cursors should be
15693     * looked only between the provided by the engine or searched on
15694     * widget's theme as well. If the object does not have a cursor
15695     * set, then EINA_FALSE is returned.
15696     *
15697     * @ingroup Cursors
15698     */
15699    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15700
15701    /**
15702     * Get the configured cursor engine only usage
15703     *
15704     * This gets the globally configured exclusive usage of engine cursors.
15705     *
15706     * @return 1 if only engine cursors should be used
15707     * @ingroup Cursors
15708     */
15709    EAPI int          elm_cursor_engine_only_get(void);
15710
15711    /**
15712     * Set the configured cursor engine only usage
15713     *
15714     * This sets the globally configured exclusive usage of engine cursors.
15715     * It won't affect cursors set before changing this value.
15716     *
15717     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15718     * look for them on theme before.
15719     * @return EINA_TRUE if value is valid and setted (0 or 1)
15720     * @ingroup Cursors
15721     */
15722    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15723
15724    /**
15725     * @}
15726     */
15727
15728    /**
15729     * @defgroup Menu Menu
15730     *
15731     * @image html img/widget/menu/preview-00.png
15732     * @image latex img/widget/menu/preview-00.eps
15733     *
15734     * A menu is a list of items displayed above its parent. When the menu is
15735     * showing its parent is darkened. Each item can have a sub-menu. The menu
15736     * object can be used to display a menu on a right click event, in a toolbar,
15737     * anywhere.
15738     *
15739     * Signals that you can add callbacks for are:
15740     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15741     *             event_info is NULL.
15742     *
15743     * @see @ref tutorial_menu
15744     * @{
15745     */
15746    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15747    /**
15748     * @brief Add a new menu to the parent
15749     *
15750     * @param parent The parent object.
15751     * @return The new object or NULL if it cannot be created.
15752     */
15753    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15754    /**
15755     * @brief Set the parent for the given menu widget
15756     *
15757     * @param obj The menu object.
15758     * @param parent The new parent.
15759     */
15760    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15761    /**
15762     * @brief Get the parent for the given menu widget
15763     *
15764     * @param obj The menu object.
15765     * @return The parent.
15766     *
15767     * @see elm_menu_parent_set()
15768     */
15769    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15770    /**
15771     * @brief Move the menu to a new position
15772     *
15773     * @param obj The menu object.
15774     * @param x The new position.
15775     * @param y The new position.
15776     *
15777     * Sets the top-left position of the menu to (@p x,@p y).
15778     *
15779     * @note @p x and @p y coordinates are relative to parent.
15780     */
15781    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15782    /**
15783     * @brief Close a opened menu
15784     *
15785     * @param obj the menu object
15786     * @return void
15787     *
15788     * Hides the menu and all it's sub-menus.
15789     */
15790    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15791    /**
15792     * @brief Returns a list of @p item's items.
15793     *
15794     * @param obj The menu object
15795     * @return An Eina_List* of @p item's items
15796     */
15797    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15798    /**
15799     * @brief Get the Evas_Object of an Elm_Menu_Item
15800     *
15801     * @param item The menu item object.
15802     * @return The edje object containing the swallowed content
15803     *
15804     * @warning Don't manipulate this object!
15805     */
15806    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15807    /**
15808     * @brief Add an item at the end of the given menu widget
15809     *
15810     * @param obj The menu object.
15811     * @param parent The parent menu item (optional)
15812     * @param icon A icon display on the item. The icon will be destryed by the menu.
15813     * @param label The label of the item.
15814     * @param func Function called when the user select the item.
15815     * @param data Data sent by the callback.
15816     * @return Returns the new item.
15817     */
15818    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);
15819    /**
15820     * @brief Add an object swallowed in an item at the end of the given menu
15821     * widget
15822     *
15823     * @param obj The menu object.
15824     * @param parent The parent menu item (optional)
15825     * @param subobj The object to swallow
15826     * @param func Function called when the user select the item.
15827     * @param data Data sent by the callback.
15828     * @return Returns the new item.
15829     *
15830     * Add an evas object as an item to the menu.
15831     */
15832    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);
15833    /**
15834     * @brief Set the label of a menu item
15835     *
15836     * @param item The menu item object.
15837     * @param label The label to set for @p item
15838     *
15839     * @warning Don't use this funcion on items created with
15840     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15841     */
15842    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15843    /**
15844     * @brief Get the label of a menu item
15845     *
15846     * @param item The menu item object.
15847     * @return The label of @p item
15848     */
15849    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15850    /**
15851     * @brief Set the icon of a menu item to the standard icon with name @p icon
15852     *
15853     * @param item The menu item object.
15854     * @param icon The icon object to set for the content of @p item
15855     *
15856     * Once this icon is set, any previously set icon will be deleted.
15857     */
15858    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15859    /**
15860     * @brief Get the string representation from the icon of a menu item
15861     *
15862     * @param item The menu item object.
15863     * @return The string representation of @p item's icon or NULL
15864     *
15865     * @see elm_menu_item_object_icon_name_set()
15866     */
15867    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15868    /**
15869     * @brief Set the content object of a menu item
15870     *
15871     * @param item The menu item object
15872     * @param The content object or NULL
15873     * @return EINA_TRUE on success, else EINA_FALSE
15874     *
15875     * Use this function to change the object swallowed by a menu item, deleting
15876     * any previously swallowed object.
15877     */
15878    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15879    /**
15880     * @brief Get the content object of a menu item
15881     *
15882     * @param item The menu item object
15883     * @return The content object or NULL
15884     * @note If @p item was added with elm_menu_item_add_object, this
15885     * function will return the object passed, else it will return the
15886     * icon object.
15887     *
15888     * @see elm_menu_item_object_content_set()
15889     */
15890    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15891    /**
15892     * @brief Set the selected state of @p item.
15893     *
15894     * @param item The menu item object.
15895     * @param selected The selected/unselected state of the item
15896     */
15897    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15898    /**
15899     * @brief Get the selected state of @p item.
15900     *
15901     * @param item The menu item object.
15902     * @return The selected/unselected state of the item
15903     *
15904     * @see elm_menu_item_selected_set()
15905     */
15906    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15907    /**
15908     * @brief Set the disabled state of @p item.
15909     *
15910     * @param item The menu item object.
15911     * @param disabled The enabled/disabled state of the item
15912     */
15913    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15914    /**
15915     * @brief Get the disabled state of @p item.
15916     *
15917     * @param item The menu item object.
15918     * @return The enabled/disabled state of the item
15919     *
15920     * @see elm_menu_item_disabled_set()
15921     */
15922    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15923    /**
15924     * @brief Add a separator item to menu @p obj under @p parent.
15925     *
15926     * @param obj The menu object
15927     * @param parent The item to add the separator under
15928     * @return The created item or NULL on failure
15929     *
15930     * This is item is a @ref Separator.
15931     */
15932    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15933    /**
15934     * @brief Returns whether @p item is a separator.
15935     *
15936     * @param item The item to check
15937     * @return If true, @p item is a separator
15938     *
15939     * @see elm_menu_item_separator_add()
15940     */
15941    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15942    /**
15943     * @brief Deletes an item from the menu.
15944     *
15945     * @param item The item to delete.
15946     *
15947     * @see elm_menu_item_add()
15948     */
15949    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15950    /**
15951     * @brief Set the function called when a menu item is deleted.
15952     *
15953     * @param item The item to set the callback on
15954     * @param func The function called
15955     *
15956     * @see elm_menu_item_add()
15957     * @see elm_menu_item_del()
15958     */
15959    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15960    /**
15961     * @brief Returns the data associated with menu item @p item.
15962     *
15963     * @param item The item
15964     * @return The data associated with @p item or NULL if none was set.
15965     *
15966     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15967     */
15968    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15969    /**
15970     * @brief Sets the data to be associated with menu item @p item.
15971     *
15972     * @param item The item
15973     * @param data The data to be associated with @p item
15974     */
15975    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15976    /**
15977     * @brief Returns a list of @p item's subitems.
15978     *
15979     * @param item The item
15980     * @return An Eina_List* of @p item's subitems
15981     *
15982     * @see elm_menu_add()
15983     */
15984    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15985    /**
15986     * @brief Get the position of a menu item
15987     *
15988     * @param item The menu item
15989     * @return The item's index
15990     *
15991     * This function returns the index position of a menu item in a menu.
15992     * For a sub-menu, this number is relative to the first item in the sub-menu.
15993     *
15994     * @note Index values begin with 0
15995     */
15996    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15997    /**
15998     * @brief @brief Return a menu item's owner menu
15999     *
16000     * @param item The menu item
16001     * @return The menu object owning @p item, or NULL on failure
16002     *
16003     * Use this function to get the menu object owning an item.
16004     */
16005    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16006    /**
16007     * @brief Get the selected item in the menu
16008     *
16009     * @param obj The menu object
16010     * @return The selected item, or NULL if none
16011     *
16012     * @see elm_menu_item_selected_get()
16013     * @see elm_menu_item_selected_set()
16014     */
16015    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16016    /**
16017     * @brief Get the last item in the menu
16018     *
16019     * @param obj The menu object
16020     * @return The last item, or NULL if none
16021     */
16022    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16023    /**
16024     * @brief Get the first item in the menu
16025     *
16026     * @param obj The menu object
16027     * @return The first item, or NULL if none
16028     */
16029    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16030    /**
16031     * @brief Get the next item in the menu.
16032     *
16033     * @param item The menu item object.
16034     * @return The item after it, or NULL if none
16035     */
16036    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16037    /**
16038     * @brief Get the previous item in the menu.
16039     *
16040     * @param item The menu item object.
16041     * @return The item before it, or NULL if none
16042     */
16043    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16044    /**
16045     * @}
16046     */
16047
16048    /**
16049     * @defgroup List List
16050     * @ingroup Elementary
16051     *
16052     * @image html img/widget/list/preview-00.png
16053     * @image latex img/widget/list/preview-00.eps width=\textwidth
16054     *
16055     * @image html img/list.png
16056     * @image latex img/list.eps width=\textwidth
16057     *
16058     * A list widget is a container whose children are displayed vertically or
16059     * horizontally, in order, and can be selected.
16060     * The list can accept only one or multiple items selection. Also has many
16061     * modes of items displaying.
16062     *
16063     * A list is a very simple type of list widget.  For more robust
16064     * lists, @ref Genlist should probably be used.
16065     *
16066     * Smart callbacks one can listen to:
16067     * - @c "activated" - The user has double-clicked or pressed
16068     *   (enter|return|spacebar) on an item. The @c event_info parameter
16069     *   is the item that was activated.
16070     * - @c "clicked,double" - The user has double-clicked an item.
16071     *   The @c event_info parameter is the item that was double-clicked.
16072     * - "selected" - when the user selected an item
16073     * - "unselected" - when the user unselected an item
16074     * - "longpressed" - an item in the list is long-pressed
16075     * - "edge,top" - the list is scrolled until the top edge
16076     * - "edge,bottom" - the list is scrolled until the bottom edge
16077     * - "edge,left" - the list is scrolled until the left edge
16078     * - "edge,right" - the list is scrolled until the right edge
16079     * - "language,changed" - the program's language changed
16080     *
16081     * Available styles for it:
16082     * - @c "default"
16083     *
16084     * List of examples:
16085     * @li @ref list_example_01
16086     * @li @ref list_example_02
16087     * @li @ref list_example_03
16088     */
16089
16090    /**
16091     * @addtogroup List
16092     * @{
16093     */
16094
16095    /**
16096     * @enum _Elm_List_Mode
16097     * @typedef Elm_List_Mode
16098     *
16099     * Set list's resize behavior, transverse axis scroll and
16100     * items cropping. See each mode's description for more details.
16101     *
16102     * @note Default value is #ELM_LIST_SCROLL.
16103     *
16104     * Values <b> don't </b> work as bitmask, only one can be choosen.
16105     *
16106     * @see elm_list_mode_set()
16107     * @see elm_list_mode_get()
16108     *
16109     * @ingroup List
16110     */
16111    typedef enum _Elm_List_Mode
16112      {
16113         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. */
16114         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). */
16115         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. */
16116         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. */
16117         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16118      } Elm_List_Mode;
16119
16120    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().  */
16121
16122    /**
16123     * Add a new list widget to the given parent Elementary
16124     * (container) object.
16125     *
16126     * @param parent The parent object.
16127     * @return a new list widget handle or @c NULL, on errors.
16128     *
16129     * This function inserts a new list widget on the canvas.
16130     *
16131     * @ingroup List
16132     */
16133    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16134
16135    /**
16136     * Starts the list.
16137     *
16138     * @param obj The list object
16139     *
16140     * @note Call before running show() on the list object.
16141     * @warning If not called, it won't display the list properly.
16142     *
16143     * @code
16144     * li = elm_list_add(win);
16145     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16146     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16147     * elm_list_go(li);
16148     * evas_object_show(li);
16149     * @endcode
16150     *
16151     * @ingroup List
16152     */
16153    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16154
16155    /**
16156     * Enable or disable multiple items selection on the list object.
16157     *
16158     * @param obj The list object
16159     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16160     * disable it.
16161     *
16162     * Disabled by default. If disabled, the user can select a single item of
16163     * the list each time. Selected items are highlighted on list.
16164     * If enabled, many items can be selected.
16165     *
16166     * If a selected item is selected again, it will be unselected.
16167     *
16168     * @see elm_list_multi_select_get()
16169     *
16170     * @ingroup List
16171     */
16172    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16173
16174    /**
16175     * Get a value whether multiple items selection is enabled or not.
16176     *
16177     * @see elm_list_multi_select_set() for details.
16178     *
16179     * @param obj The list object.
16180     * @return @c EINA_TRUE means multiple items selection is enabled.
16181     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16182     * @c EINA_FALSE is returned.
16183     *
16184     * @ingroup List
16185     */
16186    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16187
16188    /**
16189     * Set which mode to use for the list object.
16190     *
16191     * @param obj The list object
16192     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16193     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16194     *
16195     * Set list's resize behavior, transverse axis scroll and
16196     * items cropping. See each mode's description for more details.
16197     *
16198     * @note Default value is #ELM_LIST_SCROLL.
16199     *
16200     * Only one can be set, if a previous one was set, it will be changed
16201     * by the new mode set. Bitmask won't work as well.
16202     *
16203     * @see elm_list_mode_get()
16204     *
16205     * @ingroup List
16206     */
16207    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16208
16209    /**
16210     * Get the mode the list is at.
16211     *
16212     * @param obj The list object
16213     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16214     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16215     *
16216     * @note see elm_list_mode_set() for more information.
16217     *
16218     * @ingroup List
16219     */
16220    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16221
16222    /**
16223     * Enable or disable horizontal mode on the list object.
16224     *
16225     * @param obj The list object.
16226     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16227     * disable it, i.e., to enable vertical mode.
16228     *
16229     * @note Vertical mode is set by default.
16230     *
16231     * On horizontal mode items are displayed on list from left to right,
16232     * instead of from top to bottom. Also, the list will scroll horizontally.
16233     * Each item will presents left icon on top and right icon, or end, at
16234     * the bottom.
16235     *
16236     * @see elm_list_horizontal_get()
16237     *
16238     * @ingroup List
16239     */
16240    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16241
16242    /**
16243     * Get a value whether horizontal mode is enabled or not.
16244     *
16245     * @param obj The list object.
16246     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16247     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16248     * @c EINA_FALSE is returned.
16249     *
16250     * @see elm_list_horizontal_set() for details.
16251     *
16252     * @ingroup List
16253     */
16254    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16255
16256    /**
16257     * Enable or disable always select mode on the list object.
16258     *
16259     * @param obj The list object
16260     * @param always_select @c EINA_TRUE to enable always select mode or
16261     * @c EINA_FALSE to disable it.
16262     *
16263     * @note Always select mode is disabled by default.
16264     *
16265     * Default behavior of list items is to only call its callback function
16266     * the first time it's pressed, i.e., when it is selected. If a selected
16267     * item is pressed again, and multi-select is disabled, it won't call
16268     * this function (if multi-select is enabled it will unselect the item).
16269     *
16270     * If always select is enabled, it will call the callback function
16271     * everytime a item is pressed, so it will call when the item is selected,
16272     * and again when a selected item is pressed.
16273     *
16274     * @see elm_list_always_select_mode_get()
16275     * @see elm_list_multi_select_set()
16276     *
16277     * @ingroup List
16278     */
16279    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16280
16281    /**
16282     * Get a value whether always select mode is enabled or not, meaning that
16283     * an item will always call its callback function, even if already selected.
16284     *
16285     * @param obj The list object
16286     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16287     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16288     * @c EINA_FALSE is returned.
16289     *
16290     * @see elm_list_always_select_mode_set() for details.
16291     *
16292     * @ingroup List
16293     */
16294    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16295
16296    /**
16297     * Set bouncing behaviour when the scrolled content reaches an edge.
16298     *
16299     * Tell the internal scroller object whether it should bounce or not
16300     * when it reaches the respective edges for each axis.
16301     *
16302     * @param obj The list object
16303     * @param h_bounce Whether to bounce or not in the horizontal axis.
16304     * @param v_bounce Whether to bounce or not in the vertical axis.
16305     *
16306     * @see elm_scroller_bounce_set()
16307     *
16308     * @ingroup List
16309     */
16310    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16311
16312    /**
16313     * Get the bouncing behaviour of the internal scroller.
16314     *
16315     * Get whether the internal scroller should bounce when the edge of each
16316     * axis is reached scrolling.
16317     *
16318     * @param obj The list object.
16319     * @param h_bounce Pointer where to store the bounce state of the horizontal
16320     * axis.
16321     * @param v_bounce Pointer where to store the bounce state of the vertical
16322     * axis.
16323     *
16324     * @see elm_scroller_bounce_get()
16325     * @see elm_list_bounce_set()
16326     *
16327     * @ingroup List
16328     */
16329    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16330
16331    /**
16332     * Set the scrollbar policy.
16333     *
16334     * @param obj The list object
16335     * @param policy_h Horizontal scrollbar policy.
16336     * @param policy_v Vertical scrollbar policy.
16337     *
16338     * This sets the scrollbar visibility policy for the given scroller.
16339     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16340     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16341     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16342     * This applies respectively for the horizontal and vertical scrollbars.
16343     *
16344     * The both are disabled by default, i.e., are set to
16345     * #ELM_SCROLLER_POLICY_OFF.
16346     *
16347     * @ingroup List
16348     */
16349    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16350
16351    /**
16352     * Get the scrollbar policy.
16353     *
16354     * @see elm_list_scroller_policy_get() for details.
16355     *
16356     * @param obj The list object.
16357     * @param policy_h Pointer where to store horizontal scrollbar policy.
16358     * @param policy_v Pointer where to store vertical scrollbar policy.
16359     *
16360     * @ingroup List
16361     */
16362    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);
16363
16364    /**
16365     * Append a new item to the list object.
16366     *
16367     * @param obj The list object.
16368     * @param label The label of the list item.
16369     * @param icon The icon object to use for the left side of the item. An
16370     * icon can be any Evas object, but usually it is an icon created
16371     * with elm_icon_add().
16372     * @param end The icon object to use for the right side of the item. An
16373     * icon can be any Evas object.
16374     * @param func The function to call when the item is clicked.
16375     * @param data The data to associate with the item for related callbacks.
16376     *
16377     * @return The created item or @c NULL upon failure.
16378     *
16379     * A new item will be created and appended to the list, i.e., will
16380     * be set as @b last item.
16381     *
16382     * Items created with this method can be deleted with
16383     * elm_list_item_del().
16384     *
16385     * Associated @p data can be properly freed when item is deleted if a
16386     * callback function is set with elm_list_item_del_cb_set().
16387     *
16388     * If a function is passed as argument, it will be called everytime this item
16389     * is selected, i.e., the user clicks over an unselected item.
16390     * If always select is enabled it will call this function every time
16391     * user clicks over an item (already selected or not).
16392     * If such function isn't needed, just passing
16393     * @c NULL as @p func is enough. The same should be done for @p data.
16394     *
16395     * Simple example (with no function callback or data associated):
16396     * @code
16397     * li = elm_list_add(win);
16398     * ic = elm_icon_add(win);
16399     * elm_icon_file_set(ic, "path/to/image", NULL);
16400     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16401     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16402     * elm_list_go(li);
16403     * evas_object_show(li);
16404     * @endcode
16405     *
16406     * @see elm_list_always_select_mode_set()
16407     * @see elm_list_item_del()
16408     * @see elm_list_item_del_cb_set()
16409     * @see elm_list_clear()
16410     * @see elm_icon_add()
16411     *
16412     * @ingroup List
16413     */
16414    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);
16415
16416    /**
16417     * Prepend a new item to the list object.
16418     *
16419     * @param obj The list object.
16420     * @param label The label of the list item.
16421     * @param icon The icon object to use for the left side of the item. An
16422     * icon can be any Evas object, but usually it is an icon created
16423     * with elm_icon_add().
16424     * @param end The icon object to use for the right side of the item. An
16425     * icon can be any Evas object.
16426     * @param func The function to call when the item is clicked.
16427     * @param data The data to associate with the item for related callbacks.
16428     *
16429     * @return The created item or @c NULL upon failure.
16430     *
16431     * A new item will be created and prepended to the list, i.e., will
16432     * be set as @b first item.
16433     *
16434     * Items created with this method can be deleted with
16435     * elm_list_item_del().
16436     *
16437     * Associated @p data can be properly freed when item is deleted if a
16438     * callback function is set with elm_list_item_del_cb_set().
16439     *
16440     * If a function is passed as argument, it will be called everytime this item
16441     * is selected, i.e., the user clicks over an unselected item.
16442     * If always select is enabled it will call this function every time
16443     * user clicks over an item (already selected or not).
16444     * If such function isn't needed, just passing
16445     * @c NULL as @p func is enough. The same should be done for @p data.
16446     *
16447     * @see elm_list_item_append() for a simple code example.
16448     * @see elm_list_always_select_mode_set()
16449     * @see elm_list_item_del()
16450     * @see elm_list_item_del_cb_set()
16451     * @see elm_list_clear()
16452     * @see elm_icon_add()
16453     *
16454     * @ingroup List
16455     */
16456    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);
16457
16458    /**
16459     * Insert a new item into the list object before item @p before.
16460     *
16461     * @param obj The list object.
16462     * @param before The list item to insert before.
16463     * @param label The label of the list item.
16464     * @param icon The icon object to use for the left side of the item. An
16465     * icon can be any Evas object, but usually it is an icon created
16466     * with elm_icon_add().
16467     * @param end The icon object to use for the right side of the item. An
16468     * icon can be any Evas object.
16469     * @param func The function to call when the item is clicked.
16470     * @param data The data to associate with the item for related callbacks.
16471     *
16472     * @return The created item or @c NULL upon failure.
16473     *
16474     * A new item will be created and added to the list. Its position in
16475     * this list will be just before item @p before.
16476     *
16477     * Items created with this method can be deleted with
16478     * elm_list_item_del().
16479     *
16480     * Associated @p data can be properly freed when item is deleted if a
16481     * callback function is set with elm_list_item_del_cb_set().
16482     *
16483     * If a function is passed as argument, it will be called everytime this item
16484     * is selected, i.e., the user clicks over an unselected item.
16485     * If always select is enabled it will call this function every time
16486     * user clicks over an item (already selected or not).
16487     * If such function isn't needed, just passing
16488     * @c NULL as @p func is enough. The same should be done for @p data.
16489     *
16490     * @see elm_list_item_append() for a simple code example.
16491     * @see elm_list_always_select_mode_set()
16492     * @see elm_list_item_del()
16493     * @see elm_list_item_del_cb_set()
16494     * @see elm_list_clear()
16495     * @see elm_icon_add()
16496     *
16497     * @ingroup List
16498     */
16499    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);
16500
16501    /**
16502     * Insert a new item into the list object after item @p after.
16503     *
16504     * @param obj The list object.
16505     * @param after The list item to insert after.
16506     * @param label The label of the list item.
16507     * @param icon The icon object to use for the left side of the item. An
16508     * icon can be any Evas object, but usually it is an icon created
16509     * with elm_icon_add().
16510     * @param end The icon object to use for the right side of the item. An
16511     * icon can be any Evas object.
16512     * @param func The function to call when the item is clicked.
16513     * @param data The data to associate with the item for related callbacks.
16514     *
16515     * @return The created item or @c NULL upon failure.
16516     *
16517     * A new item will be created and added to the list. Its position in
16518     * this list will be just after item @p after.
16519     *
16520     * Items created with this method can be deleted with
16521     * elm_list_item_del().
16522     *
16523     * Associated @p data can be properly freed when item is deleted if a
16524     * callback function is set with elm_list_item_del_cb_set().
16525     *
16526     * If a function is passed as argument, it will be called everytime this item
16527     * is selected, i.e., the user clicks over an unselected item.
16528     * If always select is enabled it will call this function every time
16529     * user clicks over an item (already selected or not).
16530     * If such function isn't needed, just passing
16531     * @c NULL as @p func is enough. The same should be done for @p data.
16532     *
16533     * @see elm_list_item_append() for a simple code example.
16534     * @see elm_list_always_select_mode_set()
16535     * @see elm_list_item_del()
16536     * @see elm_list_item_del_cb_set()
16537     * @see elm_list_clear()
16538     * @see elm_icon_add()
16539     *
16540     * @ingroup List
16541     */
16542    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);
16543
16544    /**
16545     * Insert a new item into the sorted list object.
16546     *
16547     * @param obj The list object.
16548     * @param label The label of the list item.
16549     * @param icon The icon object to use for the left side of the item. An
16550     * icon can be any Evas object, but usually it is an icon created
16551     * with elm_icon_add().
16552     * @param end The icon object to use for the right side of the item. An
16553     * icon can be any Evas object.
16554     * @param func The function to call when the item is clicked.
16555     * @param data The data to associate with the item for related callbacks.
16556     * @param cmp_func The comparing function to be used to sort list
16557     * items <b>by #Elm_List_Item item handles</b>. This function will
16558     * receive two items and compare them, returning a non-negative integer
16559     * if the second item should be place after the first, or negative value
16560     * if should be placed before.
16561     *
16562     * @return The created item or @c NULL upon failure.
16563     *
16564     * @note This function inserts values into a list object assuming it was
16565     * sorted and the result will be sorted.
16566     *
16567     * A new item will be created and added to the list. Its position in
16568     * this list will be found comparing the new item with previously inserted
16569     * items using function @p cmp_func.
16570     *
16571     * Items created with this method can be deleted with
16572     * elm_list_item_del().
16573     *
16574     * Associated @p data can be properly freed when item is deleted if a
16575     * callback function is set with elm_list_item_del_cb_set().
16576     *
16577     * If a function is passed as argument, it will be called everytime this item
16578     * is selected, i.e., the user clicks over an unselected item.
16579     * If always select is enabled it will call this function every time
16580     * user clicks over an item (already selected or not).
16581     * If such function isn't needed, just passing
16582     * @c NULL as @p func is enough. The same should be done for @p data.
16583     *
16584     * @see elm_list_item_append() for a simple code example.
16585     * @see elm_list_always_select_mode_set()
16586     * @see elm_list_item_del()
16587     * @see elm_list_item_del_cb_set()
16588     * @see elm_list_clear()
16589     * @see elm_icon_add()
16590     *
16591     * @ingroup List
16592     */
16593    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);
16594
16595    /**
16596     * Remove all list's items.
16597     *
16598     * @param obj The list object
16599     *
16600     * @see elm_list_item_del()
16601     * @see elm_list_item_append()
16602     *
16603     * @ingroup List
16604     */
16605    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16606
16607    /**
16608     * Get a list of all the list items.
16609     *
16610     * @param obj The list object
16611     * @return An @c Eina_List of list items, #Elm_List_Item,
16612     * or @c NULL on failure.
16613     *
16614     * @see elm_list_item_append()
16615     * @see elm_list_item_del()
16616     * @see elm_list_clear()
16617     *
16618     * @ingroup List
16619     */
16620    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16621
16622    /**
16623     * Get the selected item.
16624     *
16625     * @param obj The list object.
16626     * @return The selected list item.
16627     *
16628     * The selected item can be unselected with function
16629     * elm_list_item_selected_set().
16630     *
16631     * The selected item always will be highlighted on list.
16632     *
16633     * @see elm_list_selected_items_get()
16634     *
16635     * @ingroup List
16636     */
16637    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16638
16639    /**
16640     * Return a list of the currently selected list items.
16641     *
16642     * @param obj The list object.
16643     * @return An @c Eina_List of list items, #Elm_List_Item,
16644     * or @c NULL on failure.
16645     *
16646     * Multiple items can be selected if multi select is enabled. It can be
16647     * done with elm_list_multi_select_set().
16648     *
16649     * @see elm_list_selected_item_get()
16650     * @see elm_list_multi_select_set()
16651     *
16652     * @ingroup List
16653     */
16654    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16655
16656    /**
16657     * Set the selected state of an item.
16658     *
16659     * @param item The list item
16660     * @param selected The selected state
16661     *
16662     * This sets the selected state of the given item @p it.
16663     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16664     *
16665     * If a new item is selected the previosly selected will be unselected,
16666     * unless multiple selection is enabled with elm_list_multi_select_set().
16667     * Previoulsy selected item can be get with function
16668     * elm_list_selected_item_get().
16669     *
16670     * Selected items will be highlighted.
16671     *
16672     * @see elm_list_item_selected_get()
16673     * @see elm_list_selected_item_get()
16674     * @see elm_list_multi_select_set()
16675     *
16676     * @ingroup List
16677     */
16678    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16679
16680    /*
16681     * Get whether the @p item is selected or not.
16682     *
16683     * @param item The list item.
16684     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16685     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16686     *
16687     * @see elm_list_selected_item_set() for details.
16688     * @see elm_list_item_selected_get()
16689     *
16690     * @ingroup List
16691     */
16692    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16693
16694    /**
16695     * Set or unset item as a separator.
16696     *
16697     * @param it The list item.
16698     * @param setting @c EINA_TRUE to set item @p it as separator or
16699     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16700     *
16701     * Items aren't set as separator by default.
16702     *
16703     * If set as separator it will display separator theme, so won't display
16704     * icons or label.
16705     *
16706     * @see elm_list_item_separator_get()
16707     *
16708     * @ingroup List
16709     */
16710    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16711
16712    /**
16713     * Get a value whether item is a separator or not.
16714     *
16715     * @see elm_list_item_separator_set() for details.
16716     *
16717     * @param it The list item.
16718     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16719     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16720     *
16721     * @ingroup List
16722     */
16723    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16724
16725    /**
16726     * Show @p item in the list view.
16727     *
16728     * @param item The list item to be shown.
16729     *
16730     * It won't animate list until item is visible. If such behavior is wanted,
16731     * use elm_list_bring_in() intead.
16732     *
16733     * @ingroup List
16734     */
16735    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16736
16737    /**
16738     * Bring in the given item to list view.
16739     *
16740     * @param item The item.
16741     *
16742     * This causes list to jump to the given item @p item and show it
16743     * (by scrolling), if it is not fully visible.
16744     *
16745     * This may use animation to do so and take a period of time.
16746     *
16747     * If animation isn't wanted, elm_list_item_show() can be used.
16748     *
16749     * @ingroup List
16750     */
16751    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16752
16753    /**
16754     * Delete them item from the list.
16755     *
16756     * @param item The item of list to be deleted.
16757     *
16758     * If deleting all list items is required, elm_list_clear()
16759     * should be used instead of getting items list and deleting each one.
16760     *
16761     * @see elm_list_clear()
16762     * @see elm_list_item_append()
16763     * @see elm_list_item_del_cb_set()
16764     *
16765     * @ingroup List
16766     */
16767    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16768
16769    /**
16770     * Set the function called when a list item is freed.
16771     *
16772     * @param item The item to set the callback on
16773     * @param func The function called
16774     *
16775     * If there is a @p func, then it will be called prior item's memory release.
16776     * That will be called with the following arguments:
16777     * @li item's data;
16778     * @li item's Evas object;
16779     * @li item itself;
16780     *
16781     * This way, a data associated to a list item could be properly freed.
16782     *
16783     * @ingroup List
16784     */
16785    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16786
16787    /**
16788     * Get the data associated to the item.
16789     *
16790     * @param item The list item
16791     * @return The data associated to @p item
16792     *
16793     * The return value is a pointer to data associated to @p item when it was
16794     * created, with function elm_list_item_append() or similar. If no data
16795     * was passed as argument, it will return @c NULL.
16796     *
16797     * @see elm_list_item_append()
16798     *
16799     * @ingroup List
16800     */
16801    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16802
16803    /**
16804     * Get the left side icon associated to the item.
16805     *
16806     * @param item The list item
16807     * @return The left side icon associated to @p item
16808     *
16809     * The return value is a pointer to the icon associated to @p item when
16810     * it was
16811     * created, with function elm_list_item_append() or similar, or later
16812     * with function elm_list_item_icon_set(). If no icon
16813     * was passed as argument, it will return @c NULL.
16814     *
16815     * @see elm_list_item_append()
16816     * @see elm_list_item_icon_set()
16817     *
16818     * @ingroup List
16819     */
16820    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16821
16822    /**
16823     * Set the left side icon associated to the item.
16824     *
16825     * @param item The list item
16826     * @param icon The left side icon object to associate with @p item
16827     *
16828     * The icon object to use at left side of the item. An
16829     * icon can be any Evas object, but usually it is an icon created
16830     * with elm_icon_add().
16831     *
16832     * Once the icon object is set, a previously set one will be deleted.
16833     * @warning Setting the same icon for two items will cause the icon to
16834     * dissapear from the first item.
16835     *
16836     * If an icon was passed as argument on item creation, with function
16837     * elm_list_item_append() or similar, it will be already
16838     * associated to the item.
16839     *
16840     * @see elm_list_item_append()
16841     * @see elm_list_item_icon_get()
16842     *
16843     * @ingroup List
16844     */
16845    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16846
16847    /**
16848     * Get the right side icon associated to the item.
16849     *
16850     * @param item The list item
16851     * @return The right side icon associated to @p item
16852     *
16853     * The return value is a pointer to the icon associated to @p item when
16854     * it was
16855     * created, with function elm_list_item_append() or similar, or later
16856     * with function elm_list_item_icon_set(). If no icon
16857     * was passed as argument, it will return @c NULL.
16858     *
16859     * @see elm_list_item_append()
16860     * @see elm_list_item_icon_set()
16861     *
16862     * @ingroup List
16863     */
16864    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16865
16866    /**
16867     * Set the right side icon associated to the item.
16868     *
16869     * @param item The list item
16870     * @param end The right side icon object to associate with @p item
16871     *
16872     * The icon object to use at right side of the item. An
16873     * icon can be any Evas object, but usually it is an icon created
16874     * with elm_icon_add().
16875     *
16876     * Once the icon object is set, a previously set one will be deleted.
16877     * @warning Setting the same icon for two items will cause the icon to
16878     * dissapear from the first item.
16879     *
16880     * If an icon was passed as argument on item creation, with function
16881     * elm_list_item_append() or similar, it will be already
16882     * associated to the item.
16883     *
16884     * @see elm_list_item_append()
16885     * @see elm_list_item_end_get()
16886     *
16887     * @ingroup List
16888     */
16889    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16890
16891    /**
16892     * Gets the base object of the item.
16893     *
16894     * @param item The list item
16895     * @return The base object associated with @p item
16896     *
16897     * Base object is the @c Evas_Object that represents that item.
16898     *
16899     * @ingroup List
16900     */
16901    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16902    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16903
16904    /**
16905     * Get the label of item.
16906     *
16907     * @param item The item of list.
16908     * @return The label of item.
16909     *
16910     * The return value is a pointer to the label associated to @p item when
16911     * it was created, with function elm_list_item_append(), or later
16912     * with function elm_list_item_label_set. If no label
16913     * was passed as argument, it will return @c NULL.
16914     *
16915     * @see elm_list_item_label_set() for more details.
16916     * @see elm_list_item_append()
16917     *
16918     * @ingroup List
16919     */
16920    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16921
16922    /**
16923     * Set the label of item.
16924     *
16925     * @param item The item of list.
16926     * @param text The label of item.
16927     *
16928     * The label to be displayed by the item.
16929     * Label will be placed between left and right side icons (if set).
16930     *
16931     * If a label was passed as argument on item creation, with function
16932     * elm_list_item_append() or similar, it will be already
16933     * displayed by the item.
16934     *
16935     * @see elm_list_item_label_get()
16936     * @see elm_list_item_append()
16937     *
16938     * @ingroup List
16939     */
16940    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16941
16942
16943    /**
16944     * Get the item before @p it in list.
16945     *
16946     * @param it The list item.
16947     * @return The item before @p it, or @c NULL if none or on failure.
16948     *
16949     * @note If it is the first item, @c NULL will be returned.
16950     *
16951     * @see elm_list_item_append()
16952     * @see elm_list_items_get()
16953     *
16954     * @ingroup List
16955     */
16956    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16957
16958    /**
16959     * Get the item after @p it in list.
16960     *
16961     * @param it The list item.
16962     * @return The item after @p it, or @c NULL if none or on failure.
16963     *
16964     * @note If it is the last item, @c NULL will be returned.
16965     *
16966     * @see elm_list_item_append()
16967     * @see elm_list_items_get()
16968     *
16969     * @ingroup List
16970     */
16971    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16972
16973    /**
16974     * Sets the disabled/enabled state of a list item.
16975     *
16976     * @param it The item.
16977     * @param disabled The disabled state.
16978     *
16979     * A disabled item cannot be selected or unselected. It will also
16980     * change its appearance (generally greyed out). This sets the
16981     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16982     * enabled).
16983     *
16984     * @ingroup List
16985     */
16986    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16987
16988    /**
16989     * Get a value whether list item is disabled or not.
16990     *
16991     * @param it The item.
16992     * @return The disabled state.
16993     *
16994     * @see elm_list_item_disabled_set() for more details.
16995     *
16996     * @ingroup List
16997     */
16998    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16999
17000    /**
17001     * Set the text to be shown in a given list item's tooltips.
17002     *
17003     * @param item Target item.
17004     * @param text The text to set in the content.
17005     *
17006     * Setup the text as tooltip to object. The item can have only one tooltip,
17007     * so any previous tooltip data - set with this function or
17008     * elm_list_item_tooltip_content_cb_set() - is removed.
17009     *
17010     * @see elm_object_tooltip_text_set() for more details.
17011     *
17012     * @ingroup List
17013     */
17014    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17015
17016
17017    /**
17018     * @brief Disable size restrictions on an object's tooltip
17019     * @param item The tooltip's anchor object
17020     * @param disable If EINA_TRUE, size restrictions are disabled
17021     * @return EINA_FALSE on failure, EINA_TRUE on success
17022     *
17023     * This function allows a tooltip to expand beyond its parant window's canvas.
17024     * It will instead be limited only by the size of the display.
17025     */
17026    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17027    /**
17028     * @brief Retrieve size restriction state of an object's tooltip
17029     * @param obj The tooltip's anchor object
17030     * @return If EINA_TRUE, size restrictions are disabled
17031     *
17032     * This function returns whether a tooltip is allowed to expand beyond
17033     * its parant window's canvas.
17034     * It will instead be limited only by the size of the display.
17035     */
17036    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17037
17038    /**
17039     * Set the content to be shown in the tooltip item.
17040     *
17041     * Setup the tooltip to item. The item can have only one tooltip,
17042     * so any previous tooltip data is removed. @p func(with @p data) will
17043     * be called every time that need show the tooltip and it should
17044     * return a valid Evas_Object. This object is then managed fully by
17045     * tooltip system and is deleted when the tooltip is gone.
17046     *
17047     * @param item the list item being attached a tooltip.
17048     * @param func the function used to create the tooltip contents.
17049     * @param data what to provide to @a func as callback data/context.
17050     * @param del_cb called when data is not needed anymore, either when
17051     *        another callback replaces @a func, the tooltip is unset with
17052     *        elm_list_item_tooltip_unset() or the owner @a item
17053     *        dies. This callback receives as the first parameter the
17054     *        given @a data, and @c event_info is the item.
17055     *
17056     * @see elm_object_tooltip_content_cb_set() for more details.
17057     *
17058     * @ingroup List
17059     */
17060    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);
17061
17062    /**
17063     * Unset tooltip from item.
17064     *
17065     * @param item list item to remove previously set tooltip.
17066     *
17067     * Remove tooltip from item. The callback provided as del_cb to
17068     * elm_list_item_tooltip_content_cb_set() will be called to notify
17069     * it is not used anymore.
17070     *
17071     * @see elm_object_tooltip_unset() for more details.
17072     * @see elm_list_item_tooltip_content_cb_set()
17073     *
17074     * @ingroup List
17075     */
17076    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17077
17078    /**
17079     * Sets a different style for this item tooltip.
17080     *
17081     * @note before you set a style you should define a tooltip with
17082     *       elm_list_item_tooltip_content_cb_set() or
17083     *       elm_list_item_tooltip_text_set()
17084     *
17085     * @param item list item with tooltip already set.
17086     * @param style the theme style to use (default, transparent, ...)
17087     *
17088     * @see elm_object_tooltip_style_set() for more details.
17089     *
17090     * @ingroup List
17091     */
17092    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17093
17094    /**
17095     * Get the style for this item tooltip.
17096     *
17097     * @param item list item with tooltip already set.
17098     * @return style the theme style in use, defaults to "default". If the
17099     *         object does not have a tooltip set, then NULL is returned.
17100     *
17101     * @see elm_object_tooltip_style_get() for more details.
17102     * @see elm_list_item_tooltip_style_set()
17103     *
17104     * @ingroup List
17105     */
17106    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17107
17108    /**
17109     * Set the type of mouse pointer/cursor decoration to be shown,
17110     * when the mouse pointer is over the given list widget item
17111     *
17112     * @param item list item to customize cursor on
17113     * @param cursor the cursor type's name
17114     *
17115     * This function works analogously as elm_object_cursor_set(), but
17116     * here the cursor's changing area is restricted to the item's
17117     * area, and not the whole widget's. Note that that item cursors
17118     * have precedence over widget cursors, so that a mouse over an
17119     * item with custom cursor set will always show @b that cursor.
17120     *
17121     * If this function is called twice for an object, a previously set
17122     * cursor will be unset on the second call.
17123     *
17124     * @see elm_object_cursor_set()
17125     * @see elm_list_item_cursor_get()
17126     * @see elm_list_item_cursor_unset()
17127     *
17128     * @ingroup List
17129     */
17130    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17131
17132    /*
17133     * Get the type of mouse pointer/cursor decoration set to be shown,
17134     * when the mouse pointer is over the given list widget item
17135     *
17136     * @param item list item with custom cursor set
17137     * @return the cursor type's name or @c NULL, if no custom cursors
17138     * were set to @p item (and on errors)
17139     *
17140     * @see elm_object_cursor_get()
17141     * @see elm_list_item_cursor_set()
17142     * @see elm_list_item_cursor_unset()
17143     *
17144     * @ingroup List
17145     */
17146    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17147
17148    /**
17149     * Unset any custom mouse pointer/cursor decoration set to be
17150     * shown, when the mouse pointer is over the given list widget
17151     * item, thus making it show the @b default cursor again.
17152     *
17153     * @param item a list item
17154     *
17155     * Use this call to undo any custom settings on this item's cursor
17156     * decoration, bringing it back to defaults (no custom style set).
17157     *
17158     * @see elm_object_cursor_unset()
17159     * @see elm_list_item_cursor_set()
17160     *
17161     * @ingroup List
17162     */
17163    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17164
17165    /**
17166     * Set a different @b style for a given custom cursor set for a
17167     * list item.
17168     *
17169     * @param item list item with custom cursor set
17170     * @param style the <b>theme style</b> to use (e.g. @c "default",
17171     * @c "transparent", etc)
17172     *
17173     * This function only makes sense when one is using custom mouse
17174     * cursor decorations <b>defined in a theme file</b>, which can have,
17175     * given a cursor name/type, <b>alternate styles</b> on it. It
17176     * works analogously as elm_object_cursor_style_set(), but here
17177     * applyed only to list item objects.
17178     *
17179     * @warning Before you set a cursor style you should have definen a
17180     *       custom cursor previously on the item, with
17181     *       elm_list_item_cursor_set()
17182     *
17183     * @see elm_list_item_cursor_engine_only_set()
17184     * @see elm_list_item_cursor_style_get()
17185     *
17186     * @ingroup List
17187     */
17188    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17189
17190    /**
17191     * Get the current @b style set for a given list item's custom
17192     * cursor
17193     *
17194     * @param item list item with custom cursor set.
17195     * @return style the cursor style in use. If the object does not
17196     *         have a cursor set, then @c NULL is returned.
17197     *
17198     * @see elm_list_item_cursor_style_set() for more details
17199     *
17200     * @ingroup List
17201     */
17202    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17203
17204    /**
17205     * Set if the (custom)cursor for a given list item should be
17206     * searched in its theme, also, or should only rely on the
17207     * rendering engine.
17208     *
17209     * @param item item with custom (custom) cursor already set on
17210     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17211     * only on those provided by the rendering engine, @c EINA_FALSE to
17212     * have them searched on the widget's theme, as well.
17213     *
17214     * @note This call is of use only if you've set a custom cursor
17215     * for list items, with elm_list_item_cursor_set().
17216     *
17217     * @note By default, cursors will only be looked for between those
17218     * provided by the rendering engine.
17219     *
17220     * @ingroup List
17221     */
17222    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17223
17224    /**
17225     * Get if the (custom) cursor for a given list item is being
17226     * searched in its theme, also, or is only relying on the rendering
17227     * engine.
17228     *
17229     * @param item a list item
17230     * @return @c EINA_TRUE, if cursors are being looked for only on
17231     * those provided by the rendering engine, @c EINA_FALSE if they
17232     * are being searched on the widget's theme, as well.
17233     *
17234     * @see elm_list_item_cursor_engine_only_set(), for more details
17235     *
17236     * @ingroup List
17237     */
17238    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17239
17240    /**
17241     * @}
17242     */
17243
17244    /**
17245     * @defgroup Slider Slider
17246     * @ingroup Elementary
17247     *
17248     * @image html img/widget/slider/preview-00.png
17249     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17250     *
17251     * The slider adds a dragable “slider” widget for selecting the value of
17252     * something within a range.
17253     *
17254     * A slider can be horizontal or vertical. It can contain an Icon and has a
17255     * primary label as well as a units label (that is formatted with floating
17256     * point values and thus accepts a printf-style format string, like
17257     * “%1.2f units”. There is also an indicator string that may be somewhere
17258     * else (like on the slider itself) that also accepts a format string like
17259     * units. Label, Icon Unit and Indicator strings/objects are optional.
17260     *
17261     * A slider may be inverted which means values invert, with high vales being
17262     * on the left or top and low values on the right or bottom (as opposed to
17263     * normally being low on the left or top and high on the bottom and right).
17264     *
17265     * The slider should have its minimum and maximum values set by the
17266     * application with  elm_slider_min_max_set() and value should also be set by
17267     * the application before use with  elm_slider_value_set(). The span of the
17268     * slider is its length (horizontally or vertically). This will be scaled by
17269     * the object or applications scaling factor. At any point code can query the
17270     * slider for its value with elm_slider_value_get().
17271     *
17272     * Smart callbacks one can listen to:
17273     * - "changed" - Whenever the slider value is changed by the user.
17274     * - "slider,drag,start" - dragging the slider indicator around has started.
17275     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17276     * - "delay,changed" - A short time after the value is changed by the user.
17277     * This will be called only when the user stops dragging for
17278     * a very short period or when they release their
17279     * finger/mouse, so it avoids possibly expensive reactions to
17280     * the value change.
17281     *
17282     * Available styles for it:
17283     * - @c "default"
17284     *
17285     * Default contents parts of the slider widget that you can use for are:
17286     * @li "elm.swallow.icon" - A icon of the slider
17287     * @li "elm.swallow.end" - A end part content of the slider
17288     * 
17289     * Here is an example on its usage:
17290     * @li @ref slider_example
17291     */
17292
17293 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17294 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17295
17296    /**
17297     * @addtogroup Slider
17298     * @{
17299     */
17300
17301    /**
17302     * Add a new slider widget to the given parent Elementary
17303     * (container) object.
17304     *
17305     * @param parent The parent object.
17306     * @return a new slider widget handle or @c NULL, on errors.
17307     *
17308     * This function inserts a new slider widget on the canvas.
17309     *
17310     * @ingroup Slider
17311     */
17312    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17313
17314    /**
17315     * Set the label of a given slider widget
17316     *
17317     * @param obj The progress bar object
17318     * @param label The text label string, in UTF-8
17319     *
17320     * @ingroup Slider
17321     * @deprecated use elm_object_text_set() instead.
17322     */
17323    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17324
17325    /**
17326     * Get the label of a given slider widget
17327     *
17328     * @param obj The progressbar object
17329     * @return The text label string, in UTF-8
17330     *
17331     * @ingroup Slider
17332     * @deprecated use elm_object_text_get() instead.
17333     */
17334    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17335
17336    /**
17337     * Set the icon object of the slider object.
17338     *
17339     * @param obj The slider object.
17340     * @param icon The icon object.
17341     *
17342     * On horizontal mode, icon is placed at left, and on vertical mode,
17343     * placed at top.
17344     *
17345     * @note Once the icon object is set, a previously set one will be deleted.
17346     * If you want to keep that old content object, use the
17347     * elm_slider_icon_unset() function.
17348     *
17349     * @warning If the object being set does not have minimum size hints set,
17350     * it won't get properly displayed.
17351     *
17352     * @ingroup Slider
17353     */
17354    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17355
17356    /**
17357     * Unset an icon set on a given slider widget.
17358     *
17359     * @param obj The slider object.
17360     * @return The icon object that was being used, if any was set, or
17361     * @c NULL, otherwise (and on errors).
17362     *
17363     * On horizontal mode, icon is placed at left, and on vertical mode,
17364     * placed at top.
17365     *
17366     * This call will unparent and return the icon object which was set
17367     * for this widget, previously, on success.
17368     *
17369     * @see elm_slider_icon_set() for more details
17370     * @see elm_slider_icon_get()
17371     *
17372     * @ingroup Slider
17373     */
17374    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17375
17376    /**
17377     * Retrieve the icon object set for a given slider widget.
17378     *
17379     * @param obj The slider object.
17380     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17381     * otherwise (and on errors).
17382     *
17383     * On horizontal mode, icon is placed at left, and on vertical mode,
17384     * placed at top.
17385     *
17386     * @see elm_slider_icon_set() for more details
17387     * @see elm_slider_icon_unset()
17388     *
17389     * @ingroup Slider
17390     */
17391    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17392
17393    /**
17394     * Set the end object of the slider object.
17395     *
17396     * @param obj The slider object.
17397     * @param end The end object.
17398     *
17399     * On horizontal mode, end is placed at left, and on vertical mode,
17400     * placed at bottom.
17401     *
17402     * @note Once the icon object is set, a previously set one will be deleted.
17403     * If you want to keep that old content object, use the
17404     * elm_slider_end_unset() function.
17405     *
17406     * @warning If the object being set does not have minimum size hints set,
17407     * it won't get properly displayed.
17408     *
17409     * @ingroup Slider
17410     */
17411    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17412
17413    /**
17414     * Unset an end object set on a given slider widget.
17415     *
17416     * @param obj The slider object.
17417     * @return The end object that was being used, if any was set, or
17418     * @c NULL, otherwise (and on errors).
17419     *
17420     * On horizontal mode, end is placed at left, and on vertical mode,
17421     * placed at bottom.
17422     *
17423     * This call will unparent and return the icon object which was set
17424     * for this widget, previously, on success.
17425     *
17426     * @see elm_slider_end_set() for more details.
17427     * @see elm_slider_end_get()
17428     *
17429     * @ingroup Slider
17430     */
17431    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17432
17433    /**
17434     * Retrieve the end object set for a given slider widget.
17435     *
17436     * @param obj The slider object.
17437     * @return The end object's handle, if @p obj had one set, or @c NULL,
17438     * otherwise (and on errors).
17439     *
17440     * On horizontal mode, icon is placed at right, and on vertical mode,
17441     * placed at bottom.
17442     *
17443     * @see elm_slider_end_set() for more details.
17444     * @see elm_slider_end_unset()
17445     *
17446     * @ingroup Slider
17447     */
17448    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17449
17450    /**
17451     * Set the (exact) length of the bar region of a given slider widget.
17452     *
17453     * @param obj The slider object.
17454     * @param size The length of the slider's bar region.
17455     *
17456     * This sets the minimum width (when in horizontal mode) or height
17457     * (when in vertical mode) of the actual bar area of the slider
17458     * @p obj. This in turn affects the object's minimum size. Use
17459     * this when you're not setting other size hints expanding on the
17460     * given direction (like weight and alignment hints) and you would
17461     * like it to have a specific size.
17462     *
17463     * @note Icon, end, label, indicator and unit text around @p obj
17464     * will require their
17465     * own space, which will make @p obj to require more the @p size,
17466     * actually.
17467     *
17468     * @see elm_slider_span_size_get()
17469     *
17470     * @ingroup Slider
17471     */
17472    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17473
17474    /**
17475     * Get the length set for the bar region of a given slider widget
17476     *
17477     * @param obj The slider object.
17478     * @return The length of the slider's bar region.
17479     *
17480     * If that size was not set previously, with
17481     * elm_slider_span_size_set(), this call will return @c 0.
17482     *
17483     * @ingroup Slider
17484     */
17485    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17486
17487    /**
17488     * Set the format string for the unit label.
17489     *
17490     * @param obj The slider object.
17491     * @param format The format string for the unit display.
17492     *
17493     * Unit label is displayed all the time, if set, after slider's bar.
17494     * In horizontal mode, at right and in vertical mode, at bottom.
17495     *
17496     * If @c NULL, unit label won't be visible. If not it sets the format
17497     * string for the label text. To the label text is provided a floating point
17498     * value, so the label text can display up to 1 floating point value.
17499     * Note that this is optional.
17500     *
17501     * Use a format string such as "%1.2f meters" for example, and it will
17502     * display values like: "3.14 meters" for a value equal to 3.14159.
17503     *
17504     * Default is unit label disabled.
17505     *
17506     * @see elm_slider_indicator_format_get()
17507     *
17508     * @ingroup Slider
17509     */
17510    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17511
17512    /**
17513     * Get the unit label format of the slider.
17514     *
17515     * @param obj The slider object.
17516     * @return The unit label format string in UTF-8.
17517     *
17518     * Unit label is displayed all the time, if set, after slider's bar.
17519     * In horizontal mode, at right and in vertical mode, at bottom.
17520     *
17521     * @see elm_slider_unit_format_set() for more
17522     * information on how this works.
17523     *
17524     * @ingroup Slider
17525     */
17526    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17527
17528    /**
17529     * Set the format string for the indicator label.
17530     *
17531     * @param obj The slider object.
17532     * @param indicator The format string for the indicator display.
17533     *
17534     * The slider may display its value somewhere else then unit label,
17535     * for example, above the slider knob that is dragged around. This function
17536     * sets the format string used for this.
17537     *
17538     * If @c NULL, indicator label won't be visible. If not it sets the format
17539     * string for the label text. To the label text is provided a floating point
17540     * value, so the label text can display up to 1 floating point value.
17541     * Note that this is optional.
17542     *
17543     * Use a format string such as "%1.2f meters" for example, and it will
17544     * display values like: "3.14 meters" for a value equal to 3.14159.
17545     *
17546     * Default is indicator label disabled.
17547     *
17548     * @see elm_slider_indicator_format_get()
17549     *
17550     * @ingroup Slider
17551     */
17552    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17553
17554    /**
17555     * Get the indicator label format of the slider.
17556     *
17557     * @param obj The slider object.
17558     * @return The indicator label format string in UTF-8.
17559     *
17560     * The slider may display its value somewhere else then unit label,
17561     * for example, above the slider knob that is dragged around. This function
17562     * gets the format string used for this.
17563     *
17564     * @see elm_slider_indicator_format_set() for more
17565     * information on how this works.
17566     *
17567     * @ingroup Slider
17568     */
17569    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17570
17571    /**
17572     * Set the format function pointer for the indicator label
17573     *
17574     * @param obj The slider object.
17575     * @param func The indicator format function.
17576     * @param free_func The freeing function for the format string.
17577     *
17578     * Set the callback function to format the indicator string.
17579     *
17580     * @see elm_slider_indicator_format_set() for more info on how this works.
17581     *
17582     * @ingroup Slider
17583     */
17584   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);
17585
17586   /**
17587    * Set the format function pointer for the units label
17588    *
17589    * @param obj The slider object.
17590    * @param func The units format function.
17591    * @param free_func The freeing function for the format string.
17592    *
17593    * Set the callback function to format the indicator string.
17594    *
17595    * @see elm_slider_units_format_set() for more info on how this works.
17596    *
17597    * @ingroup Slider
17598    */
17599   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);
17600
17601   /**
17602    * Set the orientation of a given slider widget.
17603    *
17604    * @param obj The slider object.
17605    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17606    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17607    *
17608    * Use this function to change how your slider is to be
17609    * disposed: vertically or horizontally.
17610    *
17611    * By default it's displayed horizontally.
17612    *
17613    * @see elm_slider_horizontal_get()
17614    *
17615    * @ingroup Slider
17616    */
17617    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17618
17619    /**
17620     * Retrieve the orientation of a given slider widget
17621     *
17622     * @param obj The slider object.
17623     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17624     * @c EINA_FALSE if it's @b vertical (and on errors).
17625     *
17626     * @see elm_slider_horizontal_set() for more details.
17627     *
17628     * @ingroup Slider
17629     */
17630    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17631
17632    /**
17633     * Set the minimum and maximum values for the slider.
17634     *
17635     * @param obj The slider object.
17636     * @param min The minimum value.
17637     * @param max The maximum value.
17638     *
17639     * Define the allowed range of values to be selected by the user.
17640     *
17641     * If actual value is less than @p min, it will be updated to @p min. If it
17642     * is bigger then @p max, will be updated to @p max. Actual value can be
17643     * get with elm_slider_value_get().
17644     *
17645     * By default, min is equal to 0.0, and max is equal to 1.0.
17646     *
17647     * @warning Maximum must be greater than minimum, otherwise behavior
17648     * is undefined.
17649     *
17650     * @see elm_slider_min_max_get()
17651     *
17652     * @ingroup Slider
17653     */
17654    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17655
17656    /**
17657     * Get the minimum and maximum values of the slider.
17658     *
17659     * @param obj The slider object.
17660     * @param min Pointer where to store the minimum value.
17661     * @param max Pointer where to store the maximum value.
17662     *
17663     * @note If only one value is needed, the other pointer can be passed
17664     * as @c NULL.
17665     *
17666     * @see elm_slider_min_max_set() for details.
17667     *
17668     * @ingroup Slider
17669     */
17670    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17671
17672    /**
17673     * Set the value the slider displays.
17674     *
17675     * @param obj The slider object.
17676     * @param val The value to be displayed.
17677     *
17678     * Value will be presented on the unit label following format specified with
17679     * elm_slider_unit_format_set() and on indicator with
17680     * elm_slider_indicator_format_set().
17681     *
17682     * @warning The value must to be between min and max values. This values
17683     * are set by elm_slider_min_max_set().
17684     *
17685     * @see elm_slider_value_get()
17686     * @see elm_slider_unit_format_set()
17687     * @see elm_slider_indicator_format_set()
17688     * @see elm_slider_min_max_set()
17689     *
17690     * @ingroup Slider
17691     */
17692    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17693
17694    /**
17695     * Get the value displayed by the spinner.
17696     *
17697     * @param obj The spinner object.
17698     * @return The value displayed.
17699     *
17700     * @see elm_spinner_value_set() for details.
17701     *
17702     * @ingroup Slider
17703     */
17704    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17705
17706    /**
17707     * Invert a given slider widget's displaying values order
17708     *
17709     * @param obj The slider object.
17710     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17711     * @c EINA_FALSE to bring it back to default, non-inverted values.
17712     *
17713     * A slider may be @b inverted, in which state it gets its
17714     * values inverted, with high vales being on the left or top and
17715     * low values on the right or bottom, as opposed to normally have
17716     * the low values on the former and high values on the latter,
17717     * respectively, for horizontal and vertical modes.
17718     *
17719     * @see elm_slider_inverted_get()
17720     *
17721     * @ingroup Slider
17722     */
17723    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17724
17725    /**
17726     * Get whether a given slider widget's displaying values are
17727     * inverted or not.
17728     *
17729     * @param obj The slider object.
17730     * @return @c EINA_TRUE, if @p obj has inverted values,
17731     * @c EINA_FALSE otherwise (and on errors).
17732     *
17733     * @see elm_slider_inverted_set() for more details.
17734     *
17735     * @ingroup Slider
17736     */
17737    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17738
17739    /**
17740     * Set whether to enlarge slider indicator (augmented knob) or not.
17741     *
17742     * @param obj The slider object.
17743     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17744     * let the knob always at default size.
17745     *
17746     * By default, indicator will be bigger while dragged by the user.
17747     *
17748     * @warning It won't display values set with
17749     * elm_slider_indicator_format_set() if you disable indicator.
17750     *
17751     * @ingroup Slider
17752     */
17753    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17754
17755    /**
17756     * Get whether a given slider widget's enlarging indicator or not.
17757     *
17758     * @param obj The slider object.
17759     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17760     * @c EINA_FALSE otherwise (and on errors).
17761     *
17762     * @see elm_slider_indicator_show_set() for details.
17763     *
17764     * @ingroup Slider
17765     */
17766    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17767
17768    /**
17769     * @}
17770     */
17771
17772    /**
17773     * @addtogroup Actionslider Actionslider
17774     *
17775     * @image html img/widget/actionslider/preview-00.png
17776     * @image latex img/widget/actionslider/preview-00.eps
17777     *
17778     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17779     * properties. The user drags and releases the indicator, to choose a label.
17780     *
17781     * Labels occupy the following positions.
17782     * a. Left
17783     * b. Right
17784     * c. Center
17785     *
17786     * Positions can be enabled or disabled.
17787     *
17788     * Magnets can be set on the above positions.
17789     *
17790     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17791     *
17792     * @note By default all positions are set as enabled.
17793     *
17794     * Signals that you can add callbacks for are:
17795     *
17796     * "selected" - when user selects an enabled position (the label is passed
17797     *              as event info)".
17798     * @n
17799     * "pos_changed" - when the indicator reaches any of the positions("left",
17800     *                 "right" or "center").
17801     *
17802     * See an example of actionslider usage @ref actionslider_example_page "here"
17803     * @{
17804     */
17805    typedef enum _Elm_Actionslider_Pos
17806      {
17807         ELM_ACTIONSLIDER_NONE = 0,
17808         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17809         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17810         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17811         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17812      } Elm_Actionslider_Pos;
17813
17814    /**
17815     * Add a new actionslider to the parent.
17816     *
17817     * @param parent The parent object
17818     * @return The new actionslider object or NULL if it cannot be created
17819     */
17820    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17821    /**
17822     * Set actionslider labels.
17823     *
17824     * @param obj The actionslider object
17825     * @param left_label The label to be set on the left.
17826     * @param center_label The label to be set on the center.
17827     * @param right_label The label to be set on the right.
17828     * @deprecated use elm_object_text_set() instead.
17829     */
17830    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
17831    /**
17832     * Get actionslider labels.
17833     *
17834     * @param obj The actionslider object
17835     * @param left_label A char** to place the left_label of @p obj into.
17836     * @param center_label A char** to place the center_label of @p obj into.
17837     * @param right_label A char** to place the right_label of @p obj into.
17838     * @deprecated use elm_object_text_set() instead.
17839     */
17840    EINA_DEPRECATED 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);
17841    /**
17842     * Get actionslider selected label.
17843     *
17844     * @param obj The actionslider object
17845     * @return The selected label
17846     */
17847    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17848    /**
17849     * Set actionslider indicator position.
17850     *
17851     * @param obj The actionslider object.
17852     * @param pos The position of the indicator.
17853     */
17854    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17855    /**
17856     * Get actionslider indicator position.
17857     *
17858     * @param obj The actionslider object.
17859     * @return The position of the indicator.
17860     */
17861    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17862    /**
17863     * Set actionslider magnet position. To make multiple positions magnets @c or
17864     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17865     *
17866     * @param obj The actionslider object.
17867     * @param pos Bit mask indicating the magnet positions.
17868     */
17869    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17870    /**
17871     * Get actionslider magnet position.
17872     *
17873     * @param obj The actionslider object.
17874     * @return The positions with magnet property.
17875     */
17876    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17877    /**
17878     * Set actionslider enabled position. To set multiple positions as enabled @c or
17879     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17880     *
17881     * @note All the positions are enabled by default.
17882     *
17883     * @param obj The actionslider object.
17884     * @param pos Bit mask indicating the enabled positions.
17885     */
17886    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17887    /**
17888     * Get actionslider enabled position.
17889     *
17890     * @param obj The actionslider object.
17891     * @return The enabled positions.
17892     */
17893    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17894    /**
17895     * Set the label used on the indicator.
17896     *
17897     * @param obj The actionslider object
17898     * @param label The label to be set on the indicator.
17899     * @deprecated use elm_object_text_set() instead.
17900     */
17901    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17902    /**
17903     * Get the label used on the indicator object.
17904     *
17905     * @param obj The actionslider object
17906     * @return The indicator label
17907     * @deprecated use elm_object_text_get() instead.
17908     */
17909    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17910    /**
17911     * @}
17912     */
17913
17914    /**
17915     * @defgroup Genlist Genlist
17916     *
17917     * @image html img/widget/genlist/preview-00.png
17918     * @image latex img/widget/genlist/preview-00.eps
17919     * @image html img/genlist.png
17920     * @image latex img/genlist.eps
17921     *
17922     * This widget aims to have more expansive list than the simple list in
17923     * Elementary that could have more flexible items and allow many more entries
17924     * while still being fast and low on memory usage. At the same time it was
17925     * also made to be able to do tree structures. But the price to pay is more
17926     * complexity when it comes to usage. If all you want is a simple list with
17927     * icons and a single label, use the normal @ref List object.
17928     *
17929     * Genlist has a fairly large API, mostly because it's relatively complex,
17930     * trying to be both expansive, powerful and efficient. First we will begin
17931     * an overview on the theory behind genlist.
17932     *
17933     * @section Genlist_Item_Class Genlist item classes - creating items
17934     *
17935     * In order to have the ability to add and delete items on the fly, genlist
17936     * implements a class (callback) system where the application provides a
17937     * structure with information about that type of item (genlist may contain
17938     * multiple different items with different classes, states and styles).
17939     * Genlist will call the functions in this struct (methods) when an item is
17940     * "realized" (i.e., created dynamically, while the user is scrolling the
17941     * grid). All objects will simply be deleted when no longer needed with
17942     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17943     * following members:
17944     * - @c item_style - This is a constant string and simply defines the name
17945     *   of the item style. It @b must be specified and the default should be @c
17946     *   "default".
17947     *
17948     * - @c func - A struct with pointers to functions that will be called when
17949     *   an item is going to be actually created. All of them receive a @c data
17950     *   parameter that will point to the same data passed to
17951     *   elm_genlist_item_append() and related item creation functions, and a @c
17952     *   obj parameter that points to the genlist object itself.
17953     *
17954     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17955     * state_get and @c del. The 3 first functions also receive a @c part
17956     * parameter described below. A brief description of these functions follows:
17957     *
17958     * - @c label_get - The @c part parameter is the name string of one of the
17959     *   existing text parts in the Edje group implementing the item's theme.
17960     *   This function @b must return a strdup'()ed string, as the caller will
17961     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17962     * - @c content_get - The @c part parameter is the name string of one of the
17963     *   existing (content) swallow parts in the Edje group implementing the item's
17964     *   theme. It must return @c NULL, when no content is desired, or a valid
17965     *   object handle, otherwise.  The object will be deleted by the genlist on
17966     *   its deletion or when the item is "unrealized".  See
17967     *   #Elm_Genlist_Item_Icon_Get_Cb.
17968     * - @c func.state_get - The @c part parameter is the name string of one of
17969     *   the state parts in the Edje group implementing the item's theme. Return
17970     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17971     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17972     *   and @c "elm" as "emission" and "source" arguments, respectively, when
17973     *   the state is true (the default is false), where @c XXX is the name of
17974     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
17975     * - @c func.del - This is intended for use when genlist items are deleted,
17976     *   so any data attached to the item (e.g. its data parameter on creation)
17977     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
17978     *
17979     * available item styles:
17980     * - default
17981     * - default_style - The text part is a textblock
17982     *
17983     * @image html img/widget/genlist/preview-04.png
17984     * @image latex img/widget/genlist/preview-04.eps
17985     *
17986     * - double_label
17987     *
17988     * @image html img/widget/genlist/preview-01.png
17989     * @image latex img/widget/genlist/preview-01.eps
17990     *
17991     * - icon_top_text_bottom
17992     *
17993     * @image html img/widget/genlist/preview-02.png
17994     * @image latex img/widget/genlist/preview-02.eps
17995     *
17996     * - group_index
17997     *
17998     * @image html img/widget/genlist/preview-03.png
17999     * @image latex img/widget/genlist/preview-03.eps
18000     *
18001     * @section Genlist_Items Structure of items
18002     *
18003     * An item in a genlist can have 0 or more text labels (they can be regular
18004     * text or textblock Evas objects - that's up to the style to determine), 0
18005     * or more contents (which are simply objects swallowed into the genlist item's
18006     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18007     * behavior left to the user to define. The Edje part names for each of
18008     * these properties will be looked up, in the theme file for the genlist,
18009     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18010     * "states", respectively. For each of those properties, if more than one
18011     * part is provided, they must have names listed separated by spaces in the
18012     * data fields. For the default genlist item theme, we have @b one label
18013     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18014     * "elm.swallow.end") and @b no state parts.
18015     *
18016     * A genlist item may be at one of several styles. Elementary provides one
18017     * by default - "default", but this can be extended by system or application
18018     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18019     * details).
18020     *
18021     * @section Genlist_Manipulation Editing and Navigating
18022     *
18023     * Items can be added by several calls. All of them return a @ref
18024     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18025     * They all take a data parameter that is meant to be used for a handle to
18026     * the applications internal data (eg the struct with the original item
18027     * data). The parent parameter is the parent genlist item this belongs to if
18028     * it is a tree or an indexed group, and NULL if there is no parent. The
18029     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18030     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18031     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18032     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18033     * is set then this item is group index item that is displayed at the top
18034     * until the next group comes. The func parameter is a convenience callback
18035     * that is called when the item is selected and the data parameter will be
18036     * the func_data parameter, obj be the genlist object and event_info will be
18037     * the genlist item.
18038     *
18039     * elm_genlist_item_append() adds an item to the end of the list, or if
18040     * there is a parent, to the end of all the child items of the parent.
18041     * elm_genlist_item_prepend() is the same but adds to the beginning of
18042     * the list or children list. elm_genlist_item_insert_before() inserts at
18043     * item before another item and elm_genlist_item_insert_after() inserts after
18044     * the indicated item.
18045     *
18046     * The application can clear the list with elm_genlist_clear() which deletes
18047     * all the items in the list and elm_genlist_item_del() will delete a specific
18048     * item. elm_genlist_item_subitems_clear() will clear all items that are
18049     * children of the indicated parent item.
18050     *
18051     * To help inspect list items you can jump to the item at the top of the list
18052     * with elm_genlist_first_item_get() which will return the item pointer, and
18053     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18054     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18055     * and previous items respectively relative to the indicated item. Using
18056     * these calls you can walk the entire item list/tree. Note that as a tree
18057     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18058     * let you know which item is the parent (and thus know how to skip them if
18059     * wanted).
18060     *
18061     * @section Genlist_Muti_Selection Multi-selection
18062     *
18063     * If the application wants multiple items to be able to be selected,
18064     * elm_genlist_multi_select_set() can enable this. If the list is
18065     * single-selection only (the default), then elm_genlist_selected_item_get()
18066     * will return the selected item, if any, or NULL I none is selected. If the
18067     * list is multi-select then elm_genlist_selected_items_get() will return a
18068     * list (that is only valid as long as no items are modified (added, deleted,
18069     * selected or unselected)).
18070     *
18071     * @section Genlist_Usage_Hints Usage hints
18072     *
18073     * There are also convenience functions. elm_genlist_item_genlist_get() will
18074     * return the genlist object the item belongs to. elm_genlist_item_show()
18075     * will make the scroller scroll to show that specific item so its visible.
18076     * elm_genlist_item_data_get() returns the data pointer set by the item
18077     * creation functions.
18078     *
18079     * If an item changes (state of boolean changes, label or contents change),
18080     * then use elm_genlist_item_update() to have genlist update the item with
18081     * the new state. Genlist will re-realize the item thus call the functions
18082     * in the _Elm_Genlist_Item_Class for that item.
18083     *
18084     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18085     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18086     * to expand/contract an item and get its expanded state, use
18087     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18088     * again to make an item disabled (unable to be selected and appear
18089     * differently) use elm_genlist_item_disabled_set() to set this and
18090     * elm_genlist_item_disabled_get() to get the disabled state.
18091     *
18092     * In general to indicate how the genlist should expand items horizontally to
18093     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18094     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18095     * mode means that if items are too wide to fit, the scroller will scroll
18096     * horizontally. Otherwise items are expanded to fill the width of the
18097     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18098     * to the viewport width and limited to that size. This can be combined with
18099     * a different style that uses edjes' ellipsis feature (cutting text off like
18100     * this: "tex...").
18101     *
18102     * Items will only call their selection func and callback when first becoming
18103     * selected. Any further clicks will do nothing, unless you enable always
18104     * select with elm_genlist_always_select_mode_set(). This means even if
18105     * selected, every click will make the selected callbacks be called.
18106     * elm_genlist_no_select_mode_set() will turn off the ability to select
18107     * items entirely and they will neither appear selected nor call selected
18108     * callback functions.
18109     *
18110     * Remember that you can create new styles and add your own theme augmentation
18111     * per application with elm_theme_extension_add(). If you absolutely must
18112     * have a specific style that overrides any theme the user or system sets up
18113     * you can use elm_theme_overlay_add() to add such a file.
18114     *
18115     * @section Genlist_Implementation Implementation
18116     *
18117     * Evas tracks every object you create. Every time it processes an event
18118     * (mouse move, down, up etc.) it needs to walk through objects and find out
18119     * what event that affects. Even worse every time it renders display updates,
18120     * in order to just calculate what to re-draw, it needs to walk through many
18121     * many many objects. Thus, the more objects you keep active, the more
18122     * overhead Evas has in just doing its work. It is advisable to keep your
18123     * active objects to the minimum working set you need. Also remember that
18124     * object creation and deletion carries an overhead, so there is a
18125     * middle-ground, which is not easily determined. But don't keep massive lists
18126     * of objects you can't see or use. Genlist does this with list objects. It
18127     * creates and destroys them dynamically as you scroll around. It groups them
18128     * into blocks so it can determine the visibility etc. of a whole block at
18129     * once as opposed to having to walk the whole list. This 2-level list allows
18130     * for very large numbers of items to be in the list (tests have used up to
18131     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18132     * may be different sizes, every item added needs to be calculated as to its
18133     * size and thus this presents a lot of overhead on populating the list, this
18134     * genlist employs a queue. Any item added is queued and spooled off over
18135     * time, actually appearing some time later, so if your list has many members
18136     * you may find it takes a while for them to all appear, with your process
18137     * consuming a lot of CPU while it is busy spooling.
18138     *
18139     * Genlist also implements a tree structure, but it does so with callbacks to
18140     * the application, with the application filling in tree structures when
18141     * requested (allowing for efficient building of a very deep tree that could
18142     * even be used for file-management). See the above smart signal callbacks for
18143     * details.
18144     *
18145     * @section Genlist_Smart_Events Genlist smart events
18146     *
18147     * Signals that you can add callbacks for are:
18148     * - @c "activated" - The user has double-clicked or pressed
18149     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18150     *   item that was activated.
18151     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18152     *   event_info parameter is the item that was double-clicked.
18153     * - @c "selected" - This is called when a user has made an item selected.
18154     *   The event_info parameter is the genlist item that was selected.
18155     * - @c "unselected" - This is called when a user has made an item
18156     *   unselected. The event_info parameter is the genlist item that was
18157     *   unselected.
18158     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18159     *   called and the item is now meant to be expanded. The event_info
18160     *   parameter is the genlist item that was indicated to expand.  It is the
18161     *   job of this callback to then fill in the child items.
18162     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18163     *   called and the item is now meant to be contracted. The event_info
18164     *   parameter is the genlist item that was indicated to contract. It is the
18165     *   job of this callback to then delete the child items.
18166     * - @c "expand,request" - This is called when a user has indicated they want
18167     *   to expand a tree branch item. The callback should decide if the item can
18168     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18169     *   appropriately to set the state. The event_info parameter is the genlist
18170     *   item that was indicated to expand.
18171     * - @c "contract,request" - This is called when a user has indicated they
18172     *   want to contract a tree branch item. The callback should decide if the
18173     *   item can contract (has any children) and then call
18174     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18175     *   event_info parameter is the genlist item that was indicated to contract.
18176     * - @c "realized" - This is called when the item in the list is created as a
18177     *   real evas object. event_info parameter is the genlist item that was
18178     *   created. The object may be deleted at any time, so it is up to the
18179     *   caller to not use the object pointer from elm_genlist_item_object_get()
18180     *   in a way where it may point to freed objects.
18181     * - @c "unrealized" - This is called just before an item is unrealized.
18182     *   After this call content objects provided will be deleted and the item
18183     *   object itself delete or be put into a floating cache.
18184     * - @c "drag,start,up" - This is called when the item in the list has been
18185     *   dragged (not scrolled) up.
18186     * - @c "drag,start,down" - This is called when the item in the list has been
18187     *   dragged (not scrolled) down.
18188     * - @c "drag,start,left" - This is called when the item in the list has been
18189     *   dragged (not scrolled) left.
18190     * - @c "drag,start,right" - This is called when the item in the list has
18191     *   been dragged (not scrolled) right.
18192     * - @c "drag,stop" - This is called when the item in the list has stopped
18193     *   being dragged.
18194     * - @c "drag" - This is called when the item in the list is being dragged.
18195     * - @c "longpressed" - This is called when the item is pressed for a certain
18196     *   amount of time. By default it's 1 second.
18197     * - @c "scroll,anim,start" - This is called when scrolling animation has
18198     *   started.
18199     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18200     *   stopped.
18201     * - @c "scroll,drag,start" - This is called when dragging the content has
18202     *   started.
18203     * - @c "scroll,drag,stop" - This is called when dragging the content has
18204     *   stopped.
18205     * - @c "edge,top" - This is called when the genlist is scrolled until
18206     *   the top edge.
18207     * - @c "edge,bottom" - This is called when the genlist is scrolled
18208     *   until the bottom edge.
18209     * - @c "edge,left" - This is called when the genlist is scrolled
18210     *   until the left edge.
18211     * - @c "edge,right" - This is called when the genlist is scrolled
18212     *   until the right edge.
18213     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18214     *   swiped left.
18215     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18216     *   swiped right.
18217     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18218     *   swiped up.
18219     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18220     *   swiped down.
18221     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18222     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18223     *   multi-touch pinched in.
18224     * - @c "swipe" - This is called when the genlist is swiped.
18225     * - @c "moved" - This is called when a genlist item is moved.
18226     * - @c "language,changed" - This is called when the program's language is
18227     *   changed.
18228     *
18229     * @section Genlist_Examples Examples
18230     *
18231     * Here is a list of examples that use the genlist, trying to show some of
18232     * its capabilities:
18233     * - @ref genlist_example_01
18234     * - @ref genlist_example_02
18235     * - @ref genlist_example_03
18236     * - @ref genlist_example_04
18237     * - @ref genlist_example_05
18238     */
18239
18240    /**
18241     * @addtogroup Genlist
18242     * @{
18243     */
18244
18245    /**
18246     * @enum _Elm_Genlist_Item_Flags
18247     * @typedef Elm_Genlist_Item_Flags
18248     *
18249     * Defines if the item is of any special type (has subitems or it's the
18250     * index of a group), or is just a simple item.
18251     *
18252     * @ingroup Genlist
18253     */
18254    typedef enum _Elm_Genlist_Item_Flags
18255      {
18256         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18257         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18258         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18259      } Elm_Genlist_Item_Flags;
18260    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18261    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18262    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18263    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18264    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18265    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18266    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for genlist item classes. */
18267    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
18268    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18269
18270    /**
18271     * @struct _Elm_Genlist_Item_Class
18272     *
18273     * Genlist item class definition structs.
18274     *
18275     * This struct contains the style and fetching functions that will define the
18276     * contents of each item.
18277     *
18278     * @see @ref Genlist_Item_Class
18279     */
18280    struct _Elm_Genlist_Item_Class
18281      {
18282         const char                *item_style; /**< style of this class. */
18283         struct Elm_Genlist_Item_Class_Func
18284           {
18285              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18286              Elm_Genlist_Item_Content_Get_Cb   content_get; /**< Content fetching class function for genlist item classes. */
18287              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18288              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18289           } func;
18290      };
18291    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18292    /**
18293     * Add a new genlist widget to the given parent Elementary
18294     * (container) object
18295     *
18296     * @param parent The parent object
18297     * @return a new genlist widget handle or @c NULL, on errors
18298     *
18299     * This function inserts a new genlist widget on the canvas.
18300     *
18301     * @see elm_genlist_item_append()
18302     * @see elm_genlist_item_del()
18303     * @see elm_genlist_clear()
18304     *
18305     * @ingroup Genlist
18306     */
18307    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18308    /**
18309     * Remove all items from a given genlist widget.
18310     *
18311     * @param obj The genlist object
18312     *
18313     * This removes (and deletes) all items in @p obj, leaving it empty.
18314     *
18315     * @see elm_genlist_item_del(), to remove just one item.
18316     *
18317     * @ingroup Genlist
18318     */
18319    EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18320    /**
18321     * Enable or disable multi-selection in the genlist
18322     *
18323     * @param obj The genlist object
18324     * @param multi Multi-select enable/disable. Default is disabled.
18325     *
18326     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18327     * the list. This allows more than 1 item to be selected. To retrieve the list
18328     * of selected items, use elm_genlist_selected_items_get().
18329     *
18330     * @see elm_genlist_selected_items_get()
18331     * @see elm_genlist_multi_select_get()
18332     *
18333     * @ingroup Genlist
18334     */
18335    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18336    /**
18337     * Gets if multi-selection in genlist is enabled or disabled.
18338     *
18339     * @param obj The genlist object
18340     * @return Multi-select enabled/disabled
18341     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18342     *
18343     * @see elm_genlist_multi_select_set()
18344     *
18345     * @ingroup Genlist
18346     */
18347    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18348    /**
18349     * This sets the horizontal stretching mode.
18350     *
18351     * @param obj The genlist object
18352     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18353     *
18354     * This sets the mode used for sizing items horizontally. Valid modes
18355     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18356     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18357     * the scroller will scroll horizontally. Otherwise items are expanded
18358     * to fill the width of the viewport of the scroller. If it is
18359     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18360     * limited to that size.
18361     *
18362     * @see elm_genlist_horizontal_get()
18363     *
18364     * @ingroup Genlist
18365     */
18366    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18367    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18368    /**
18369     * Gets the horizontal stretching mode.
18370     *
18371     * @param obj The genlist object
18372     * @return The mode to use
18373     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18374     *
18375     * @see elm_genlist_horizontal_set()
18376     *
18377     * @ingroup Genlist
18378     */
18379    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18380    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18381    /**
18382     * Set the always select mode.
18383     *
18384     * @param obj The genlist object
18385     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18386     * EINA_FALSE = off). Default is @c EINA_FALSE.
18387     *
18388     * Items will only call their selection func and callback when first
18389     * becoming selected. Any further clicks will do nothing, unless you
18390     * enable always select with elm_genlist_always_select_mode_set().
18391     * This means that, even if selected, every click will make the selected
18392     * callbacks be called.
18393     *
18394     * @see elm_genlist_always_select_mode_get()
18395     *
18396     * @ingroup Genlist
18397     */
18398    EINA_DEPRECATED EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18399    /**
18400     * Get the always select mode.
18401     *
18402     * @param obj The genlist object
18403     * @return The always select mode
18404     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18405     *
18406     * @see elm_genlist_always_select_mode_set()
18407     *
18408     * @ingroup Genlist
18409     */
18410    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18411    /**
18412     * Enable/disable the no select mode.
18413     *
18414     * @param obj The genlist object
18415     * @param no_select The no select mode
18416     * (EINA_TRUE = on, EINA_FALSE = off)
18417     *
18418     * This will turn off the ability to select items entirely and they
18419     * will neither appear selected nor call selected callback functions.
18420     *
18421     * @see elm_genlist_no_select_mode_get()
18422     *
18423     * @ingroup Genlist
18424     */
18425    EINA_DEPRECATED EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18426    /**
18427     * Gets whether the no select mode is enabled.
18428     *
18429     * @param obj The genlist object
18430     * @return The no select mode
18431     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18432     *
18433     * @see elm_genlist_no_select_mode_set()
18434     *
18435     * @ingroup Genlist
18436     */
18437    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18438    /**
18439     * Enable/disable compress mode.
18440     *
18441     * @param obj The genlist object
18442     * @param compress The compress mode
18443     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18444     *
18445     * This will enable the compress mode where items are "compressed"
18446     * horizontally to fit the genlist scrollable viewport width. This is
18447     * special for genlist.  Do not rely on
18448     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18449     * work as genlist needs to handle it specially.
18450     *
18451     * @see elm_genlist_compress_mode_get()
18452     *
18453     * @ingroup Genlist
18454     */
18455    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18456    /**
18457     * Get whether the compress mode is enabled.
18458     *
18459     * @param obj The genlist object
18460     * @return The compress mode
18461     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18462     *
18463     * @see elm_genlist_compress_mode_set()
18464     *
18465     * @ingroup Genlist
18466     */
18467    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18468    /**
18469     * Enable/disable height-for-width mode.
18470     *
18471     * @param obj The genlist object
18472     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18473     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18474     *
18475     * With height-for-width mode the item width will be fixed (restricted
18476     * to a minimum of) to the list width when calculating its size in
18477     * order to allow the height to be calculated based on it. This allows,
18478     * for instance, text block to wrap lines if the Edje part is
18479     * configured with "text.min: 0 1".
18480     *
18481     * @note This mode will make list resize slower as it will have to
18482     *       recalculate every item height again whenever the list width
18483     *       changes!
18484     *
18485     * @note When height-for-width mode is enabled, it also enables
18486     *       compress mode (see elm_genlist_compress_mode_set()) and
18487     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18488     *
18489     * @ingroup Genlist
18490     */
18491    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18492    /**
18493     * Get whether the height-for-width mode is enabled.
18494     *
18495     * @param obj The genlist object
18496     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18497     * off)
18498     *
18499     * @ingroup Genlist
18500     */
18501    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18502    /**
18503     * Enable/disable horizontal and vertical bouncing effect.
18504     *
18505     * @param obj The genlist object
18506     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18507     * EINA_FALSE = off). Default is @c EINA_FALSE.
18508     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18509     * EINA_FALSE = off). Default is @c EINA_TRUE.
18510     *
18511     * This will enable or disable the scroller bouncing effect for the
18512     * genlist. See elm_scroller_bounce_set() for details.
18513     *
18514     * @see elm_scroller_bounce_set()
18515     * @see elm_genlist_bounce_get()
18516     *
18517     * @ingroup Genlist
18518     */
18519    EINA_DEPRECATED EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18520    /**
18521     * Get whether the horizontal and vertical bouncing effect is enabled.
18522     *
18523     * @param obj The genlist object
18524     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18525     * option is set.
18526     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18527     * option is set.
18528     *
18529     * @see elm_genlist_bounce_set()
18530     *
18531     * @ingroup Genlist
18532     */
18533    EINA_DEPRECATED EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18534    /**
18535     * Enable/disable homogenous mode.
18536     *
18537     * @param obj The genlist object
18538     * @param homogeneous Assume the items within the genlist are of the
18539     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18540     * EINA_FALSE.
18541     *
18542     * This will enable the homogeneous mode where items are of the same
18543     * height and width so that genlist may do the lazy-loading at its
18544     * maximum (which increases the performance for scrolling the list). This
18545     * implies 'compressed' mode.
18546     *
18547     * @see elm_genlist_compress_mode_set()
18548     * @see elm_genlist_homogeneous_get()
18549     *
18550     * @ingroup Genlist
18551     */
18552    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18553    /**
18554     * Get whether the homogenous mode is enabled.
18555     *
18556     * @param obj The genlist object
18557     * @return Assume the items within the genlist are of the same height
18558     * and width (EINA_TRUE = on, EINA_FALSE = off)
18559     *
18560     * @see elm_genlist_homogeneous_set()
18561     *
18562     * @ingroup Genlist
18563     */
18564    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18565    /**
18566     * Set the maximum number of items within an item block
18567     *
18568     * @param obj The genlist object
18569     * @param n   Maximum number of items within an item block. Default is 32.
18570     *
18571     * This will configure the block count to tune to the target with
18572     * particular performance matrix.
18573     *
18574     * A block of objects will be used to reduce the number of operations due to
18575     * many objects in the screen. It can determine the visibility, or if the
18576     * object has changed, it theme needs to be updated, etc. doing this kind of
18577     * calculation to the entire block, instead of per object.
18578     *
18579     * The default value for the block count is enough for most lists, so unless
18580     * you know you will have a lot of objects visible in the screen at the same
18581     * time, don't try to change this.
18582     *
18583     * @see elm_genlist_block_count_get()
18584     * @see @ref Genlist_Implementation
18585     *
18586     * @ingroup Genlist
18587     */
18588    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18589    /**
18590     * Get the maximum number of items within an item block
18591     *
18592     * @param obj The genlist object
18593     * @return Maximum number of items within an item block
18594     *
18595     * @see elm_genlist_block_count_set()
18596     *
18597     * @ingroup Genlist
18598     */
18599    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18600    /**
18601     * Set the timeout in seconds for the longpress event.
18602     *
18603     * @param obj The genlist object
18604     * @param timeout timeout in seconds. Default is 1.
18605     *
18606     * This option will change how long it takes to send an event "longpressed"
18607     * after the mouse down signal is sent to the list. If this event occurs, no
18608     * "clicked" event will be sent.
18609     *
18610     * @see elm_genlist_longpress_timeout_set()
18611     *
18612     * @ingroup Genlist
18613     */
18614    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18615    /**
18616     * Get the timeout in seconds for the longpress event.
18617     *
18618     * @param obj The genlist object
18619     * @return timeout in seconds
18620     *
18621     * @see elm_genlist_longpress_timeout_get()
18622     *
18623     * @ingroup Genlist
18624     */
18625    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18626    /**
18627     * Append a new item in a given genlist widget.
18628     *
18629     * @param obj The genlist object
18630     * @param itc The item class for the item
18631     * @param data The item data
18632     * @param parent The parent item, or NULL if none
18633     * @param flags Item flags
18634     * @param func Convenience function called when the item is selected
18635     * @param func_data Data passed to @p func above.
18636     * @return A handle to the item added or @c NULL if not possible
18637     *
18638     * This adds the given item to the end of the list or the end of
18639     * the children list if the @p parent is given.
18640     *
18641     * @see elm_genlist_item_prepend()
18642     * @see elm_genlist_item_insert_before()
18643     * @see elm_genlist_item_insert_after()
18644     * @see elm_genlist_item_del()
18645     *
18646     * @ingroup Genlist
18647     */
18648    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);
18649    /**
18650     * Prepend a new item in a given genlist widget.
18651     *
18652     * @param obj The genlist object
18653     * @param itc The item class for the item
18654     * @param data The item data
18655     * @param parent The parent item, or NULL if none
18656     * @param flags Item flags
18657     * @param func Convenience function called when the item is selected
18658     * @param func_data Data passed to @p func above.
18659     * @return A handle to the item added or NULL if not possible
18660     *
18661     * This adds an item to the beginning of the list or beginning of the
18662     * children of the parent if given.
18663     *
18664     * @see elm_genlist_item_append()
18665     * @see elm_genlist_item_insert_before()
18666     * @see elm_genlist_item_insert_after()
18667     * @see elm_genlist_item_del()
18668     *
18669     * @ingroup Genlist
18670     */
18671    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);
18672    /**
18673     * Insert an item before another in a genlist widget
18674     *
18675     * @param obj The genlist object
18676     * @param itc The item class for the item
18677     * @param data The item data
18678     * @param before The item to place this new one before.
18679     * @param flags Item flags
18680     * @param func Convenience function called when the item is selected
18681     * @param func_data Data passed to @p func above.
18682     * @return A handle to the item added or @c NULL if not possible
18683     *
18684     * This inserts an item before another in the list. It will be in the
18685     * same tree level or group as the item it is inserted before.
18686     *
18687     * @see elm_genlist_item_append()
18688     * @see elm_genlist_item_prepend()
18689     * @see elm_genlist_item_insert_after()
18690     * @see elm_genlist_item_del()
18691     *
18692     * @ingroup Genlist
18693     */
18694    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);
18695    /**
18696     * Insert an item after another in a genlist widget
18697     *
18698     * @param obj The genlist object
18699     * @param itc The item class for the item
18700     * @param data The item data
18701     * @param after The item to place this new one after.
18702     * @param flags Item flags
18703     * @param func Convenience function called when the item is selected
18704     * @param func_data Data passed to @p func above.
18705     * @return A handle to the item added or @c NULL if not possible
18706     *
18707     * This inserts an item after another in the list. It will be in the
18708     * same tree level or group as the item it is inserted after.
18709     *
18710     * @see elm_genlist_item_append()
18711     * @see elm_genlist_item_prepend()
18712     * @see elm_genlist_item_insert_before()
18713     * @see elm_genlist_item_del()
18714     *
18715     * @ingroup Genlist
18716     */
18717    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);
18718    /**
18719     * Insert a new item into the sorted genlist object
18720     *
18721     * @param obj The genlist object
18722     * @param itc The item class for the item
18723     * @param data The item data
18724     * @param parent The parent item, or NULL if none
18725     * @param flags Item flags
18726     * @param comp The function called for the sort
18727     * @param func Convenience function called when item selected
18728     * @param func_data Data passed to @p func above.
18729     * @return A handle to the item added or NULL if not possible
18730     *
18731     * @ingroup Genlist
18732     */
18733    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);
18734    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);
18735    /* operations to retrieve existing items */
18736    /**
18737     * Get the selectd item in the genlist.
18738     *
18739     * @param obj The genlist object
18740     * @return The selected item, or NULL if none is selected.
18741     *
18742     * This gets the selected item in the list (if multi-selection is enabled, only
18743     * the item that was first selected in the list is returned - which is not very
18744     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18745     * used).
18746     *
18747     * If no item is selected, NULL is returned.
18748     *
18749     * @see elm_genlist_selected_items_get()
18750     *
18751     * @ingroup Genlist
18752     */
18753    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18754    /**
18755     * Get a list of selected items in the genlist.
18756     *
18757     * @param obj The genlist object
18758     * @return The list of selected items, or NULL if none are selected.
18759     *
18760     * It returns a list of the selected items. This list pointer is only valid so
18761     * long as the selection doesn't change (no items are selected or unselected, or
18762     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18763     * pointers. The order of the items in this list is the order which they were
18764     * selected, i.e. the first item in this list is the first item that was
18765     * selected, and so on.
18766     *
18767     * @note If not in multi-select mode, consider using function
18768     * elm_genlist_selected_item_get() instead.
18769     *
18770     * @see elm_genlist_multi_select_set()
18771     * @see elm_genlist_selected_item_get()
18772     *
18773     * @ingroup Genlist
18774     */
18775    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18776    /**
18777     * Get the mode item style of items in the genlist
18778     * @param obj The genlist object
18779     * @return The mode item style string, or NULL if none is specified
18780     * 
18781     * This is a constant string and simply defines the name of the
18782     * style that will be used for mode animations. It can be
18783     * @c NULL if you don't plan to use Genlist mode. See
18784     * elm_genlist_item_mode_set() for more info.
18785     * 
18786     * @ingroup Genlist
18787     */
18788    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18789    /**
18790     * Set the mode item style of items in the genlist
18791     * @param obj The genlist object
18792     * @param style The mode item style string, or NULL if none is desired
18793     * 
18794     * This is a constant string and simply defines the name of the
18795     * style that will be used for mode animations. It can be
18796     * @c NULL if you don't plan to use Genlist mode. See
18797     * elm_genlist_item_mode_set() for more info.
18798     * 
18799     * @ingroup Genlist
18800     */
18801    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18802    /**
18803     * Get a list of realized items in genlist
18804     *
18805     * @param obj The genlist object
18806     * @return The list of realized items, nor NULL if none are realized.
18807     *
18808     * This returns a list of the realized items in the genlist. The list
18809     * contains Elm_Genlist_Item pointers. The list must be freed by the
18810     * caller when done with eina_list_free(). The item pointers in the
18811     * list are only valid so long as those items are not deleted or the
18812     * genlist is not deleted.
18813     *
18814     * @see elm_genlist_realized_items_update()
18815     *
18816     * @ingroup Genlist
18817     */
18818    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18819    /**
18820     * Get the item that is at the x, y canvas coords.
18821     *
18822     * @param obj The gelinst object.
18823     * @param x The input x coordinate
18824     * @param y The input y coordinate
18825     * @param posret The position relative to the item returned here
18826     * @return The item at the coordinates or NULL if none
18827     *
18828     * This returns the item at the given coordinates (which are canvas
18829     * relative, not object-relative). If an item is at that coordinate,
18830     * that item handle is returned, and if @p posret is not NULL, the
18831     * integer pointed to is set to a value of -1, 0 or 1, depending if
18832     * the coordinate is on the upper portion of that item (-1), on the
18833     * middle section (0) or on the lower part (1). If NULL is returned as
18834     * an item (no item found there), then posret may indicate -1 or 1
18835     * based if the coordinate is above or below all items respectively in
18836     * the genlist.
18837     *
18838     * @ingroup Genlist
18839     */
18840    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);
18841    /**
18842     * Get the first item in the genlist
18843     *
18844     * This returns the first item in the list.
18845     *
18846     * @param obj The genlist object
18847     * @return The first item, or NULL if none
18848     *
18849     * @ingroup Genlist
18850     */
18851    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18852    /**
18853     * Get the last item in the genlist
18854     *
18855     * This returns the last item in the list.
18856     *
18857     * @return The last item, or NULL if none
18858     *
18859     * @ingroup Genlist
18860     */
18861    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18862    /**
18863     * Set the scrollbar policy
18864     *
18865     * @param obj The genlist object
18866     * @param policy_h Horizontal scrollbar policy.
18867     * @param policy_v Vertical scrollbar policy.
18868     *
18869     * This sets the scrollbar visibility policy for the given genlist
18870     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18871     * made visible if it is needed, and otherwise kept hidden.
18872     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18873     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18874     * respectively for the horizontal and vertical scrollbars. Default is
18875     * #ELM_SMART_SCROLLER_POLICY_AUTO
18876     *
18877     * @see elm_genlist_scroller_policy_get()
18878     *
18879     * @ingroup Genlist
18880     */
18881    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18882    /**
18883     * Get the scrollbar policy
18884     *
18885     * @param obj The genlist object
18886     * @param policy_h Pointer to store the horizontal scrollbar policy.
18887     * @param policy_v Pointer to store the vertical scrollbar policy.
18888     *
18889     * @see elm_genlist_scroller_policy_set()
18890     *
18891     * @ingroup Genlist
18892     */
18893    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);
18894    /**
18895     * Get the @b next item in a genlist widget's internal list of items,
18896     * given a handle to one of those items.
18897     *
18898     * @param item The genlist item to fetch next from
18899     * @return The item after @p item, or @c NULL if there's none (and
18900     * on errors)
18901     *
18902     * This returns the item placed after the @p item, on the container
18903     * genlist.
18904     *
18905     * @see elm_genlist_item_prev_get()
18906     *
18907     * @ingroup Genlist
18908     */
18909    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18910    /**
18911     * Get the @b previous item in a genlist widget's internal list of items,
18912     * given a handle to one of those items.
18913     *
18914     * @param item The genlist item to fetch previous from
18915     * @return The item before @p item, or @c NULL if there's none (and
18916     * on errors)
18917     *
18918     * This returns the item placed before the @p item, on the container
18919     * genlist.
18920     *
18921     * @see elm_genlist_item_next_get()
18922     *
18923     * @ingroup Genlist
18924     */
18925    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18926    /**
18927     * Get the genlist object's handle which contains a given genlist
18928     * item
18929     *
18930     * @param item The item to fetch the container from
18931     * @return The genlist (parent) object
18932     *
18933     * This returns the genlist object itself that an item belongs to.
18934     *
18935     * @ingroup Genlist
18936     */
18937    EINA_DEPRECATED EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18938    /**
18939     * Get the parent item of the given item
18940     *
18941     * @param it The item
18942     * @return The parent of the item or @c NULL if it has no parent.
18943     *
18944     * This returns the item that was specified as parent of the item @p it on
18945     * elm_genlist_item_append() and insertion related functions.
18946     *
18947     * @ingroup Genlist
18948     */
18949    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18950    /**
18951     * Remove all sub-items (children) of the given item
18952     *
18953     * @param it The item
18954     *
18955     * This removes all items that are children (and their descendants) of the
18956     * given item @p it.
18957     *
18958     * @see elm_genlist_clear()
18959     * @see elm_genlist_item_del()
18960     *
18961     * @ingroup Genlist
18962     */
18963    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18964    /**
18965     * Set whether a given genlist item is selected or not
18966     *
18967     * @param it The item
18968     * @param selected Use @c EINA_TRUE, to make it selected, @c
18969     * EINA_FALSE to make it unselected
18970     *
18971     * This sets the selected state of an item. If multi selection is
18972     * not enabled on the containing genlist and @p selected is @c
18973     * EINA_TRUE, any other previously selected items will get
18974     * unselected in favor of this new one.
18975     *
18976     * @see elm_genlist_item_selected_get()
18977     *
18978     * @ingroup Genlist
18979     */
18980    EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18981    /**
18982     * Get whether a given genlist item is selected or not
18983     *
18984     * @param it The item
18985     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18986     *
18987     * @see elm_genlist_item_selected_set() for more details
18988     *
18989     * @ingroup Genlist
18990     */
18991    EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18992    /**
18993     * Sets the expanded state of an item.
18994     *
18995     * @param it The item
18996     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18997     *
18998     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18999     * expanded or not.
19000     *
19001     * The theme will respond to this change visually, and a signal "expanded" or
19002     * "contracted" will be sent from the genlist with a pointer to the item that
19003     * has been expanded/contracted.
19004     *
19005     * Calling this function won't show or hide any child of this item (if it is
19006     * a parent). You must manually delete and create them on the callbacks fo
19007     * the "expanded" or "contracted" signals.
19008     *
19009     * @see elm_genlist_item_expanded_get()
19010     *
19011     * @ingroup Genlist
19012     */
19013    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19014    /**
19015     * Get the expanded state of an item
19016     *
19017     * @param it The item
19018     * @return The expanded state
19019     *
19020     * This gets the expanded state of an item.
19021     *
19022     * @see elm_genlist_item_expanded_set()
19023     *
19024     * @ingroup Genlist
19025     */
19026    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19027    /**
19028     * Get the depth of expanded item
19029     *
19030     * @param it The genlist item object
19031     * @return The depth of expanded item
19032     *
19033     * @ingroup Genlist
19034     */
19035    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19036    /**
19037     * Set whether a given genlist item is disabled or not.
19038     *
19039     * @param it The item
19040     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19041     * to enable it back.
19042     *
19043     * A disabled item cannot be selected or unselected. It will also
19044     * change its appearance, to signal the user it's disabled.
19045     *
19046     * @see elm_genlist_item_disabled_get()
19047     *
19048     * @ingroup Genlist
19049     */
19050    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19051    /**
19052     * Get whether a given genlist item is disabled or not.
19053     *
19054     * @param it The item
19055     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19056     * (and on errors).
19057     *
19058     * @see elm_genlist_item_disabled_set() for more details
19059     *
19060     * @ingroup Genlist
19061     */
19062    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19063    /**
19064     * Sets the display only state of an item.
19065     *
19066     * @param it The item
19067     * @param display_only @c EINA_TRUE if the item is display only, @c
19068     * EINA_FALSE otherwise.
19069     *
19070     * A display only item cannot be selected or unselected. It is for
19071     * display only and not selecting or otherwise clicking, dragging
19072     * etc. by the user, thus finger size rules will not be applied to
19073     * this item.
19074     *
19075     * It's good to set group index items to display only state.
19076     *
19077     * @see elm_genlist_item_display_only_get()
19078     *
19079     * @ingroup Genlist
19080     */
19081    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19082    /**
19083     * Get the display only state of an item
19084     *
19085     * @param it The item
19086     * @return @c EINA_TRUE if the item is display only, @c
19087     * EINA_FALSE otherwise.
19088     *
19089     * @see elm_genlist_item_display_only_set()
19090     *
19091     * @ingroup Genlist
19092     */
19093    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19094    /**
19095     * Show the portion of a genlist's internal list containing a given
19096     * item, immediately.
19097     *
19098     * @param it The item to display
19099     *
19100     * This causes genlist to jump to the given item @p it and show it (by
19101     * immediately scrolling to that position), if it is not fully visible.
19102     *
19103     * @see elm_genlist_item_bring_in()
19104     * @see elm_genlist_item_top_show()
19105     * @see elm_genlist_item_middle_show()
19106     *
19107     * @ingroup Genlist
19108     */
19109    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19110    /**
19111     * Animatedly bring in, to the visible are of a genlist, a given
19112     * item on it.
19113     *
19114     * @param it The item to display
19115     *
19116     * This causes genlist to jump to the given item @p it and show it (by
19117     * animatedly scrolling), if it is not fully visible. This may use animation
19118     * to do so and take a period of time
19119     *
19120     * @see elm_genlist_item_show()
19121     * @see elm_genlist_item_top_bring_in()
19122     * @see elm_genlist_item_middle_bring_in()
19123     *
19124     * @ingroup Genlist
19125     */
19126    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19127    /**
19128     * Show the portion of a genlist's internal list containing a given
19129     * item, immediately.
19130     *
19131     * @param it The item to display
19132     *
19133     * This causes genlist to jump to the given item @p it and show it (by
19134     * immediately scrolling to that position), if it is not fully visible.
19135     *
19136     * The item will be positioned at the top of the genlist viewport.
19137     *
19138     * @see elm_genlist_item_show()
19139     * @see elm_genlist_item_top_bring_in()
19140     *
19141     * @ingroup Genlist
19142     */
19143    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19144    /**
19145     * Animatedly bring in, to the visible are of a genlist, a given
19146     * item on it.
19147     *
19148     * @param it The item
19149     *
19150     * This causes genlist to jump to the given item @p it and show it (by
19151     * animatedly scrolling), if it is not fully visible. This may use animation
19152     * to do so and take a period of time
19153     *
19154     * The item will be positioned at the top of the genlist viewport.
19155     *
19156     * @see elm_genlist_item_bring_in()
19157     * @see elm_genlist_item_top_show()
19158     *
19159     * @ingroup Genlist
19160     */
19161    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19162    /**
19163     * Show the portion of a genlist's internal list containing a given
19164     * item, immediately.
19165     *
19166     * @param it The item to display
19167     *
19168     * This causes genlist to jump to the given item @p it and show it (by
19169     * immediately scrolling to that position), if it is not fully visible.
19170     *
19171     * The item will be positioned at the middle of the genlist viewport.
19172     *
19173     * @see elm_genlist_item_show()
19174     * @see elm_genlist_item_middle_bring_in()
19175     *
19176     * @ingroup Genlist
19177     */
19178    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19179    /**
19180     * Animatedly bring in, to the visible are of a genlist, a given
19181     * item on it.
19182     *
19183     * @param it The item
19184     *
19185     * This causes genlist to jump to the given item @p it and show it (by
19186     * animatedly scrolling), if it is not fully visible. This may use animation
19187     * to do so and take a period of time
19188     *
19189     * The item will be positioned at the middle of the genlist viewport.
19190     *
19191     * @see elm_genlist_item_bring_in()
19192     * @see elm_genlist_item_middle_show()
19193     *
19194     * @ingroup Genlist
19195     */
19196    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19197    /**
19198     * Remove a genlist item from the its parent, deleting it.
19199     *
19200     * @param item The item to be removed.
19201     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19202     *
19203     * @see elm_genlist_clear(), to remove all items in a genlist at
19204     * once.
19205     *
19206     * @ingroup Genlist
19207     */
19208    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19209    /**
19210     * Return the data associated to a given genlist item
19211     *
19212     * @param item The genlist item.
19213     * @return the data associated to this item.
19214     *
19215     * This returns the @c data value passed on the
19216     * elm_genlist_item_append() and related item addition calls.
19217     *
19218     * @see elm_genlist_item_append()
19219     * @see elm_genlist_item_data_set()
19220     *
19221     * @ingroup Genlist
19222     */
19223    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19224    /**
19225     * Set the data associated to a given genlist item
19226     *
19227     * @param item The genlist item
19228     * @param data The new data pointer to set on it
19229     *
19230     * This @b overrides the @c data value passed on the
19231     * elm_genlist_item_append() and related item addition calls. This
19232     * function @b won't call elm_genlist_item_update() automatically,
19233     * so you'd issue it afterwards if you want to hove the item
19234     * updated to reflect the that new data.
19235     *
19236     * @see elm_genlist_item_data_get()
19237     *
19238     * @ingroup Genlist
19239     */
19240    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19241    /**
19242     * Tells genlist to "orphan" icons fetchs by the item class
19243     *
19244     * @param it The item
19245     *
19246     * This instructs genlist to release references to icons in the item,
19247     * meaning that they will no longer be managed by genlist and are
19248     * floating "orphans" that can be re-used elsewhere if the user wants
19249     * to.
19250     *
19251     * @ingroup Genlist
19252     */
19253    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19254    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19255    /**
19256     * Get the real Evas object created to implement the view of a
19257     * given genlist item
19258     *
19259     * @param item The genlist item.
19260     * @return the Evas object implementing this item's view.
19261     *
19262     * This returns the actual Evas object used to implement the
19263     * specified genlist item's view. This may be @c NULL, as it may
19264     * not have been created or may have been deleted, at any time, by
19265     * the genlist. <b>Do not modify this object</b> (move, resize,
19266     * show, hide, etc.), as the genlist is controlling it. This
19267     * function is for querying, emitting custom signals or hooking
19268     * lower level callbacks for events on that object. Do not delete
19269     * this object under any circumstances.
19270     *
19271     * @see elm_genlist_item_data_get()
19272     *
19273     * @ingroup Genlist
19274     */
19275    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19276    /**
19277     * Update the contents of an item
19278     *
19279     * @param it The item
19280     *
19281     * This updates an item by calling all the item class functions again
19282     * to get the icons, labels and states. Use this when the original
19283     * item data has changed and the changes are desired to be reflected.
19284     *
19285     * Use elm_genlist_realized_items_update() to update all already realized
19286     * items.
19287     *
19288     * @see elm_genlist_realized_items_update()
19289     *
19290     * @ingroup Genlist
19291     */
19292    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19293    /**
19294     * Update the item class of an item
19295     *
19296     * @param it The item
19297     * @param itc The item class for the item
19298     *
19299     * This sets another class fo the item, changing the way that it is
19300     * displayed. After changing the item class, elm_genlist_item_update() is
19301     * called on the item @p it.
19302     *
19303     * @ingroup Genlist
19304     */
19305    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19306    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19307    /**
19308     * Set the text to be shown in a given genlist item's tooltips.
19309     *
19310     * @param item The genlist item
19311     * @param text The text to set in the content
19312     *
19313     * This call will setup the text to be used as tooltip to that item
19314     * (analogous to elm_object_tooltip_text_set(), but being item
19315     * tooltips with higher precedence than object tooltips). It can
19316     * have only one tooltip at a time, so any previous tooltip data
19317     * will get removed.
19318     *
19319     * In order to set an icon or something else as a tooltip, look at
19320     * elm_genlist_item_tooltip_content_cb_set().
19321     *
19322     * @ingroup Genlist
19323     */
19324    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19325    /**
19326     * Set the content to be shown in a given genlist item's tooltips
19327     *
19328     * @param item The genlist item.
19329     * @param func The function returning the tooltip contents.
19330     * @param data What to provide to @a func as callback data/context.
19331     * @param del_cb Called when data is not needed anymore, either when
19332     *        another callback replaces @p func, the tooltip is unset with
19333     *        elm_genlist_item_tooltip_unset() or the owner @p item
19334     *        dies. This callback receives as its first parameter the
19335     *        given @p data, being @c event_info the item handle.
19336     *
19337     * This call will setup the tooltip's contents to @p item
19338     * (analogous to elm_object_tooltip_content_cb_set(), but being
19339     * item tooltips with higher precedence than object tooltips). It
19340     * can have only one tooltip at a time, so any previous tooltip
19341     * content will get removed. @p func (with @p data) will be called
19342     * every time Elementary needs to show the tooltip and it should
19343     * return a valid Evas object, which will be fully managed by the
19344     * tooltip system, getting deleted when the tooltip is gone.
19345     *
19346     * In order to set just a text as a tooltip, look at
19347     * elm_genlist_item_tooltip_text_set().
19348     *
19349     * @ingroup Genlist
19350     */
19351    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);
19352    /**
19353     * Unset a tooltip from a given genlist item
19354     *
19355     * @param item genlist item to remove a previously set tooltip from.
19356     *
19357     * This call removes any tooltip set on @p item. The callback
19358     * provided as @c del_cb to
19359     * elm_genlist_item_tooltip_content_cb_set() will be called to
19360     * notify it is not used anymore (and have resources cleaned, if
19361     * need be).
19362     *
19363     * @see elm_genlist_item_tooltip_content_cb_set()
19364     *
19365     * @ingroup Genlist
19366     */
19367    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19368    /**
19369     * Set a different @b style for a given genlist item's tooltip.
19370     *
19371     * @param item genlist item with tooltip set
19372     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19373     * "default", @c "transparent", etc)
19374     *
19375     * Tooltips can have <b>alternate styles</b> to be displayed on,
19376     * which are defined by the theme set on Elementary. This function
19377     * works analogously as elm_object_tooltip_style_set(), but here
19378     * applied only to genlist item objects. The default style for
19379     * tooltips is @c "default".
19380     *
19381     * @note before you set a style you should define a tooltip with
19382     *       elm_genlist_item_tooltip_content_cb_set() or
19383     *       elm_genlist_item_tooltip_text_set()
19384     *
19385     * @see elm_genlist_item_tooltip_style_get()
19386     *
19387     * @ingroup Genlist
19388     */
19389    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19390    /**
19391     * Get the style set a given genlist item's tooltip.
19392     *
19393     * @param item genlist item with tooltip already set on.
19394     * @return style the theme style in use, which defaults to
19395     *         "default". If the object does not have a tooltip set,
19396     *         then @c NULL is returned.
19397     *
19398     * @see elm_genlist_item_tooltip_style_set() for more details
19399     *
19400     * @ingroup Genlist
19401     */
19402    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19403    /**
19404     * @brief Disable size restrictions on an object's tooltip
19405     * @param item The tooltip's anchor object
19406     * @param disable If EINA_TRUE, size restrictions are disabled
19407     * @return EINA_FALSE on failure, EINA_TRUE on success
19408     *
19409     * This function allows a tooltip to expand beyond its parant window's canvas.
19410     * It will instead be limited only by the size of the display.
19411     */
19412    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19413    /**
19414     * @brief Retrieve size restriction state of an object's tooltip
19415     * @param item The tooltip's anchor object
19416     * @return If EINA_TRUE, size restrictions are disabled
19417     *
19418     * This function returns whether a tooltip is allowed to expand beyond
19419     * its parant window's canvas.
19420     * It will instead be limited only by the size of the display.
19421     */
19422    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19423    /**
19424     * Set the type of mouse pointer/cursor decoration to be shown,
19425     * when the mouse pointer is over the given genlist widget item
19426     *
19427     * @param item genlist item to customize cursor on
19428     * @param cursor the cursor type's name
19429     *
19430     * This function works analogously as elm_object_cursor_set(), but
19431     * here the cursor's changing area is restricted to the item's
19432     * area, and not the whole widget's. Note that that item cursors
19433     * have precedence over widget cursors, so that a mouse over @p
19434     * item will always show cursor @p type.
19435     *
19436     * If this function is called twice for an object, a previously set
19437     * cursor will be unset on the second call.
19438     *
19439     * @see elm_object_cursor_set()
19440     * @see elm_genlist_item_cursor_get()
19441     * @see elm_genlist_item_cursor_unset()
19442     *
19443     * @ingroup Genlist
19444     */
19445    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19446    /**
19447     * Get the type of mouse pointer/cursor decoration set to be shown,
19448     * when the mouse pointer is over the given genlist widget item
19449     *
19450     * @param item genlist item with custom cursor set
19451     * @return the cursor type's name or @c NULL, if no custom cursors
19452     * were set to @p item (and on errors)
19453     *
19454     * @see elm_object_cursor_get()
19455     * @see elm_genlist_item_cursor_set() for more details
19456     * @see elm_genlist_item_cursor_unset()
19457     *
19458     * @ingroup Genlist
19459     */
19460    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19461    /**
19462     * Unset any custom mouse pointer/cursor decoration set to be
19463     * shown, when the mouse pointer is over the given genlist widget
19464     * item, thus making it show the @b default cursor again.
19465     *
19466     * @param item a genlist item
19467     *
19468     * Use this call to undo any custom settings on this item's cursor
19469     * decoration, bringing it back to defaults (no custom style set).
19470     *
19471     * @see elm_object_cursor_unset()
19472     * @see elm_genlist_item_cursor_set() for more details
19473     *
19474     * @ingroup Genlist
19475     */
19476    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19477    /**
19478     * Set a different @b style for a given custom cursor set for a
19479     * genlist item.
19480     *
19481     * @param item genlist item with custom cursor set
19482     * @param style the <b>theme style</b> to use (e.g. @c "default",
19483     * @c "transparent", etc)
19484     *
19485     * This function only makes sense when one is using custom mouse
19486     * cursor decorations <b>defined in a theme file</b> , which can
19487     * have, given a cursor name/type, <b>alternate styles</b> on
19488     * it. It works analogously as elm_object_cursor_style_set(), but
19489     * here applied only to genlist item objects.
19490     *
19491     * @warning Before you set a cursor style you should have defined a
19492     *       custom cursor previously on the item, with
19493     *       elm_genlist_item_cursor_set()
19494     *
19495     * @see elm_genlist_item_cursor_engine_only_set()
19496     * @see elm_genlist_item_cursor_style_get()
19497     *
19498     * @ingroup Genlist
19499     */
19500    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19501    /**
19502     * Get the current @b style set for a given genlist item's custom
19503     * cursor
19504     *
19505     * @param item genlist item with custom cursor set.
19506     * @return style the cursor style in use. If the object does not
19507     *         have a cursor set, then @c NULL is returned.
19508     *
19509     * @see elm_genlist_item_cursor_style_set() for more details
19510     *
19511     * @ingroup Genlist
19512     */
19513    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19514    /**
19515     * Set if the (custom) cursor for a given genlist item should be
19516     * searched in its theme, also, or should only rely on the
19517     * rendering engine.
19518     *
19519     * @param item item with custom (custom) cursor already set on
19520     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19521     * only on those provided by the rendering engine, @c EINA_FALSE to
19522     * have them searched on the widget's theme, as well.
19523     *
19524     * @note This call is of use only if you've set a custom cursor
19525     * for genlist items, with elm_genlist_item_cursor_set().
19526     *
19527     * @note By default, cursors will only be looked for between those
19528     * provided by the rendering engine.
19529     *
19530     * @ingroup Genlist
19531     */
19532    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19533    /**
19534     * Get if the (custom) cursor for a given genlist item is being
19535     * searched in its theme, also, or is only relying on the rendering
19536     * engine.
19537     *
19538     * @param item a genlist item
19539     * @return @c EINA_TRUE, if cursors are being looked for only on
19540     * those provided by the rendering engine, @c EINA_FALSE if they
19541     * are being searched on the widget's theme, as well.
19542     *
19543     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19544     *
19545     * @ingroup Genlist
19546     */
19547    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19548    /**
19549     * Update the contents of all realized items.
19550     *
19551     * @param obj The genlist object.
19552     *
19553     * This updates all realized items by calling all the item class functions again
19554     * to get the icons, labels and states. Use this when the original
19555     * item data has changed and the changes are desired to be reflected.
19556     *
19557     * To update just one item, use elm_genlist_item_update().
19558     *
19559     * @see elm_genlist_realized_items_get()
19560     * @see elm_genlist_item_update()
19561     *
19562     * @ingroup Genlist
19563     */
19564    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19565    /**
19566     * Activate a genlist mode on an item
19567     *
19568     * @param item The genlist item
19569     * @param mode Mode name
19570     * @param mode_set Boolean to define set or unset mode.
19571     *
19572     * A genlist mode is a different way of selecting an item. Once a mode is
19573     * activated on an item, any other selected item is immediately unselected.
19574     * This feature provides an easy way of implementing a new kind of animation
19575     * for selecting an item, without having to entirely rewrite the item style
19576     * theme. However, the elm_genlist_selected_* API can't be used to get what
19577     * item is activate for a mode.
19578     *
19579     * The current item style will still be used, but applying a genlist mode to
19580     * an item will select it using a different kind of animation.
19581     *
19582     * The current active item for a mode can be found by
19583     * elm_genlist_mode_item_get().
19584     *
19585     * The characteristics of genlist mode are:
19586     * - Only one mode can be active at any time, and for only one item.
19587     * - Genlist handles deactivating other items when one item is activated.
19588     * - A mode is defined in the genlist theme (edc), and more modes can easily
19589     *   be added.
19590     * - A mode style and the genlist item style are different things. They
19591     *   can be combined to provide a default style to the item, with some kind
19592     *   of animation for that item when the mode is activated.
19593     *
19594     * When a mode is activated on an item, a new view for that item is created.
19595     * The theme of this mode defines the animation that will be used to transit
19596     * the item from the old view to the new view. This second (new) view will be
19597     * active for that item while the mode is active on the item, and will be
19598     * destroyed after the mode is totally deactivated from that item.
19599     *
19600     * @see elm_genlist_mode_get()
19601     * @see elm_genlist_mode_item_get()
19602     *
19603     * @ingroup Genlist
19604     */
19605    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19606    /**
19607     * Get the last (or current) genlist mode used.
19608     *
19609     * @param obj The genlist object
19610     *
19611     * This function just returns the name of the last used genlist mode. It will
19612     * be the current mode if it's still active.
19613     *
19614     * @see elm_genlist_item_mode_set()
19615     * @see elm_genlist_mode_item_get()
19616     *
19617     * @ingroup Genlist
19618     */
19619    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19620    /**
19621     * Get active genlist mode item
19622     *
19623     * @param obj The genlist object
19624     * @return The active item for that current mode. Or @c NULL if no item is
19625     * activated with any mode.
19626     *
19627     * This function returns the item that was activated with a mode, by the
19628     * function elm_genlist_item_mode_set().
19629     *
19630     * @see elm_genlist_item_mode_set()
19631     * @see elm_genlist_mode_get()
19632     *
19633     * @ingroup Genlist
19634     */
19635    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19636
19637    /**
19638     * Set reorder mode
19639     *
19640     * @param obj The genlist object
19641     * @param reorder_mode The reorder mode
19642     * (EINA_TRUE = on, EINA_FALSE = off)
19643     *
19644     * @ingroup Genlist
19645     */
19646    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19647
19648    /**
19649     * Get the reorder mode
19650     *
19651     * @param obj The genlist object
19652     * @return The reorder mode
19653     * (EINA_TRUE = on, EINA_FALSE = off)
19654     *
19655     * @ingroup Genlist
19656     */
19657    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19658
19659    /**
19660     * @}
19661     */
19662
19663    /**
19664     * @defgroup Check Check
19665     *
19666     * @image html img/widget/check/preview-00.png
19667     * @image latex img/widget/check/preview-00.eps
19668     * @image html img/widget/check/preview-01.png
19669     * @image latex img/widget/check/preview-01.eps
19670     * @image html img/widget/check/preview-02.png
19671     * @image latex img/widget/check/preview-02.eps
19672     *
19673     * @brief The check widget allows for toggling a value between true and
19674     * false.
19675     *
19676     * Check objects are a lot like radio objects in layout and functionality
19677     * except they do not work as a group, but independently and only toggle the
19678     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19679     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19680     * returns the current state. For convenience, like the radio objects, you
19681     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19682     * for it to modify.
19683     *
19684     * Signals that you can add callbacks for are:
19685     * "changed" - This is called whenever the user changes the state of one of
19686     *             the check object(event_info is NULL).
19687     *
19688     * Default contents parts of the check widget that you can use for are:
19689     * @li "elm.swallow.content" - A icon of the check
19690     *
19691     * Default text parts of the check widget that you can use for are:
19692     * @li "elm.text" - Label of the check
19693     *
19694     * @ref tutorial_check should give you a firm grasp of how to use this widget
19695     * .
19696     * @{
19697     */
19698    /**
19699     * @brief Add a new Check object
19700     *
19701     * @param parent The parent object
19702     * @return The new object or NULL if it cannot be created
19703     */
19704    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19705    /**
19706     * @brief Set the text label of the check object
19707     *
19708     * @param obj The check object
19709     * @param label The text label string in UTF-8
19710     *
19711     * @deprecated use elm_object_text_set() instead.
19712     */
19713    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19714    /**
19715     * @brief Get the text label of the check object
19716     *
19717     * @param obj The check object
19718     * @return The text label string in UTF-8
19719     *
19720     * @deprecated use elm_object_text_get() instead.
19721     */
19722    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19723    /**
19724     * @brief Set the icon object of the check object
19725     *
19726     * @param obj The check object
19727     * @param icon The icon object
19728     *
19729     * Once the icon object is set, a previously set one will be deleted.
19730     * If you want to keep that old content object, use the
19731     * elm_object_content_unset() function.
19732     */
19733    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19734    /**
19735     * @brief Get the icon object of the check object
19736     *
19737     * @param obj The check object
19738     * @return The icon object
19739     */
19740    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19741    /**
19742     * @brief Unset the icon used for the check object
19743     *
19744     * @param obj The check object
19745     * @return The icon object that was being used
19746     *
19747     * Unparent and return the icon object which was set for this widget.
19748     */
19749    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19750    /**
19751     * @brief Set the on/off state of the check object
19752     *
19753     * @param obj The check object
19754     * @param state The state to use (1 == on, 0 == off)
19755     *
19756     * This sets the state of the check. If set
19757     * with elm_check_state_pointer_set() the state of that variable is also
19758     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19759     */
19760    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19761    /**
19762     * @brief Get the state of the check object
19763     *
19764     * @param obj The check object
19765     * @return The boolean state
19766     */
19767    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19768    /**
19769     * @brief Set a convenience pointer to a boolean to change
19770     *
19771     * @param obj The check object
19772     * @param statep Pointer to the boolean to modify
19773     *
19774     * This sets a pointer to a boolean, that, in addition to the check objects
19775     * state will also be modified directly. To stop setting the object pointed
19776     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19777     * then when this is called, the check objects state will also be modified to
19778     * reflect the value of the boolean @p statep points to, just like calling
19779     * elm_check_state_set().
19780     */
19781    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19782    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19783    EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
19784
19785    /**
19786     * @}
19787     */
19788
19789    /**
19790     * @defgroup Radio Radio
19791     *
19792     * @image html img/widget/radio/preview-00.png
19793     * @image latex img/widget/radio/preview-00.eps
19794     *
19795     * @brief Radio is a widget that allows for 1 or more options to be displayed
19796     * and have the user choose only 1 of them.
19797     *
19798     * A radio object contains an indicator, an optional Label and an optional
19799     * icon object. While it's possible to have a group of only one radio they,
19800     * are normally used in groups of 2 or more. To add a radio to a group use
19801     * elm_radio_group_add(). The radio object(s) will select from one of a set
19802     * of integer values, so any value they are configuring needs to be mapped to
19803     * a set of integers. To configure what value that radio object represents,
19804     * use  elm_radio_state_value_set() to set the integer it represents. To set
19805     * the value the whole group(which one is currently selected) is to indicate
19806     * use elm_radio_value_set() on any group member, and to get the groups value
19807     * use elm_radio_value_get(). For convenience the radio objects are also able
19808     * to directly set an integer(int) to the value that is selected. To specify
19809     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19810     * The radio objects will modify this directly. That implies the pointer must
19811     * point to valid memory for as long as the radio objects exist.
19812     *
19813     * Signals that you can add callbacks for are:
19814     * @li changed - This is called whenever the user changes the state of one of
19815     * the radio objects within the group of radio objects that work together.
19816     *
19817     * Default contents parts of the radio widget that you can use for are:
19818     * @li "elm.swallow.content" - A icon of the radio
19819     *
19820     * @ref tutorial_radio show most of this API in action.
19821     * @{
19822     */
19823    /**
19824     * @brief Add a new radio to the parent
19825     *
19826     * @param parent The parent object
19827     * @return The new object or NULL if it cannot be created
19828     */
19829    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19830    /**
19831     * @brief Set the text label of the radio object
19832     *
19833     * @param obj The radio object
19834     * @param label The text label string in UTF-8
19835     *
19836     * @deprecated use elm_object_text_set() instead.
19837     */
19838    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19839    /**
19840     * @brief Get the text label of the radio object
19841     *
19842     * @param obj The radio object
19843     * @return The text label string in UTF-8
19844     *
19845     * @deprecated use elm_object_text_set() instead.
19846     */
19847    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19848    /**
19849     * @brief Set the icon object of the radio object
19850     *
19851     * @param obj The radio object
19852     * @param icon The icon object
19853     *
19854     * Once the icon object is set, a previously set one will be deleted. If you
19855     * want to keep that old content object, use the elm_radio_icon_unset()
19856     * function.
19857     */
19858    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19859    /**
19860     * @brief Get the icon object of the radio object
19861     *
19862     * @param obj The radio object
19863     * @return The icon object
19864     *
19865     * @see elm_radio_icon_set()
19866     */
19867    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19868    /**
19869     * @brief Unset the icon used for the radio object
19870     *
19871     * @param obj The radio object
19872     * @return The icon object that was being used
19873     *
19874     * Unparent and return the icon object which was set for this widget.
19875     *
19876     * @see elm_radio_icon_set()
19877     */
19878    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19879    /**
19880     * @brief Add this radio to a group of other radio objects
19881     *
19882     * @param obj The radio object
19883     * @param group Any object whose group the @p obj is to join.
19884     *
19885     * Radio objects work in groups. Each member should have a different integer
19886     * value assigned. In order to have them work as a group, they need to know
19887     * about each other. This adds the given radio object to the group of which
19888     * the group object indicated is a member.
19889     */
19890    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19891    /**
19892     * @brief Set the integer value that this radio object represents
19893     *
19894     * @param obj The radio object
19895     * @param value The value to use if this radio object is selected
19896     *
19897     * This sets the value of the radio.
19898     */
19899    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19900    /**
19901     * @brief Get the integer value that this radio object represents
19902     *
19903     * @param obj The radio object
19904     * @return The value used if this radio object is selected
19905     *
19906     * This gets the value of the radio.
19907     *
19908     * @see elm_radio_value_set()
19909     */
19910    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19911    /**
19912     * @brief Set the value of the radio.
19913     *
19914     * @param obj The radio object
19915     * @param value The value to use for the group
19916     *
19917     * This sets the value of the radio group and will also set the value if
19918     * pointed to, to the value supplied, but will not call any callbacks.
19919     */
19920    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19921    /**
19922     * @brief Get the state of the radio object
19923     *
19924     * @param obj The radio object
19925     * @return The integer state
19926     */
19927    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19928    /**
19929     * @brief Set a convenience pointer to a integer to change
19930     *
19931     * @param obj The radio object
19932     * @param valuep Pointer to the integer to modify
19933     *
19934     * This sets a pointer to a integer, that, in addition to the radio objects
19935     * state will also be modified directly. To stop setting the object pointed
19936     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19937     * when this is called, the radio objects state will also be modified to
19938     * reflect the value of the integer valuep points to, just like calling
19939     * elm_radio_value_set().
19940     */
19941    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19942    /**
19943     * @}
19944     */
19945
19946    /**
19947     * @defgroup Pager Pager
19948     *
19949     * @image html img/widget/pager/preview-00.png
19950     * @image latex img/widget/pager/preview-00.eps
19951     *
19952     * @brief Widget that allows flipping between 1 or more “pages” of objects.
19953     *
19954     * The flipping between “pages” of objects is animated. All content in pager
19955     * is kept in a stack, the last content to be added will be on the top of the
19956     * stack(be visible).
19957     *
19958     * Objects can be pushed or popped from the stack or deleted as normal.
19959     * Pushes and pops will animate (and a pop will delete the object once the
19960     * animation is finished). Any object already in the pager can be promoted to
19961     * the top(from its current stacking position) through the use of
19962     * elm_pager_content_promote(). Objects are pushed to the top with
19963     * elm_pager_content_push() and when the top item is no longer wanted, simply
19964     * pop it with elm_pager_content_pop() and it will also be deleted. If an
19965     * object is no longer needed and is not the top item, just delete it as
19966     * normal. You can query which objects are the top and bottom with
19967     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19968     *
19969     * Signals that you can add callbacks for are:
19970     * "hide,finished" - when the previous page is hided
19971     *
19972     * This widget has the following styles available:
19973     * @li default
19974     * @li fade
19975     * @li fade_translucide
19976     * @li fade_invisible
19977     * @note This styles affect only the flipping animations, the appearance when
19978     * not animating is unaffected by styles.
19979     *
19980     * @ref tutorial_pager gives a good overview of the usage of the API.
19981     * @{
19982     */
19983    /**
19984     * Add a new pager to the parent
19985     *
19986     * @param parent The parent object
19987     * @return The new object or NULL if it cannot be created
19988     *
19989     * @ingroup Pager
19990     */
19991    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19992    /**
19993     * @brief Push an object to the top of the pager stack (and show it).
19994     *
19995     * @param obj The pager object
19996     * @param content The object to push
19997     *
19998     * The object pushed becomes a child of the pager, it will be controlled and
19999     * deleted when the pager is deleted.
20000     *
20001     * @note If the content is already in the stack use
20002     * elm_pager_content_promote().
20003     * @warning Using this function on @p content already in the stack results in
20004     * undefined behavior.
20005     */
20006    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20007    /**
20008     * @brief Pop the object that is on top of the stack
20009     *
20010     * @param obj The pager object
20011     *
20012     * This pops the object that is on the top(visible) of the pager, makes it
20013     * disappear, then deletes the object. The object that was underneath it on
20014     * the stack will become visible.
20015     */
20016    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20017    /**
20018     * @brief Moves an object already in the pager stack to the top of the stack.
20019     *
20020     * @param obj The pager object
20021     * @param content The object to promote
20022     *
20023     * This will take the @p content and move it to the top of the stack as
20024     * if it had been pushed there.
20025     *
20026     * @note If the content isn't already in the stack use
20027     * elm_pager_content_push().
20028     * @warning Using this function on @p content not already in the stack
20029     * results in undefined behavior.
20030     */
20031    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20032    /**
20033     * @brief Return the object at the bottom of the pager stack
20034     *
20035     * @param obj The pager object
20036     * @return The bottom object or NULL if none
20037     */
20038    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20039    /**
20040     * @brief  Return the object at the top of the pager stack
20041     *
20042     * @param obj The pager object
20043     * @return The top object or NULL if none
20044     */
20045    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20046
20047    /**
20048     * @}
20049     */
20050
20051    /**
20052     * @defgroup Slideshow Slideshow
20053     *
20054     * @image html img/widget/slideshow/preview-00.png
20055     * @image latex img/widget/slideshow/preview-00.eps
20056     *
20057     * This widget, as the name indicates, is a pre-made image
20058     * slideshow panel, with API functions acting on (child) image
20059     * items presentation. Between those actions, are:
20060     * - advance to next/previous image
20061     * - select the style of image transition animation
20062     * - set the exhibition time for each image
20063     * - start/stop the slideshow
20064     *
20065     * The transition animations are defined in the widget's theme,
20066     * consequently new animations can be added without having to
20067     * update the widget's code.
20068     *
20069     * @section Slideshow_Items Slideshow items
20070     *
20071     * For slideshow items, just like for @ref Genlist "genlist" ones,
20072     * the user defines a @b classes, specifying functions that will be
20073     * called on the item's creation and deletion times.
20074     *
20075     * The #Elm_Slideshow_Item_Class structure contains the following
20076     * members:
20077     *
20078     * - @c func.get - When an item is displayed, this function is
20079     *   called, and it's where one should create the item object, de
20080     *   facto. For example, the object can be a pure Evas image object
20081     *   or an Elementary @ref Photocam "photocam" widget. See
20082     *   #SlideshowItemGetFunc.
20083     * - @c func.del - When an item is no more displayed, this function
20084     *   is called, where the user must delete any data associated to
20085     *   the item. See #SlideshowItemDelFunc.
20086     *
20087     * @section Slideshow_Caching Slideshow caching
20088     *
20089     * The slideshow provides facilities to have items adjacent to the
20090     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20091     * you, so that the system does not have to decode image data
20092     * anymore at the time it has to actually switch images on its
20093     * viewport. The user is able to set the numbers of items to be
20094     * cached @b before and @b after the current item, in the widget's
20095     * item list.
20096     *
20097     * Smart events one can add callbacks for are:
20098     *
20099     * - @c "changed" - when the slideshow switches its view to a new
20100     *   item
20101     *
20102     * List of examples for the slideshow widget:
20103     * @li @ref slideshow_example
20104     */
20105
20106    /**
20107     * @addtogroup Slideshow
20108     * @{
20109     */
20110
20111    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20112    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20113    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20114    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20115    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20116
20117    /**
20118     * @struct _Elm_Slideshow_Item_Class
20119     *
20120     * Slideshow item class definition. See @ref Slideshow_Items for
20121     * field details.
20122     */
20123    struct _Elm_Slideshow_Item_Class
20124      {
20125         struct _Elm_Slideshow_Item_Class_Func
20126           {
20127              SlideshowItemGetFunc get;
20128              SlideshowItemDelFunc del;
20129           } func;
20130      }; /**< #Elm_Slideshow_Item_Class member definitions */
20131
20132    /**
20133     * Add a new slideshow widget to the given parent Elementary
20134     * (container) object
20135     *
20136     * @param parent The parent object
20137     * @return A new slideshow widget handle or @c NULL, on errors
20138     *
20139     * This function inserts a new slideshow widget on the canvas.
20140     *
20141     * @ingroup Slideshow
20142     */
20143    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20144
20145    /**
20146     * Add (append) a new item in a given slideshow widget.
20147     *
20148     * @param obj The slideshow object
20149     * @param itc The item class for the item
20150     * @param data The item's data
20151     * @return A handle to the item added or @c NULL, on errors
20152     *
20153     * Add a new item to @p obj's internal list of items, appending it.
20154     * The item's class must contain the function really fetching the
20155     * image object to show for this item, which could be an Evas image
20156     * object or an Elementary photo, for example. The @p data
20157     * parameter is going to be passed to both class functions of the
20158     * item.
20159     *
20160     * @see #Elm_Slideshow_Item_Class
20161     * @see elm_slideshow_item_sorted_insert()
20162     *
20163     * @ingroup Slideshow
20164     */
20165    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20166
20167    /**
20168     * Insert a new item into the given slideshow widget, using the @p func
20169     * function to sort items (by item handles).
20170     *
20171     * @param obj The slideshow object
20172     * @param itc The item class for the item
20173     * @param data The item's data
20174     * @param func The comparing function to be used to sort slideshow
20175     * items <b>by #Elm_Slideshow_Item item handles</b>
20176     * @return Returns The slideshow item handle, on success, or
20177     * @c NULL, on errors
20178     *
20179     * Add a new item to @p obj's internal list of items, in a position
20180     * determined by the @p func comparing function. The item's class
20181     * must contain the function really fetching the image object to
20182     * show for this item, which could be an Evas image object or an
20183     * Elementary photo, for example. The @p data parameter is going to
20184     * be passed to both class functions of the item.
20185     *
20186     * @see #Elm_Slideshow_Item_Class
20187     * @see elm_slideshow_item_add()
20188     *
20189     * @ingroup Slideshow
20190     */
20191    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);
20192
20193    /**
20194     * Display a given slideshow widget's item, programmatically.
20195     *
20196     * @param obj The slideshow object
20197     * @param item The item to display on @p obj's viewport
20198     *
20199     * The change between the current item and @p item will use the
20200     * transition @p obj is set to use (@see
20201     * elm_slideshow_transition_set()).
20202     *
20203     * @ingroup Slideshow
20204     */
20205    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20206
20207    /**
20208     * Slide to the @b next item, in a given slideshow widget
20209     *
20210     * @param obj The slideshow object
20211     *
20212     * The sliding animation @p obj is set to use will be the
20213     * transition effect used, after this call is issued.
20214     *
20215     * @note If the end of the slideshow's internal list of items is
20216     * reached, it'll wrap around to the list's beginning, again.
20217     *
20218     * @ingroup Slideshow
20219     */
20220    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20221
20222    /**
20223     * Slide to the @b previous item, in a given slideshow widget
20224     *
20225     * @param obj The slideshow object
20226     *
20227     * The sliding animation @p obj is set to use will be the
20228     * transition effect used, after this call is issued.
20229     *
20230     * @note If the beginning of the slideshow's internal list of items
20231     * is reached, it'll wrap around to the list's end, again.
20232     *
20233     * @ingroup Slideshow
20234     */
20235    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20236
20237    /**
20238     * Returns the list of sliding transition/effect names available, for a
20239     * given slideshow widget.
20240     *
20241     * @param obj The slideshow object
20242     * @return The list of transitions (list of @b stringshared strings
20243     * as data)
20244     *
20245     * The transitions, which come from @p obj's theme, must be an EDC
20246     * data item named @c "transitions" on the theme file, with (prefix)
20247     * names of EDC programs actually implementing them.
20248     *
20249     * The available transitions for slideshows on the default theme are:
20250     * - @c "fade" - the current item fades out, while the new one
20251     *   fades in to the slideshow's viewport.
20252     * - @c "black_fade" - the current item fades to black, and just
20253     *   then, the new item will fade in.
20254     * - @c "horizontal" - the current item slides horizontally, until
20255     *   it gets out of the slideshow's viewport, while the new item
20256     *   comes from the left to take its place.
20257     * - @c "vertical" - the current item slides vertically, until it
20258     *   gets out of the slideshow's viewport, while the new item comes
20259     *   from the bottom to take its place.
20260     * - @c "square" - the new item starts to appear from the middle of
20261     *   the current one, but with a tiny size, growing until its
20262     *   target (full) size and covering the old one.
20263     *
20264     * @warning The stringshared strings get no new references
20265     * exclusive to the user grabbing the list, here, so if you'd like
20266     * to use them out of this call's context, you'd better @c
20267     * eina_stringshare_ref() them.
20268     *
20269     * @see elm_slideshow_transition_set()
20270     *
20271     * @ingroup Slideshow
20272     */
20273    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20274
20275    /**
20276     * Set the current slide transition/effect in use for a given
20277     * slideshow widget
20278     *
20279     * @param obj The slideshow object
20280     * @param transition The new transition's name string
20281     *
20282     * If @p transition is implemented in @p obj's theme (i.e., is
20283     * contained in the list returned by
20284     * elm_slideshow_transitions_get()), this new sliding effect will
20285     * be used on the widget.
20286     *
20287     * @see elm_slideshow_transitions_get() for more details
20288     *
20289     * @ingroup Slideshow
20290     */
20291    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20292
20293    /**
20294     * Get the current slide transition/effect in use for a given
20295     * slideshow widget
20296     *
20297     * @param obj The slideshow object
20298     * @return The current transition's name
20299     *
20300     * @see elm_slideshow_transition_set() for more details
20301     *
20302     * @ingroup Slideshow
20303     */
20304    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20305
20306    /**
20307     * Set the interval between each image transition on a given
20308     * slideshow widget, <b>and start the slideshow, itself</b>
20309     *
20310     * @param obj The slideshow object
20311     * @param timeout The new displaying timeout for images
20312     *
20313     * After this call, the slideshow widget will start cycling its
20314     * view, sequentially and automatically, with the images of the
20315     * items it has. The time between each new image displayed is going
20316     * to be @p timeout, in @b seconds. If a different timeout was set
20317     * previously and an slideshow was in progress, it will continue
20318     * with the new time between transitions, after this call.
20319     *
20320     * @note A value less than or equal to 0 on @p timeout will disable
20321     * the widget's internal timer, thus halting any slideshow which
20322     * could be happening on @p obj.
20323     *
20324     * @see elm_slideshow_timeout_get()
20325     *
20326     * @ingroup Slideshow
20327     */
20328    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20329
20330    /**
20331     * Get the interval set for image transitions on a given slideshow
20332     * widget.
20333     *
20334     * @param obj The slideshow object
20335     * @return Returns the timeout set on it
20336     *
20337     * @see elm_slideshow_timeout_set() for more details
20338     *
20339     * @ingroup Slideshow
20340     */
20341    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20342
20343    /**
20344     * Set if, after a slideshow is started, for a given slideshow
20345     * widget, its items should be displayed cyclically or not.
20346     *
20347     * @param obj The slideshow object
20348     * @param loop Use @c EINA_TRUE to make it cycle through items or
20349     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20350     * list of items
20351     *
20352     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20353     * ignore what is set by this functions, i.e., they'll @b always
20354     * cycle through items. This affects only the "automatic"
20355     * slideshow, as set by elm_slideshow_timeout_set().
20356     *
20357     * @see elm_slideshow_loop_get()
20358     *
20359     * @ingroup Slideshow
20360     */
20361    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20362
20363    /**
20364     * Get if, after a slideshow is started, for a given slideshow
20365     * widget, its items are to be displayed cyclically or not.
20366     *
20367     * @param obj The slideshow object
20368     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20369     * through or @c EINA_FALSE, otherwise
20370     *
20371     * @see elm_slideshow_loop_set() for more details
20372     *
20373     * @ingroup Slideshow
20374     */
20375    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20376
20377    /**
20378     * Remove all items from a given slideshow widget
20379     *
20380     * @param obj The slideshow object
20381     *
20382     * This removes (and deletes) all items in @p obj, leaving it
20383     * empty.
20384     *
20385     * @see elm_slideshow_item_del(), to remove just one item.
20386     *
20387     * @ingroup Slideshow
20388     */
20389    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20390
20391    /**
20392     * Get the internal list of items in a given slideshow widget.
20393     *
20394     * @param obj The slideshow object
20395     * @return The list of items (#Elm_Slideshow_Item as data) or
20396     * @c NULL on errors.
20397     *
20398     * This list is @b not to be modified in any way and must not be
20399     * freed. Use the list members with functions like
20400     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20401     *
20402     * @warning This list is only valid until @p obj object's internal
20403     * items list is changed. It should be fetched again with another
20404     * call to this function when changes happen.
20405     *
20406     * @ingroup Slideshow
20407     */
20408    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20409
20410    /**
20411     * Delete a given item from a slideshow widget.
20412     *
20413     * @param item The slideshow item
20414     *
20415     * @ingroup Slideshow
20416     */
20417    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20418
20419    /**
20420     * Return the data associated with a given slideshow item
20421     *
20422     * @param item The slideshow item
20423     * @return Returns the data associated to this item
20424     *
20425     * @ingroup Slideshow
20426     */
20427    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20428
20429    /**
20430     * Returns the currently displayed item, in a given slideshow widget
20431     *
20432     * @param obj The slideshow object
20433     * @return A handle to the item being displayed in @p obj or
20434     * @c NULL, if none is (and on errors)
20435     *
20436     * @ingroup Slideshow
20437     */
20438    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20439
20440    /**
20441     * Get the real Evas object created to implement the view of a
20442     * given slideshow item
20443     *
20444     * @param item The slideshow item.
20445     * @return the Evas object implementing this item's view.
20446     *
20447     * This returns the actual Evas object used to implement the
20448     * specified slideshow item's view. This may be @c NULL, as it may
20449     * not have been created or may have been deleted, at any time, by
20450     * the slideshow. <b>Do not modify this object</b> (move, resize,
20451     * show, hide, etc.), as the slideshow is controlling it. This
20452     * function is for querying, emitting custom signals or hooking
20453     * lower level callbacks for events on that object. Do not delete
20454     * this object under any circumstances.
20455     *
20456     * @see elm_slideshow_item_data_get()
20457     *
20458     * @ingroup Slideshow
20459     */
20460    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20461
20462    /**
20463     * Get the the item, in a given slideshow widget, placed at
20464     * position @p nth, in its internal items list
20465     *
20466     * @param obj The slideshow object
20467     * @param nth The number of the item to grab a handle to (0 being
20468     * the first)
20469     * @return The item stored in @p obj at position @p nth or @c NULL,
20470     * if there's no item with that index (and on errors)
20471     *
20472     * @ingroup Slideshow
20473     */
20474    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20475
20476    /**
20477     * Set the current slide layout in use for a given slideshow widget
20478     *
20479     * @param obj The slideshow object
20480     * @param layout The new layout's name string
20481     *
20482     * If @p layout is implemented in @p obj's theme (i.e., is contained
20483     * in the list returned by elm_slideshow_layouts_get()), this new
20484     * images layout will be used on the widget.
20485     *
20486     * @see elm_slideshow_layouts_get() for more details
20487     *
20488     * @ingroup Slideshow
20489     */
20490    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20491
20492    /**
20493     * Get the current slide layout in use for a given slideshow widget
20494     *
20495     * @param obj The slideshow object
20496     * @return The current layout's name
20497     *
20498     * @see elm_slideshow_layout_set() for more details
20499     *
20500     * @ingroup Slideshow
20501     */
20502    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20503
20504    /**
20505     * Returns the list of @b layout names available, for a given
20506     * slideshow widget.
20507     *
20508     * @param obj The slideshow object
20509     * @return The list of layouts (list of @b stringshared strings
20510     * as data)
20511     *
20512     * Slideshow layouts will change how the widget is to dispose each
20513     * image item in its viewport, with regard to cropping, scaling,
20514     * etc.
20515     *
20516     * The layouts, which come from @p obj's theme, must be an EDC
20517     * data item name @c "layouts" on the theme file, with (prefix)
20518     * names of EDC programs actually implementing them.
20519     *
20520     * The available layouts for slideshows on the default theme are:
20521     * - @c "fullscreen" - item images with original aspect, scaled to
20522     *   touch top and down slideshow borders or, if the image's heigh
20523     *   is not enough, left and right slideshow borders.
20524     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20525     *   one, but always leaving 10% of the slideshow's dimensions of
20526     *   distance between the item image's borders and the slideshow
20527     *   borders, for each axis.
20528     *
20529     * @warning The stringshared strings get no new references
20530     * exclusive to the user grabbing the list, here, so if you'd like
20531     * to use them out of this call's context, you'd better @c
20532     * eina_stringshare_ref() them.
20533     *
20534     * @see elm_slideshow_layout_set()
20535     *
20536     * @ingroup Slideshow
20537     */
20538    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20539
20540    /**
20541     * Set the number of items to cache, on a given slideshow widget,
20542     * <b>before the current item</b>
20543     *
20544     * @param obj The slideshow object
20545     * @param count Number of items to cache before the current one
20546     *
20547     * The default value for this property is @c 2. See
20548     * @ref Slideshow_Caching "slideshow caching" for more details.
20549     *
20550     * @see elm_slideshow_cache_before_get()
20551     *
20552     * @ingroup Slideshow
20553     */
20554    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20555
20556    /**
20557     * Retrieve the number of items to cache, on a given slideshow widget,
20558     * <b>before the current item</b>
20559     *
20560     * @param obj The slideshow object
20561     * @return The number of items set to be cached before the current one
20562     *
20563     * @see elm_slideshow_cache_before_set() for more details
20564     *
20565     * @ingroup Slideshow
20566     */
20567    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20568
20569    /**
20570     * Set the number of items to cache, on a given slideshow widget,
20571     * <b>after the current item</b>
20572     *
20573     * @param obj The slideshow object
20574     * @param count Number of items to cache after the current one
20575     *
20576     * The default value for this property is @c 2. See
20577     * @ref Slideshow_Caching "slideshow caching" for more details.
20578     *
20579     * @see elm_slideshow_cache_after_get()
20580     *
20581     * @ingroup Slideshow
20582     */
20583    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20584
20585    /**
20586     * Retrieve the number of items to cache, on a given slideshow widget,
20587     * <b>after the current item</b>
20588     *
20589     * @param obj The slideshow object
20590     * @return The number of items set to be cached after the current one
20591     *
20592     * @see elm_slideshow_cache_after_set() for more details
20593     *
20594     * @ingroup Slideshow
20595     */
20596    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20597
20598    /**
20599     * Get the number of items stored in a given slideshow widget
20600     *
20601     * @param obj The slideshow object
20602     * @return The number of items on @p obj, at the moment of this call
20603     *
20604     * @ingroup Slideshow
20605     */
20606    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20607
20608    /**
20609     * @}
20610     */
20611
20612    /**
20613     * @defgroup Fileselector File Selector
20614     *
20615     * @image html img/widget/fileselector/preview-00.png
20616     * @image latex img/widget/fileselector/preview-00.eps
20617     *
20618     * A file selector is a widget that allows a user to navigate
20619     * through a file system, reporting file selections back via its
20620     * API.
20621     *
20622     * It contains shortcut buttons for home directory (@c ~) and to
20623     * jump one directory upwards (..), as well as cancel/ok buttons to
20624     * confirm/cancel a given selection. After either one of those two
20625     * former actions, the file selector will issue its @c "done" smart
20626     * callback.
20627     *
20628     * There's a text entry on it, too, showing the name of the current
20629     * selection. There's the possibility of making it editable, so it
20630     * is useful on file saving dialogs on applications, where one
20631     * gives a file name to save contents to, in a given directory in
20632     * the system. This custom file name will be reported on the @c
20633     * "done" smart callback (explained in sequence).
20634     *
20635     * Finally, it has a view to display file system items into in two
20636     * possible forms:
20637     * - list
20638     * - grid
20639     *
20640     * If Elementary is built with support of the Ethumb thumbnailing
20641     * library, the second form of view will display preview thumbnails
20642     * of files which it supports.
20643     *
20644     * Smart callbacks one can register to:
20645     *
20646     * - @c "selected" - the user has clicked on a file (when not in
20647     *      folders-only mode) or directory (when in folders-only mode)
20648     * - @c "directory,open" - the list has been populated with new
20649     *      content (@c event_info is a pointer to the directory's
20650     *      path, a @b stringshared string)
20651     * - @c "done" - the user has clicked on the "ok" or "cancel"
20652     *      buttons (@c event_info is a pointer to the selection's
20653     *      path, a @b stringshared string)
20654     *
20655     * Here is an example on its usage:
20656     * @li @ref fileselector_example
20657     */
20658
20659    /**
20660     * @addtogroup Fileselector
20661     * @{
20662     */
20663
20664    /**
20665     * Defines how a file selector widget is to layout its contents
20666     * (file system entries).
20667     */
20668    typedef enum _Elm_Fileselector_Mode
20669      {
20670         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20671         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20672         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20673      } Elm_Fileselector_Mode;
20674
20675    /**
20676     * Add a new file selector widget to the given parent Elementary
20677     * (container) object
20678     *
20679     * @param parent The parent object
20680     * @return a new file selector widget handle or @c NULL, on errors
20681     *
20682     * This function inserts a new file selector widget on the canvas.
20683     *
20684     * @ingroup Fileselector
20685     */
20686    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20687
20688    /**
20689     * Enable/disable the file name entry box where the user can type
20690     * in a name for a file, in a given file selector widget
20691     *
20692     * @param obj The file selector object
20693     * @param is_save @c EINA_TRUE to make the file selector a "saving
20694     * dialog", @c EINA_FALSE otherwise
20695     *
20696     * Having the entry editable is useful on file saving dialogs on
20697     * applications, where one gives a file name to save contents to,
20698     * in a given directory in the system. This custom file name will
20699     * be reported on the @c "done" smart callback.
20700     *
20701     * @see elm_fileselector_is_save_get()
20702     *
20703     * @ingroup Fileselector
20704     */
20705    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20706
20707    /**
20708     * Get whether the given file selector is in "saving dialog" mode
20709     *
20710     * @param obj The file selector object
20711     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20712     * mode, @c EINA_FALSE otherwise (and on errors)
20713     *
20714     * @see elm_fileselector_is_save_set() for more details
20715     *
20716     * @ingroup Fileselector
20717     */
20718    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20719
20720    /**
20721     * Enable/disable folder-only view for a given file selector widget
20722     *
20723     * @param obj The file selector object
20724     * @param only @c EINA_TRUE to make @p obj only display
20725     * directories, @c EINA_FALSE to make files to be displayed in it
20726     * too
20727     *
20728     * If enabled, the widget's view will only display folder items,
20729     * naturally.
20730     *
20731     * @see elm_fileselector_folder_only_get()
20732     *
20733     * @ingroup Fileselector
20734     */
20735    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20736
20737    /**
20738     * Get whether folder-only view is set for a given file selector
20739     * widget
20740     *
20741     * @param obj The file selector object
20742     * @return only @c EINA_TRUE if @p obj is only displaying
20743     * directories, @c EINA_FALSE if files are being displayed in it
20744     * too (and on errors)
20745     *
20746     * @see elm_fileselector_folder_only_get()
20747     *
20748     * @ingroup Fileselector
20749     */
20750    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20751
20752    /**
20753     * Enable/disable the "ok" and "cancel" buttons on a given file
20754     * selector widget
20755     *
20756     * @param obj The file selector object
20757     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20758     *
20759     * @note A file selector without those buttons will never emit the
20760     * @c "done" smart event, and is only usable if one is just hooking
20761     * to the other two events.
20762     *
20763     * @see elm_fileselector_buttons_ok_cancel_get()
20764     *
20765     * @ingroup Fileselector
20766     */
20767    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20768
20769    /**
20770     * Get whether the "ok" and "cancel" buttons on a given file
20771     * selector widget are being shown.
20772     *
20773     * @param obj The file selector object
20774     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20775     * otherwise (and on errors)
20776     *
20777     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20778     *
20779     * @ingroup Fileselector
20780     */
20781    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20782
20783    /**
20784     * Enable/disable a tree view in the given file selector widget,
20785     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20786     *
20787     * @param obj The file selector object
20788     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20789     * disable
20790     *
20791     * In a tree view, arrows are created on the sides of directories,
20792     * allowing them to expand in place.
20793     *
20794     * @note If it's in other mode, the changes made by this function
20795     * will only be visible when one switches back to "list" mode.
20796     *
20797     * @see elm_fileselector_expandable_get()
20798     *
20799     * @ingroup Fileselector
20800     */
20801    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20802
20803    /**
20804     * Get whether tree view is enabled for the given file selector
20805     * widget
20806     *
20807     * @param obj The file selector object
20808     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20809     * otherwise (and or errors)
20810     *
20811     * @see elm_fileselector_expandable_set() for more details
20812     *
20813     * @ingroup Fileselector
20814     */
20815    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20816
20817    /**
20818     * Set, programmatically, the @b directory that a given file
20819     * selector widget will display contents from
20820     *
20821     * @param obj The file selector object
20822     * @param path The path to display in @p obj
20823     *
20824     * This will change the @b directory that @p obj is displaying. It
20825     * will also clear the text entry area on the @p obj object, which
20826     * displays select files' names.
20827     *
20828     * @see elm_fileselector_path_get()
20829     *
20830     * @ingroup Fileselector
20831     */
20832    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20833
20834    /**
20835     * Get the parent directory's path that a given file selector
20836     * widget is displaying
20837     *
20838     * @param obj The file selector object
20839     * @return The (full) path of the directory the file selector is
20840     * displaying, a @b stringshared string
20841     *
20842     * @see elm_fileselector_path_set()
20843     *
20844     * @ingroup Fileselector
20845     */
20846    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20847
20848    /**
20849     * Set, programmatically, the currently selected file/directory in
20850     * the given file selector widget
20851     *
20852     * @param obj The file selector object
20853     * @param path The (full) path to a file or directory
20854     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20855     * latter case occurs if the directory or file pointed to do not
20856     * exist.
20857     *
20858     * @see elm_fileselector_selected_get()
20859     *
20860     * @ingroup Fileselector
20861     */
20862    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20863
20864    /**
20865     * Get the currently selected item's (full) path, in the given file
20866     * selector widget
20867     *
20868     * @param obj The file selector object
20869     * @return The absolute path of the selected item, a @b
20870     * stringshared string
20871     *
20872     * @note Custom editions on @p obj object's text entry, if made,
20873     * will appear on the return string of this function, naturally.
20874     *
20875     * @see elm_fileselector_selected_set() for more details
20876     *
20877     * @ingroup Fileselector
20878     */
20879    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20880
20881    /**
20882     * Set the mode in which a given file selector widget will display
20883     * (layout) file system entries in its view
20884     *
20885     * @param obj The file selector object
20886     * @param mode The mode of the fileselector, being it one of
20887     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20888     * first one, naturally, will display the files in a list. The
20889     * latter will make the widget to display its entries in a grid
20890     * form.
20891     *
20892     * @note By using elm_fileselector_expandable_set(), the user may
20893     * trigger a tree view for that list.
20894     *
20895     * @note If Elementary is built with support of the Ethumb
20896     * thumbnailing library, the second form of view will display
20897     * preview thumbnails of files which it supports. You must have
20898     * elm_need_ethumb() called in your Elementary for thumbnailing to
20899     * work, though.
20900     *
20901     * @see elm_fileselector_expandable_set().
20902     * @see elm_fileselector_mode_get().
20903     *
20904     * @ingroup Fileselector
20905     */
20906    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20907
20908    /**
20909     * Get the mode in which a given file selector widget is displaying
20910     * (layouting) file system entries in its view
20911     *
20912     * @param obj The fileselector object
20913     * @return The mode in which the fileselector is at
20914     *
20915     * @see elm_fileselector_mode_set() for more details
20916     *
20917     * @ingroup Fileselector
20918     */
20919    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20920
20921    /**
20922     * @}
20923     */
20924
20925    /**
20926     * @defgroup Progressbar Progress bar
20927     *
20928     * The progress bar is a widget for visually representing the
20929     * progress status of a given job/task.
20930     *
20931     * A progress bar may be horizontal or vertical. It may display an
20932     * icon besides it, as well as primary and @b units labels. The
20933     * former is meant to label the widget as a whole, while the
20934     * latter, which is formatted with floating point values (and thus
20935     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20936     * units"</c>), is meant to label the widget's <b>progress
20937     * value</b>. Label, icon and unit strings/objects are @b optional
20938     * for progress bars.
20939     *
20940     * A progress bar may be @b inverted, in which state it gets its
20941     * values inverted, with high values being on the left or top and
20942     * low values on the right or bottom, as opposed to normally have
20943     * the low values on the former and high values on the latter,
20944     * respectively, for horizontal and vertical modes.
20945     *
20946     * The @b span of the progress, as set by
20947     * elm_progressbar_span_size_set(), is its length (horizontally or
20948     * vertically), unless one puts size hints on the widget to expand
20949     * on desired directions, by any container. That length will be
20950     * scaled by the object or applications scaling factor. At any
20951     * point code can query the progress bar for its value with
20952     * elm_progressbar_value_get().
20953     *
20954     * Available widget styles for progress bars:
20955     * - @c "default"
20956     * - @c "wheel" (simple style, no text, no progression, only
20957     *      "pulse" effect is available)
20958     *
20959     * Default contents parts of the progressbar widget that you can use for are:
20960     * @li "elm.swallow.content" - A icon of the progressbar
20961     * 
20962     * Here is an example on its usage:
20963     * @li @ref progressbar_example
20964     */
20965
20966    /**
20967     * Add a new progress bar widget to the given parent Elementary
20968     * (container) object
20969     *
20970     * @param parent The parent object
20971     * @return a new progress bar widget handle or @c NULL, on errors
20972     *
20973     * This function inserts a new progress bar widget on the canvas.
20974     *
20975     * @ingroup Progressbar
20976     */
20977    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20978
20979    /**
20980     * Set whether a given progress bar widget is at "pulsing mode" or
20981     * not.
20982     *
20983     * @param obj The progress bar object
20984     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20985     * @c EINA_FALSE to put it back to its default one
20986     *
20987     * By default, progress bars will display values from the low to
20988     * high value boundaries. There are, though, contexts in which the
20989     * state of progression of a given task is @b unknown.  For those,
20990     * one can set a progress bar widget to a "pulsing state", to give
20991     * the user an idea that some computation is being held, but
20992     * without exact progress values. In the default theme it will
20993     * animate its bar with the contents filling in constantly and back
20994     * to non-filled, in a loop. To start and stop this pulsing
20995     * animation, one has to explicitly call elm_progressbar_pulse().
20996     *
20997     * @see elm_progressbar_pulse_get()
20998     * @see elm_progressbar_pulse()
20999     *
21000     * @ingroup Progressbar
21001     */
21002    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21003
21004    /**
21005     * Get whether a given progress bar widget is at "pulsing mode" or
21006     * not.
21007     *
21008     * @param obj The progress bar object
21009     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21010     * if it's in the default one (and on errors)
21011     *
21012     * @ingroup Progressbar
21013     */
21014    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21015
21016    /**
21017     * Start/stop a given progress bar "pulsing" animation, if its
21018     * under that mode
21019     *
21020     * @param obj The progress bar object
21021     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21022     * @c EINA_FALSE to @b stop it
21023     *
21024     * @note This call won't do anything if @p obj is not under "pulsing mode".
21025     *
21026     * @see elm_progressbar_pulse_set() for more details.
21027     *
21028     * @ingroup Progressbar
21029     */
21030    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21031
21032    /**
21033     * Set the progress value (in percentage) on a given progress bar
21034     * widget
21035     *
21036     * @param obj The progress bar object
21037     * @param val The progress value (@b must be between @c 0.0 and @c
21038     * 1.0)
21039     *
21040     * Use this call to set progress bar levels.
21041     *
21042     * @note If you passes a value out of the specified range for @p
21043     * val, it will be interpreted as the @b closest of the @b boundary
21044     * values in the range.
21045     *
21046     * @ingroup Progressbar
21047     */
21048    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21049
21050    /**
21051     * Get the progress value (in percentage) on a given progress bar
21052     * widget
21053     *
21054     * @param obj The progress bar object
21055     * @return The value of the progressbar
21056     *
21057     * @see elm_progressbar_value_set() for more details
21058     *
21059     * @ingroup Progressbar
21060     */
21061    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21062
21063    /**
21064     * Set the label of a given progress bar widget
21065     *
21066     * @param obj The progress bar object
21067     * @param label The text label string, in UTF-8
21068     *
21069     * @ingroup Progressbar
21070     * @deprecated use elm_object_text_set() instead.
21071     */
21072    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21073
21074    /**
21075     * Get the label of a given progress bar widget
21076     *
21077     * @param obj The progressbar object
21078     * @return The text label string, in UTF-8
21079     *
21080     * @ingroup Progressbar
21081     * @deprecated use elm_object_text_set() instead.
21082     */
21083    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21084
21085    /**
21086     * Set the icon object of a given progress bar widget
21087     *
21088     * @param obj The progress bar object
21089     * @param icon The icon object
21090     *
21091     * Use this call to decorate @p obj with an icon next to it.
21092     *
21093     * @note Once the icon object is set, a previously set one will be
21094     * deleted. If you want to keep that old content object, use the
21095     * elm_progressbar_icon_unset() function.
21096     *
21097     * @see elm_progressbar_icon_get()
21098     *
21099     * @ingroup Progressbar
21100     */
21101    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21102
21103    /**
21104     * Retrieve the icon object set for a given progress bar widget
21105     *
21106     * @param obj The progress bar object
21107     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21108     * otherwise (and on errors)
21109     *
21110     * @see elm_progressbar_icon_set() for more details
21111     *
21112     * @ingroup Progressbar
21113     */
21114    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21115
21116    /**
21117     * Unset an icon set on a given progress bar widget
21118     *
21119     * @param obj The progress bar object
21120     * @return The icon object that was being used, if any was set, or
21121     * @c NULL, otherwise (and on errors)
21122     *
21123     * This call will unparent and return the icon object which was set
21124     * for this widget, previously, on success.
21125     *
21126     * @see elm_progressbar_icon_set() for more details
21127     *
21128     * @ingroup Progressbar
21129     */
21130    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21131
21132    /**
21133     * Set the (exact) length of the bar region of a given progress bar
21134     * widget
21135     *
21136     * @param obj The progress bar object
21137     * @param size The length of the progress bar's bar region
21138     *
21139     * This sets the minimum width (when in horizontal mode) or height
21140     * (when in vertical mode) of the actual bar area of the progress
21141     * bar @p obj. This in turn affects the object's minimum size. Use
21142     * this when you're not setting other size hints expanding on the
21143     * given direction (like weight and alignment hints) and you would
21144     * like it to have a specific size.
21145     *
21146     * @note Icon, label and unit text around @p obj will require their
21147     * own space, which will make @p obj to require more the @p size,
21148     * actually.
21149     *
21150     * @see elm_progressbar_span_size_get()
21151     *
21152     * @ingroup Progressbar
21153     */
21154    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21155
21156    /**
21157     * Get the length set for the bar region of a given progress bar
21158     * widget
21159     *
21160     * @param obj The progress bar object
21161     * @return The length of the progress bar's bar region
21162     *
21163     * If that size was not set previously, with
21164     * elm_progressbar_span_size_set(), this call will return @c 0.
21165     *
21166     * @ingroup Progressbar
21167     */
21168    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21169
21170    /**
21171     * Set the format string for a given progress bar widget's units
21172     * label
21173     *
21174     * @param obj The progress bar object
21175     * @param format The format string for @p obj's units label
21176     *
21177     * If @c NULL is passed on @p format, it will make @p obj's units
21178     * area to be hidden completely. If not, it'll set the <b>format
21179     * string</b> for the units label's @b text. The units label is
21180     * provided a floating point value, so the units text is up display
21181     * at most one floating point falue. Note that the units label is
21182     * optional. Use a format string such as "%1.2f meters" for
21183     * example.
21184     *
21185     * @note The default format string for a progress bar is an integer
21186     * percentage, as in @c "%.0f %%".
21187     *
21188     * @see elm_progressbar_unit_format_get()
21189     *
21190     * @ingroup Progressbar
21191     */
21192    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21193
21194    /**
21195     * Retrieve the format string set for a given progress bar widget's
21196     * units label
21197     *
21198     * @param obj The progress bar object
21199     * @return The format set string for @p obj's units label or
21200     * @c NULL, if none was set (and on errors)
21201     *
21202     * @see elm_progressbar_unit_format_set() for more details
21203     *
21204     * @ingroup Progressbar
21205     */
21206    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21207
21208    /**
21209     * Set the orientation of a given progress bar widget
21210     *
21211     * @param obj The progress bar object
21212     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21213     * @b horizontal, @c EINA_FALSE to make it @b vertical
21214     *
21215     * Use this function to change how your progress bar is to be
21216     * disposed: vertically or horizontally.
21217     *
21218     * @see elm_progressbar_horizontal_get()
21219     *
21220     * @ingroup Progressbar
21221     */
21222    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21223
21224    /**
21225     * Retrieve the orientation of a given progress bar widget
21226     *
21227     * @param obj The progress bar object
21228     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21229     * @c EINA_FALSE if it's @b vertical (and on errors)
21230     *
21231     * @see elm_progressbar_horizontal_set() for more details
21232     *
21233     * @ingroup Progressbar
21234     */
21235    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21236
21237    /**
21238     * Invert a given progress bar widget's displaying values order
21239     *
21240     * @param obj The progress bar object
21241     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21242     * @c EINA_FALSE to bring it back to default, non-inverted values.
21243     *
21244     * A progress bar may be @b inverted, in which state it gets its
21245     * values inverted, with high values being on the left or top and
21246     * low values on the right or bottom, as opposed to normally have
21247     * the low values on the former and high values on the latter,
21248     * respectively, for horizontal and vertical modes.
21249     *
21250     * @see elm_progressbar_inverted_get()
21251     *
21252     * @ingroup Progressbar
21253     */
21254    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21255
21256    /**
21257     * Get whether a given progress bar widget's displaying values are
21258     * inverted or not
21259     *
21260     * @param obj The progress bar object
21261     * @return @c EINA_TRUE, if @p obj has inverted values,
21262     * @c EINA_FALSE otherwise (and on errors)
21263     *
21264     * @see elm_progressbar_inverted_set() for more details
21265     *
21266     * @ingroup Progressbar
21267     */
21268    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21269
21270    /**
21271     * @defgroup Separator Separator
21272     *
21273     * @brief Separator is a very thin object used to separate other objects.
21274     *
21275     * A separator can be vertical or horizontal.
21276     *
21277     * @ref tutorial_separator is a good example of how to use a separator.
21278     * @{
21279     */
21280    /**
21281     * @brief Add a separator object to @p parent
21282     *
21283     * @param parent The parent object
21284     *
21285     * @return The separator object, or NULL upon failure
21286     */
21287    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21288    /**
21289     * @brief Set the horizontal mode of a separator object
21290     *
21291     * @param obj The separator object
21292     * @param horizontal If true, the separator is horizontal
21293     */
21294    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21295    /**
21296     * @brief Get the horizontal mode of a separator object
21297     *
21298     * @param obj The separator object
21299     * @return If true, the separator is horizontal
21300     *
21301     * @see elm_separator_horizontal_set()
21302     */
21303    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21304    /**
21305     * @}
21306     */
21307
21308    /**
21309     * @defgroup Spinner Spinner
21310     * @ingroup Elementary
21311     *
21312     * @image html img/widget/spinner/preview-00.png
21313     * @image latex img/widget/spinner/preview-00.eps
21314     *
21315     * A spinner is a widget which allows the user to increase or decrease
21316     * numeric values using arrow buttons, or edit values directly, clicking
21317     * over it and typing the new value.
21318     *
21319     * By default the spinner will not wrap and has a label
21320     * of "%.0f" (just showing the integer value of the double).
21321     *
21322     * A spinner has a label that is formatted with floating
21323     * point values and thus accepts a printf-style format string, like
21324     * “%1.2f units”.
21325     *
21326     * It also allows specific values to be replaced by pre-defined labels.
21327     *
21328     * Smart callbacks one can register to:
21329     *
21330     * - "changed" - Whenever the spinner value is changed.
21331     * - "delay,changed" - A short time after the value is changed by the user.
21332     *    This will be called only when the user stops dragging for a very short
21333     *    period or when they release their finger/mouse, so it avoids possibly
21334     *    expensive reactions to the value change.
21335     *
21336     * Available styles for it:
21337     * - @c "default";
21338     * - @c "vertical": up/down buttons at the right side and text left aligned.
21339     *
21340     * Here is an example on its usage:
21341     * @ref spinner_example
21342     */
21343
21344    /**
21345     * @addtogroup Spinner
21346     * @{
21347     */
21348
21349    /**
21350     * Add a new spinner widget to the given parent Elementary
21351     * (container) object.
21352     *
21353     * @param parent The parent object.
21354     * @return a new spinner widget handle or @c NULL, on errors.
21355     *
21356     * This function inserts a new spinner widget on the canvas.
21357     *
21358     * @ingroup Spinner
21359     *
21360     */
21361    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21362
21363    /**
21364     * Set the format string of the displayed label.
21365     *
21366     * @param obj The spinner object.
21367     * @param fmt The format string for the label display.
21368     *
21369     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21370     * string for the label text. The label text is provided a floating point
21371     * value, so the label text can display up to 1 floating point value.
21372     * Note that this is optional.
21373     *
21374     * Use a format string such as "%1.2f meters" for example, and it will
21375     * display values like: "3.14 meters" for a value equal to 3.14159.
21376     *
21377     * Default is "%0.f".
21378     *
21379     * @see elm_spinner_label_format_get()
21380     *
21381     * @ingroup Spinner
21382     */
21383    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21384
21385    /**
21386     * Get the label format of the spinner.
21387     *
21388     * @param obj The spinner object.
21389     * @return The text label format string in UTF-8.
21390     *
21391     * @see elm_spinner_label_format_set() for details.
21392     *
21393     * @ingroup Spinner
21394     */
21395    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21396
21397    /**
21398     * Set the minimum and maximum values for the spinner.
21399     *
21400     * @param obj The spinner object.
21401     * @param min The minimum value.
21402     * @param max The maximum value.
21403     *
21404     * Define the allowed range of values to be selected by the user.
21405     *
21406     * If actual value is less than @p min, it will be updated to @p min. If it
21407     * is bigger then @p max, will be updated to @p max. Actual value can be
21408     * get with elm_spinner_value_get().
21409     *
21410     * By default, min is equal to 0, and max is equal to 100.
21411     *
21412     * @warning Maximum must be greater than minimum.
21413     *
21414     * @see elm_spinner_min_max_get()
21415     *
21416     * @ingroup Spinner
21417     */
21418    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21419
21420    /**
21421     * Get the minimum and maximum values of the spinner.
21422     *
21423     * @param obj The spinner object.
21424     * @param min Pointer where to store the minimum value.
21425     * @param max Pointer where to store the maximum value.
21426     *
21427     * @note If only one value is needed, the other pointer can be passed
21428     * as @c NULL.
21429     *
21430     * @see elm_spinner_min_max_set() for details.
21431     *
21432     * @ingroup Spinner
21433     */
21434    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21435
21436    /**
21437     * Set the step used to increment or decrement the spinner value.
21438     *
21439     * @param obj The spinner object.
21440     * @param step The step value.
21441     *
21442     * This value will be incremented or decremented to the displayed value.
21443     * It will be incremented while the user keep right or top arrow pressed,
21444     * and will be decremented while the user keep left or bottom arrow pressed.
21445     *
21446     * The interval to increment / decrement can be set with
21447     * elm_spinner_interval_set().
21448     *
21449     * By default step value is equal to 1.
21450     *
21451     * @see elm_spinner_step_get()
21452     *
21453     * @ingroup Spinner
21454     */
21455    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21456
21457    /**
21458     * Get the step used to increment or decrement the spinner value.
21459     *
21460     * @param obj The spinner object.
21461     * @return The step value.
21462     *
21463     * @see elm_spinner_step_get() for more details.
21464     *
21465     * @ingroup Spinner
21466     */
21467    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21468
21469    /**
21470     * Set the value the spinner displays.
21471     *
21472     * @param obj The spinner object.
21473     * @param val The value to be displayed.
21474     *
21475     * Value will be presented on the label following format specified with
21476     * elm_spinner_format_set().
21477     *
21478     * @warning The value must to be between min and max values. This values
21479     * are set by elm_spinner_min_max_set().
21480     *
21481     * @see elm_spinner_value_get().
21482     * @see elm_spinner_format_set().
21483     * @see elm_spinner_min_max_set().
21484     *
21485     * @ingroup Spinner
21486     */
21487    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21488
21489    /**
21490     * Get the value displayed by the spinner.
21491     *
21492     * @param obj The spinner object.
21493     * @return The value displayed.
21494     *
21495     * @see elm_spinner_value_set() for details.
21496     *
21497     * @ingroup Spinner
21498     */
21499    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21500
21501    /**
21502     * Set whether the spinner should wrap when it reaches its
21503     * minimum or maximum value.
21504     *
21505     * @param obj The spinner object.
21506     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21507     * disable it.
21508     *
21509     * Disabled by default. If disabled, when the user tries to increment the
21510     * value,
21511     * but displayed value plus step value is bigger than maximum value,
21512     * the spinner
21513     * won't allow it. The same happens when the user tries to decrement it,
21514     * but the value less step is less than minimum value.
21515     *
21516     * When wrap is enabled, in such situations it will allow these changes,
21517     * but will get the value that would be less than minimum and subtracts
21518     * from maximum. Or add the value that would be more than maximum to
21519     * the minimum.
21520     *
21521     * E.g.:
21522     * @li min value = 10
21523     * @li max value = 50
21524     * @li step value = 20
21525     * @li displayed value = 20
21526     *
21527     * When the user decrement value (using left or bottom arrow), it will
21528     * displays @c 40, because max - (min - (displayed - step)) is
21529     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21530     *
21531     * @see elm_spinner_wrap_get().
21532     *
21533     * @ingroup Spinner
21534     */
21535    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21536
21537    /**
21538     * Get whether the spinner should wrap when it reaches its
21539     * minimum or maximum value.
21540     *
21541     * @param obj The spinner object
21542     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21543     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21544     *
21545     * @see elm_spinner_wrap_set() for details.
21546     *
21547     * @ingroup Spinner
21548     */
21549    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21550
21551    /**
21552     * Set whether the spinner can be directly edited by the user or not.
21553     *
21554     * @param obj The spinner object.
21555     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21556     * don't allow users to edit it directly.
21557     *
21558     * Spinner objects can have edition @b disabled, in which state they will
21559     * be changed only by arrows.
21560     * Useful for contexts
21561     * where you don't want your users to interact with it writting the value.
21562     * Specially
21563     * when using special values, the user can see real value instead
21564     * of special label on edition.
21565     *
21566     * It's enabled by default.
21567     *
21568     * @see elm_spinner_editable_get()
21569     *
21570     * @ingroup Spinner
21571     */
21572    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21573
21574    /**
21575     * Get whether the spinner can be directly edited by the user or not.
21576     *
21577     * @param obj The spinner object.
21578     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21579     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21580     *
21581     * @see elm_spinner_editable_set() for details.
21582     *
21583     * @ingroup Spinner
21584     */
21585    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21586
21587    /**
21588     * Set a special string to display in the place of the numerical value.
21589     *
21590     * @param obj The spinner object.
21591     * @param value The value to be replaced.
21592     * @param label The label to be used.
21593     *
21594     * It's useful for cases when a user should select an item that is
21595     * better indicated by a label than a value. For example, weekdays or months.
21596     *
21597     * E.g.:
21598     * @code
21599     * sp = elm_spinner_add(win);
21600     * elm_spinner_min_max_set(sp, 1, 3);
21601     * elm_spinner_special_value_add(sp, 1, "January");
21602     * elm_spinner_special_value_add(sp, 2, "February");
21603     * elm_spinner_special_value_add(sp, 3, "March");
21604     * evas_object_show(sp);
21605     * @endcode
21606     *
21607     * @ingroup Spinner
21608     */
21609    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21610
21611    /**
21612     * Set the interval on time updates for an user mouse button hold
21613     * on spinner widgets' arrows.
21614     *
21615     * @param obj The spinner object.
21616     * @param interval The (first) interval value in seconds.
21617     *
21618     * This interval value is @b decreased while the user holds the
21619     * mouse pointer either incrementing or decrementing spinner's value.
21620     *
21621     * This helps the user to get to a given value distant from the
21622     * current one easier/faster, as it will start to change quicker and
21623     * quicker on mouse button holds.
21624     *
21625     * The calculation for the next change interval value, starting from
21626     * the one set with this call, is the previous interval divided by
21627     * @c 1.05, so it decreases a little bit.
21628     *
21629     * The default starting interval value for automatic changes is
21630     * @c 0.85 seconds.
21631     *
21632     * @see elm_spinner_interval_get()
21633     *
21634     * @ingroup Spinner
21635     */
21636    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21637
21638    /**
21639     * Get the interval on time updates for an user mouse button hold
21640     * on spinner widgets' arrows.
21641     *
21642     * @param obj The spinner object.
21643     * @return The (first) interval value, in seconds, set on it.
21644     *
21645     * @see elm_spinner_interval_set() for more details.
21646     *
21647     * @ingroup Spinner
21648     */
21649    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21650
21651    /**
21652     * @}
21653     */
21654
21655    /**
21656     * @defgroup Index Index
21657     *
21658     * @image html img/widget/index/preview-00.png
21659     * @image latex img/widget/index/preview-00.eps
21660     *
21661     * An index widget gives you an index for fast access to whichever
21662     * group of other UI items one might have. It's a list of text
21663     * items (usually letters, for alphabetically ordered access).
21664     *
21665     * Index widgets are by default hidden and just appear when the
21666     * user clicks over it's reserved area in the canvas. In its
21667     * default theme, it's an area one @ref Fingers "finger" wide on
21668     * the right side of the index widget's container.
21669     *
21670     * When items on the index are selected, smart callbacks get
21671     * called, so that its user can make other container objects to
21672     * show a given area or child object depending on the index item
21673     * selected. You'd probably be using an index together with @ref
21674     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21675     * "general grids".
21676     *
21677     * Smart events one  can add callbacks for are:
21678     * - @c "changed" - When the selected index item changes. @c
21679     *      event_info is the selected item's data pointer.
21680     * - @c "delay,changed" - When the selected index item changes, but
21681     *      after a small idling period. @c event_info is the selected
21682     *      item's data pointer.
21683     * - @c "selected" - When the user releases a mouse button and
21684     *      selects an item. @c event_info is the selected item's data
21685     *      pointer.
21686     * - @c "level,up" - when the user moves a finger from the first
21687     *      level to the second level
21688     * - @c "level,down" - when the user moves a finger from the second
21689     *      level to the first level
21690     *
21691     * The @c "delay,changed" event is so that it'll wait a small time
21692     * before actually reporting those events and, moreover, just the
21693     * last event happening on those time frames will actually be
21694     * reported.
21695     *
21696     * Here are some examples on its usage:
21697     * @li @ref index_example_01
21698     * @li @ref index_example_02
21699     */
21700
21701    /**
21702     * @addtogroup Index
21703     * @{
21704     */
21705
21706    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21707
21708    /**
21709     * Add a new index widget to the given parent Elementary
21710     * (container) object
21711     *
21712     * @param parent The parent object
21713     * @return a new index widget handle or @c NULL, on errors
21714     *
21715     * This function inserts a new index widget on the canvas.
21716     *
21717     * @ingroup Index
21718     */
21719    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21720
21721    /**
21722     * Set whether a given index widget is or not visible,
21723     * programatically.
21724     *
21725     * @param obj The index object
21726     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21727     *
21728     * Not to be confused with visible as in @c evas_object_show() --
21729     * visible with regard to the widget's auto hiding feature.
21730     *
21731     * @see elm_index_active_get()
21732     *
21733     * @ingroup Index
21734     */
21735    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21736
21737    /**
21738     * Get whether a given index widget is currently visible or not.
21739     *
21740     * @param obj The index object
21741     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21742     *
21743     * @see elm_index_active_set() for more details
21744     *
21745     * @ingroup Index
21746     */
21747    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21748
21749    /**
21750     * Set the items level for a given index widget.
21751     *
21752     * @param obj The index object.
21753     * @param level @c 0 or @c 1, the currently implemented levels.
21754     *
21755     * @see elm_index_item_level_get()
21756     *
21757     * @ingroup Index
21758     */
21759    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21760
21761    /**
21762     * Get the items level set for a given index widget.
21763     *
21764     * @param obj The index object.
21765     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21766     *
21767     * @see elm_index_item_level_set() for more information
21768     *
21769     * @ingroup Index
21770     */
21771    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21772
21773    /**
21774     * Returns the last selected item's data, for a given index widget.
21775     *
21776     * @param obj The index object.
21777     * @return The item @b data associated to the last selected item on
21778     * @p obj (or @c NULL, on errors).
21779     *
21780     * @warning The returned value is @b not an #Elm_Index_Item item
21781     * handle, but the data associated to it (see the @c item parameter
21782     * in elm_index_item_append(), as an example).
21783     *
21784     * @ingroup Index
21785     */
21786    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21787
21788    /**
21789     * Append a new item on a given index widget.
21790     *
21791     * @param obj The index object.
21792     * @param letter Letter under which the item should be indexed
21793     * @param item The item data to set for the index's item
21794     *
21795     * Despite the most common usage of the @p letter argument is for
21796     * single char strings, one could use arbitrary strings as index
21797     * entries.
21798     *
21799     * @c item will be the pointer returned back on @c "changed", @c
21800     * "delay,changed" and @c "selected" smart events.
21801     *
21802     * @ingroup Index
21803     */
21804    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21805
21806    /**
21807     * Prepend a new item on a given index widget.
21808     *
21809     * @param obj The index object.
21810     * @param letter Letter under which the item should be indexed
21811     * @param item The item data to set for the index's item
21812     *
21813     * Despite the most common usage of the @p letter argument is for
21814     * single char strings, one could use arbitrary strings as index
21815     * entries.
21816     *
21817     * @c item will be the pointer returned back on @c "changed", @c
21818     * "delay,changed" and @c "selected" smart events.
21819     *
21820     * @ingroup Index
21821     */
21822    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21823
21824    /**
21825     * Append a new item, on a given index widget, <b>after the item
21826     * having @p relative as data</b>.
21827     *
21828     * @param obj The index object.
21829     * @param letter Letter under which the item should be indexed
21830     * @param item The item data to set for the index's item
21831     * @param relative The item data of the index item to be the
21832     * predecessor of this new one
21833     *
21834     * Despite the most common usage of the @p letter argument is for
21835     * single char strings, one could use arbitrary strings as index
21836     * entries.
21837     *
21838     * @c item will be the pointer returned back on @c "changed", @c
21839     * "delay,changed" and @c "selected" smart events.
21840     *
21841     * @note If @p relative is @c NULL or if it's not found to be data
21842     * set on any previous item on @p obj, this function will behave as
21843     * elm_index_item_append().
21844     *
21845     * @ingroup Index
21846     */
21847    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21848
21849    /**
21850     * Prepend a new item, on a given index widget, <b>after the item
21851     * having @p relative as data</b>.
21852     *
21853     * @param obj The index object.
21854     * @param letter Letter under which the item should be indexed
21855     * @param item The item data to set for the index's item
21856     * @param relative The item data of the index item to be the
21857     * successor of this new one
21858     *
21859     * Despite the most common usage of the @p letter argument is for
21860     * single char strings, one could use arbitrary strings as index
21861     * entries.
21862     *
21863     * @c item will be the pointer returned back on @c "changed", @c
21864     * "delay,changed" and @c "selected" smart events.
21865     *
21866     * @note If @p relative is @c NULL or if it's not found to be data
21867     * set on any previous item on @p obj, this function will behave as
21868     * elm_index_item_prepend().
21869     *
21870     * @ingroup Index
21871     */
21872    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21873
21874    /**
21875     * Insert a new item into the given index widget, using @p cmp_func
21876     * function to sort items (by item handles).
21877     *
21878     * @param obj The index object.
21879     * @param letter Letter under which the item should be indexed
21880     * @param item The item data to set for the index's item
21881     * @param cmp_func The comparing function to be used to sort index
21882     * items <b>by #Elm_Index_Item item handles</b>
21883     * @param cmp_data_func A @b fallback function to be called for the
21884     * sorting of index items <b>by item data</b>). It will be used
21885     * when @p cmp_func returns @c 0 (equality), which means an index
21886     * item with provided item data already exists. To decide which
21887     * data item should be pointed to by the index item in question, @p
21888     * cmp_data_func will be used. If @p cmp_data_func returns a
21889     * non-negative value, the previous index item data will be
21890     * replaced by the given @p item pointer. If the previous data need
21891     * to be freed, it should be done by the @p cmp_data_func function,
21892     * because all references to it will be lost. If this function is
21893     * not provided (@c NULL is given), index items will be @b
21894     * duplicated, if @p cmp_func returns @c 0.
21895     *
21896     * Despite the most common usage of the @p letter argument is for
21897     * single char strings, one could use arbitrary strings as index
21898     * entries.
21899     *
21900     * @c item will be the pointer returned back on @c "changed", @c
21901     * "delay,changed" and @c "selected" smart events.
21902     *
21903     * @ingroup Index
21904     */
21905    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);
21906
21907    /**
21908     * Remove an item from a given index widget, <b>to be referenced by
21909     * it's data value</b>.
21910     *
21911     * @param obj The index object
21912     * @param item The item's data pointer for the item to be removed
21913     * from @p obj
21914     *
21915     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21916     * that callback function will be called by this one.
21917     *
21918     * @warning The item to be removed from @p obj will be found via
21919     * its item data pointer, and not by an #Elm_Index_Item handle.
21920     *
21921     * @ingroup Index
21922     */
21923    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21924
21925    /**
21926     * Find a given index widget's item, <b>using item data</b>.
21927     *
21928     * @param obj The index object
21929     * @param item The item data pointed to by the desired index item
21930     * @return The index item handle, if found, or @c NULL otherwise
21931     *
21932     * @ingroup Index
21933     */
21934    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21935
21936    /**
21937     * Removes @b all items from a given index widget.
21938     *
21939     * @param obj The index object.
21940     *
21941     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21942     * that callback function will be called for each item in @p obj.
21943     *
21944     * @ingroup Index
21945     */
21946    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21947
21948    /**
21949     * Go to a given items level on a index widget
21950     *
21951     * @param obj The index object
21952     * @param level The index level (one of @c 0 or @c 1)
21953     *
21954     * @ingroup Index
21955     */
21956    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21957
21958    /**
21959     * Return the data associated with a given index widget item
21960     *
21961     * @param it The index widget item handle
21962     * @return The data associated with @p it
21963     *
21964     * @see elm_index_item_data_set()
21965     *
21966     * @ingroup Index
21967     */
21968    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21969
21970    /**
21971     * Set the data associated with a given index widget item
21972     *
21973     * @param it The index widget item handle
21974     * @param data The new data pointer to set to @p it
21975     *
21976     * This sets new item data on @p it.
21977     *
21978     * @warning The old data pointer won't be touched by this function, so
21979     * the user had better to free that old data himself/herself.
21980     *
21981     * @ingroup Index
21982     */
21983    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21984
21985    /**
21986     * Set the function to be called when a given index widget item is freed.
21987     *
21988     * @param it The item to set the callback on
21989     * @param func The function to call on the item's deletion
21990     *
21991     * When called, @p func will have both @c data and @c event_info
21992     * arguments with the @p it item's data value and, naturally, the
21993     * @c obj argument with a handle to the parent index widget.
21994     *
21995     * @ingroup Index
21996     */
21997    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21998
21999    /**
22000     * Get the letter (string) set on a given index widget item.
22001     *
22002     * @param it The index item handle
22003     * @return The letter string set on @p it
22004     *
22005     * @ingroup Index
22006     */
22007    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22008
22009    /**
22010     * @}
22011     */
22012
22013    /**
22014     * @defgroup Photocam Photocam
22015     *
22016     * @image html img/widget/photocam/preview-00.png
22017     * @image latex img/widget/photocam/preview-00.eps
22018     *
22019     * This is a widget specifically for displaying high-resolution digital
22020     * camera photos giving speedy feedback (fast load), low memory footprint
22021     * and zooming and panning as well as fitting logic. It is entirely focused
22022     * on jpeg images, and takes advantage of properties of the jpeg format (via
22023     * evas loader features in the jpeg loader).
22024     *
22025     * Signals that you can add callbacks for are:
22026     * @li "clicked" - This is called when a user has clicked the photo without
22027     *                 dragging around.
22028     * @li "press" - This is called when a user has pressed down on the photo.
22029     * @li "longpressed" - This is called when a user has pressed down on the
22030     *                     photo for a long time without dragging around.
22031     * @li "clicked,double" - This is called when a user has double-clicked the
22032     *                        photo.
22033     * @li "load" - Photo load begins.
22034     * @li "loaded" - This is called when the image file load is complete for the
22035     *                first view (low resolution blurry version).
22036     * @li "load,detail" - Photo detailed data load begins.
22037     * @li "loaded,detail" - This is called when the image file load is complete
22038     *                      for the detailed image data (full resolution needed).
22039     * @li "zoom,start" - Zoom animation started.
22040     * @li "zoom,stop" - Zoom animation stopped.
22041     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22042     * @li "scroll" - the content has been scrolled (moved)
22043     * @li "scroll,anim,start" - scrolling animation has started
22044     * @li "scroll,anim,stop" - scrolling animation has stopped
22045     * @li "scroll,drag,start" - dragging the contents around has started
22046     * @li "scroll,drag,stop" - dragging the contents around has stopped
22047     *
22048     * @ref tutorial_photocam shows the API in action.
22049     * @{
22050     */
22051    /**
22052     * @brief Types of zoom available.
22053     */
22054    typedef enum _Elm_Photocam_Zoom_Mode
22055      {
22056         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22057         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22058         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22059         ELM_PHOTOCAM_ZOOM_MODE_LAST
22060      } Elm_Photocam_Zoom_Mode;
22061    /**
22062     * @brief Add a new Photocam object
22063     *
22064     * @param parent The parent object
22065     * @return The new object or NULL if it cannot be created
22066     */
22067    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22068    /**
22069     * @brief Set the photo file to be shown
22070     *
22071     * @param obj The photocam object
22072     * @param file The photo file
22073     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22074     *
22075     * This sets (and shows) the specified file (with a relative or absolute
22076     * path) and will return a load error (same error that
22077     * evas_object_image_load_error_get() will return). The image will change and
22078     * adjust its size at this point and begin a background load process for this
22079     * photo that at some time in the future will be displayed at the full
22080     * quality needed.
22081     */
22082    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22083    /**
22084     * @brief Returns the path of the current image file
22085     *
22086     * @param obj The photocam object
22087     * @return Returns the path
22088     *
22089     * @see elm_photocam_file_set()
22090     */
22091    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22092    /**
22093     * @brief Set the zoom level of the photo
22094     *
22095     * @param obj The photocam object
22096     * @param zoom The zoom level to set
22097     *
22098     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22099     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22100     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22101     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22102     * 16, 32, etc.).
22103     */
22104    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22105    /**
22106     * @brief Get the zoom level of the photo
22107     *
22108     * @param obj The photocam object
22109     * @return The current zoom level
22110     *
22111     * This returns the current zoom level of the photocam object. Note that if
22112     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22113     * (which is the default), the zoom level may be changed at any time by the
22114     * photocam object itself to account for photo size and photocam viewpoer
22115     * size.
22116     *
22117     * @see elm_photocam_zoom_set()
22118     * @see elm_photocam_zoom_mode_set()
22119     */
22120    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22121    /**
22122     * @brief Set the zoom mode
22123     *
22124     * @param obj The photocam object
22125     * @param mode The desired mode
22126     *
22127     * This sets the zoom mode to manual or one of several automatic levels.
22128     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22129     * elm_photocam_zoom_set() and will stay at that level until changed by code
22130     * or until zoom mode is changed. This is the default mode. The Automatic
22131     * modes will allow the photocam object to automatically adjust zoom mode
22132     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22133     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22134     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22135     * pixels within the frame are left unfilled.
22136     */
22137    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22138    /**
22139     * @brief Get the zoom mode
22140     *
22141     * @param obj The photocam object
22142     * @return The current zoom mode
22143     *
22144     * This gets the current zoom mode of the photocam object.
22145     *
22146     * @see elm_photocam_zoom_mode_set()
22147     */
22148    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22149    /**
22150     * @brief Get the current image pixel width and height
22151     *
22152     * @param obj The photocam object
22153     * @param w A pointer to the width return
22154     * @param h A pointer to the height return
22155     *
22156     * This gets the current photo pixel width and height (for the original).
22157     * The size will be returned in the integers @p w and @p h that are pointed
22158     * to.
22159     */
22160    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22161    /**
22162     * @brief Get the area of the image that is currently shown
22163     *
22164     * @param obj
22165     * @param x A pointer to the X-coordinate of region
22166     * @param y A pointer to the Y-coordinate of region
22167     * @param w A pointer to the width
22168     * @param h A pointer to the height
22169     *
22170     * @see elm_photocam_image_region_show()
22171     * @see elm_photocam_image_region_bring_in()
22172     */
22173    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22174    /**
22175     * @brief Set the viewed portion of the image
22176     *
22177     * @param obj The photocam object
22178     * @param x X-coordinate of region in image original pixels
22179     * @param y Y-coordinate of region in image original pixels
22180     * @param w Width of region in image original pixels
22181     * @param h Height of region in image original pixels
22182     *
22183     * This shows the region of the image without using animation.
22184     */
22185    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22186    /**
22187     * @brief Bring in the viewed portion of the image
22188     *
22189     * @param obj The photocam object
22190     * @param x X-coordinate of region in image original pixels
22191     * @param y Y-coordinate of region in image original pixels
22192     * @param w Width of region in image original pixels
22193     * @param h Height of region in image original pixels
22194     *
22195     * This shows the region of the image using animation.
22196     */
22197    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22198    /**
22199     * @brief Set the paused state for photocam
22200     *
22201     * @param obj The photocam object
22202     * @param paused The pause state to set
22203     *
22204     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22205     * photocam. The default is off. This will stop zooming using animation on
22206     * zoom levels changes and change instantly. This will stop any existing
22207     * animations that are running.
22208     */
22209    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22210    /**
22211     * @brief Get the paused state for photocam
22212     *
22213     * @param obj The photocam object
22214     * @return The current paused state
22215     *
22216     * This gets the current paused state for the photocam object.
22217     *
22218     * @see elm_photocam_paused_set()
22219     */
22220    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22221    /**
22222     * @brief Get the internal low-res image used for photocam
22223     *
22224     * @param obj The photocam object
22225     * @return The internal image object handle, or NULL if none exists
22226     *
22227     * This gets the internal image object inside photocam. Do not modify it. It
22228     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22229     * deleted at any time as well.
22230     */
22231    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22232    /**
22233     * @brief Set the photocam scrolling bouncing.
22234     *
22235     * @param obj The photocam object
22236     * @param h_bounce bouncing for horizontal
22237     * @param v_bounce bouncing for vertical
22238     */
22239    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22240    /**
22241     * @brief Get the photocam scrolling bouncing.
22242     *
22243     * @param obj The photocam object
22244     * @param h_bounce bouncing for horizontal
22245     * @param v_bounce bouncing for vertical
22246     *
22247     * @see elm_photocam_bounce_set()
22248     */
22249    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22250    /**
22251     * @}
22252     */
22253
22254    /**
22255     * @defgroup Map Map
22256     * @ingroup Elementary
22257     *
22258     * @image html img/widget/map/preview-00.png
22259     * @image latex img/widget/map/preview-00.eps
22260     *
22261     * This is a widget specifically for displaying a map. It uses basically
22262     * OpenStreetMap provider http://www.openstreetmap.org/,
22263     * but custom providers can be added.
22264     *
22265     * It supports some basic but yet nice features:
22266     * @li zoom and scroll
22267     * @li markers with content to be displayed when user clicks over it
22268     * @li group of markers
22269     * @li routes
22270     *
22271     * Smart callbacks one can listen to:
22272     *
22273     * - "clicked" - This is called when a user has clicked the map without
22274     *   dragging around.
22275     * - "press" - This is called when a user has pressed down on the map.
22276     * - "longpressed" - This is called when a user has pressed down on the map
22277     *   for a long time without dragging around.
22278     * - "clicked,double" - This is called when a user has double-clicked
22279     *   the map.
22280     * - "load,detail" - Map detailed data load begins.
22281     * - "loaded,detail" - This is called when all currently visible parts of
22282     *   the map are loaded.
22283     * - "zoom,start" - Zoom animation started.
22284     * - "zoom,stop" - Zoom animation stopped.
22285     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22286     * - "scroll" - the content has been scrolled (moved).
22287     * - "scroll,anim,start" - scrolling animation has started.
22288     * - "scroll,anim,stop" - scrolling animation has stopped.
22289     * - "scroll,drag,start" - dragging the contents around has started.
22290     * - "scroll,drag,stop" - dragging the contents around has stopped.
22291     * - "downloaded" - This is called when all currently required map images
22292     *   are downloaded.
22293     * - "route,load" - This is called when route request begins.
22294     * - "route,loaded" - This is called when route request ends.
22295     * - "name,load" - This is called when name request begins.
22296     * - "name,loaded- This is called when name request ends.
22297     *
22298     * Available style for map widget:
22299     * - @c "default"
22300     *
22301     * Available style for markers:
22302     * - @c "radio"
22303     * - @c "radio2"
22304     * - @c "empty"
22305     *
22306     * Available style for marker bubble:
22307     * - @c "default"
22308     *
22309     * List of examples:
22310     * @li @ref map_example_01
22311     * @li @ref map_example_02
22312     * @li @ref map_example_03
22313     */
22314
22315    /**
22316     * @addtogroup Map
22317     * @{
22318     */
22319
22320    /**
22321     * @enum _Elm_Map_Zoom_Mode
22322     * @typedef Elm_Map_Zoom_Mode
22323     *
22324     * Set map's zoom behavior. It can be set to manual or automatic.
22325     *
22326     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22327     *
22328     * Values <b> don't </b> work as bitmask, only one can be choosen.
22329     *
22330     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22331     * than the scroller view.
22332     *
22333     * @see elm_map_zoom_mode_set()
22334     * @see elm_map_zoom_mode_get()
22335     *
22336     * @ingroup Map
22337     */
22338    typedef enum _Elm_Map_Zoom_Mode
22339      {
22340         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22341         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22342         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22343         ELM_MAP_ZOOM_MODE_LAST
22344      } Elm_Map_Zoom_Mode;
22345
22346    /**
22347     * @enum _Elm_Map_Route_Sources
22348     * @typedef Elm_Map_Route_Sources
22349     *
22350     * Set route service to be used. By default used source is
22351     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22352     *
22353     * @see elm_map_route_source_set()
22354     * @see elm_map_route_source_get()
22355     *
22356     * @ingroup Map
22357     */
22358    typedef enum _Elm_Map_Route_Sources
22359      {
22360         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22361         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. */
22362         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22363         ELM_MAP_ROUTE_SOURCE_LAST
22364      } Elm_Map_Route_Sources;
22365
22366    typedef enum _Elm_Map_Name_Sources
22367      {
22368         ELM_MAP_NAME_SOURCE_NOMINATIM,
22369         ELM_MAP_NAME_SOURCE_LAST
22370      } Elm_Map_Name_Sources;
22371
22372    /**
22373     * @enum _Elm_Map_Route_Type
22374     * @typedef Elm_Map_Route_Type
22375     *
22376     * Set type of transport used on route.
22377     *
22378     * @see elm_map_route_add()
22379     *
22380     * @ingroup Map
22381     */
22382    typedef enum _Elm_Map_Route_Type
22383      {
22384         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22385         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22386         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22387         ELM_MAP_ROUTE_TYPE_LAST
22388      } Elm_Map_Route_Type;
22389
22390    /**
22391     * @enum _Elm_Map_Route_Method
22392     * @typedef Elm_Map_Route_Method
22393     *
22394     * Set the routing method, what should be priorized, time or distance.
22395     *
22396     * @see elm_map_route_add()
22397     *
22398     * @ingroup Map
22399     */
22400    typedef enum _Elm_Map_Route_Method
22401      {
22402         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22403         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22404         ELM_MAP_ROUTE_METHOD_LAST
22405      } Elm_Map_Route_Method;
22406
22407    typedef enum _Elm_Map_Name_Method
22408      {
22409         ELM_MAP_NAME_METHOD_SEARCH,
22410         ELM_MAP_NAME_METHOD_REVERSE,
22411         ELM_MAP_NAME_METHOD_LAST
22412      } Elm_Map_Name_Method;
22413
22414    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(). */
22415    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(). */
22416    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(). */
22417    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(). */
22418    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22419    typedef struct _Elm_Map_Track           Elm_Map_Track;
22420
22421    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. */
22422    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22423    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22424    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22425
22426    typedef char        *(*ElmMapModuleSourceFunc) (void);
22427    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22428    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22429    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22430    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22431    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22432    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22433    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22434    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22435
22436    /**
22437     * Add a new map widget to the given parent Elementary (container) object.
22438     *
22439     * @param parent The parent object.
22440     * @return a new map widget handle or @c NULL, on errors.
22441     *
22442     * This function inserts a new map widget on the canvas.
22443     *
22444     * @ingroup Map
22445     */
22446    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22447
22448    /**
22449     * Set the zoom level of the map.
22450     *
22451     * @param obj The map object.
22452     * @param zoom The zoom level to set.
22453     *
22454     * This sets the zoom level.
22455     *
22456     * It will respect limits defined by elm_map_source_zoom_min_set() and
22457     * elm_map_source_zoom_max_set().
22458     *
22459     * By default these values are 0 (world map) and 18 (maximum zoom).
22460     *
22461     * This function should be used when zoom mode is set to
22462     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22463     * with elm_map_zoom_mode_set().
22464     *
22465     * @see elm_map_zoom_mode_set().
22466     * @see elm_map_zoom_get().
22467     *
22468     * @ingroup Map
22469     */
22470    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22471
22472    /**
22473     * Get the zoom level of the map.
22474     *
22475     * @param obj The map object.
22476     * @return The current zoom level.
22477     *
22478     * This returns the current zoom level of the map object.
22479     *
22480     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22481     * (which is the default), the zoom level may be changed at any time by the
22482     * map object itself to account for map size and map viewport size.
22483     *
22484     * @see elm_map_zoom_set() for details.
22485     *
22486     * @ingroup Map
22487     */
22488    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22489
22490    /**
22491     * Set the zoom mode used by the map object.
22492     *
22493     * @param obj The map object.
22494     * @param mode The zoom mode of the map, being it one of
22495     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22496     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22497     *
22498     * This sets the zoom mode to manual or one of the automatic levels.
22499     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22500     * elm_map_zoom_set() and will stay at that level until changed by code
22501     * or until zoom mode is changed. This is the default mode.
22502     *
22503     * The Automatic modes will allow the map object to automatically
22504     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22505     * adjust zoom so the map fits inside the scroll frame with no pixels
22506     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22507     * ensure no pixels within the frame are left unfilled. Do not forget that
22508     * the valid sizes are 2^zoom, consequently the map may be smaller than
22509     * the scroller view.
22510     *
22511     * @see elm_map_zoom_set()
22512     *
22513     * @ingroup Map
22514     */
22515    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22516
22517    /**
22518     * Get the zoom mode used by the map object.
22519     *
22520     * @param obj The map object.
22521     * @return The zoom mode of the map, being it one of
22522     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22523     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22524     *
22525     * This function returns the current zoom mode used by the map object.
22526     *
22527     * @see elm_map_zoom_mode_set() for more details.
22528     *
22529     * @ingroup Map
22530     */
22531    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22532
22533    /**
22534     * Get the current coordinates of the map.
22535     *
22536     * @param obj The map object.
22537     * @param lon Pointer where to store longitude.
22538     * @param lat Pointer where to store latitude.
22539     *
22540     * This gets the current center coordinates of the map object. It can be
22541     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22542     *
22543     * @see elm_map_geo_region_bring_in()
22544     * @see elm_map_geo_region_show()
22545     *
22546     * @ingroup Map
22547     */
22548    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22549
22550    /**
22551     * Animatedly bring in given coordinates to the center of the map.
22552     *
22553     * @param obj The map object.
22554     * @param lon Longitude to center at.
22555     * @param lat Latitude to center at.
22556     *
22557     * This causes map to jump to the given @p lat and @p lon coordinates
22558     * and show it (by scrolling) in the center of the viewport, if it is not
22559     * already centered. This will use animation to do so and take a period
22560     * of time to complete.
22561     *
22562     * @see elm_map_geo_region_show() for a function to avoid animation.
22563     * @see elm_map_geo_region_get()
22564     *
22565     * @ingroup Map
22566     */
22567    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22568
22569    /**
22570     * Show the given coordinates at the center of the map, @b immediately.
22571     *
22572     * @param obj The map object.
22573     * @param lon Longitude to center at.
22574     * @param lat Latitude to center at.
22575     *
22576     * This causes map to @b redraw its viewport's contents to the
22577     * region contining the given @p lat and @p lon, that will be moved to the
22578     * center of the map.
22579     *
22580     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22581     * @see elm_map_geo_region_get()
22582     *
22583     * @ingroup Map
22584     */
22585    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22586
22587    /**
22588     * Pause or unpause the map.
22589     *
22590     * @param obj The map object.
22591     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22592     * to unpause it.
22593     *
22594     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22595     * for map.
22596     *
22597     * The default is off.
22598     *
22599     * This will stop zooming using animation, changing zoom levels will
22600     * change instantly. This will stop any existing animations that are running.
22601     *
22602     * @see elm_map_paused_get()
22603     *
22604     * @ingroup Map
22605     */
22606    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22607
22608    /**
22609     * Get a value whether map is paused or not.
22610     *
22611     * @param obj The map object.
22612     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22613     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22614     *
22615     * This gets the current paused state for the map object.
22616     *
22617     * @see elm_map_paused_set() for details.
22618     *
22619     * @ingroup Map
22620     */
22621    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22622
22623    /**
22624     * Set to show markers during zoom level changes or not.
22625     *
22626     * @param obj The map object.
22627     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22628     * to show them.
22629     *
22630     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22631     * for map.
22632     *
22633     * The default is off.
22634     *
22635     * This will stop zooming using animation, changing zoom levels will
22636     * change instantly. This will stop any existing animations that are running.
22637     *
22638     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22639     * for the markers.
22640     *
22641     * The default  is off.
22642     *
22643     * Enabling it will force the map to stop displaying the markers during
22644     * zoom level changes. Set to on if you have a large number of markers.
22645     *
22646     * @see elm_map_paused_markers_get()
22647     *
22648     * @ingroup Map
22649     */
22650    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22651
22652    /**
22653     * Get a value whether markers will be displayed on zoom level changes or not
22654     *
22655     * @param obj The map object.
22656     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22657     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22658     *
22659     * This gets the current markers paused state for the map object.
22660     *
22661     * @see elm_map_paused_markers_set() for details.
22662     *
22663     * @ingroup Map
22664     */
22665    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22666
22667    /**
22668     * Get the information of downloading status.
22669     *
22670     * @param obj The map object.
22671     * @param try_num Pointer where to store number of tiles being downloaded.
22672     * @param finish_num Pointer where to store number of tiles successfully
22673     * downloaded.
22674     *
22675     * This gets the current downloading status for the map object, the number
22676     * of tiles being downloaded and the number of tiles already downloaded.
22677     *
22678     * @ingroup Map
22679     */
22680    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22681
22682    /**
22683     * Convert a pixel coordinate (x,y) into a geographic coordinate
22684     * (longitude, latitude).
22685     *
22686     * @param obj The map object.
22687     * @param x the coordinate.
22688     * @param y the coordinate.
22689     * @param size the size in pixels of the map.
22690     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22691     * @param lon Pointer where to store the longitude that correspond to x.
22692     * @param lat Pointer where to store the latitude that correspond to y.
22693     *
22694     * @note Origin pixel point is the top left corner of the viewport.
22695     * Map zoom and size are taken on account.
22696     *
22697     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22698     *
22699     * @ingroup Map
22700     */
22701    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);
22702
22703    /**
22704     * Convert a geographic coordinate (longitude, latitude) into a pixel
22705     * coordinate (x, y).
22706     *
22707     * @param obj The map object.
22708     * @param lon the longitude.
22709     * @param lat the latitude.
22710     * @param size the size in pixels of the map. The map is a square
22711     * and generally his size is : pow(2.0, zoom)*256.
22712     * @param x Pointer where to store the horizontal pixel coordinate that
22713     * correspond to the longitude.
22714     * @param y Pointer where to store the vertical pixel coordinate that
22715     * correspond to the latitude.
22716     *
22717     * @note Origin pixel point is the top left corner of the viewport.
22718     * Map zoom and size are taken on account.
22719     *
22720     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22721     *
22722     * @ingroup Map
22723     */
22724    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);
22725
22726    /**
22727     * Convert a geographic coordinate (longitude, latitude) into a name
22728     * (address).
22729     *
22730     * @param obj The map object.
22731     * @param lon the longitude.
22732     * @param lat the latitude.
22733     * @return name A #Elm_Map_Name handle for this coordinate.
22734     *
22735     * To get the string for this address, elm_map_name_address_get()
22736     * should be used.
22737     *
22738     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22739     *
22740     * @ingroup Map
22741     */
22742    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22743
22744    /**
22745     * Convert a name (address) into a geographic coordinate
22746     * (longitude, latitude).
22747     *
22748     * @param obj The map object.
22749     * @param name The address.
22750     * @return name A #Elm_Map_Name handle for this address.
22751     *
22752     * To get the longitude and latitude, elm_map_name_region_get()
22753     * should be used.
22754     *
22755     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22756     *
22757     * @ingroup Map
22758     */
22759    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22760
22761    /**
22762     * Convert a pixel coordinate into a rotated pixel coordinate.
22763     *
22764     * @param obj The map object.
22765     * @param x horizontal coordinate of the point to rotate.
22766     * @param y vertical coordinate of the point to rotate.
22767     * @param cx rotation's center horizontal position.
22768     * @param cy rotation's center vertical position.
22769     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22770     * @param xx Pointer where to store rotated x.
22771     * @param yy Pointer where to store rotated y.
22772     *
22773     * @ingroup Map
22774     */
22775    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);
22776
22777    /**
22778     * Add a new marker to the map object.
22779     *
22780     * @param obj The map object.
22781     * @param lon The longitude of the marker.
22782     * @param lat The latitude of the marker.
22783     * @param clas The class, to use when marker @b isn't grouped to others.
22784     * @param clas_group The class group, to use when marker is grouped to others
22785     * @param data The data passed to the callbacks.
22786     *
22787     * @return The created marker or @c NULL upon failure.
22788     *
22789     * A marker will be created and shown in a specific point of the map, defined
22790     * by @p lon and @p lat.
22791     *
22792     * It will be displayed using style defined by @p class when this marker
22793     * is displayed alone (not grouped). A new class can be created with
22794     * elm_map_marker_class_new().
22795     *
22796     * If the marker is grouped to other markers, it will be displayed with
22797     * style defined by @p class_group. Markers with the same group are grouped
22798     * if they are close. A new group class can be created with
22799     * elm_map_marker_group_class_new().
22800     *
22801     * Markers created with this method can be deleted with
22802     * elm_map_marker_remove().
22803     *
22804     * A marker can have associated content to be displayed by a bubble,
22805     * when a user click over it, as well as an icon. These objects will
22806     * be fetch using class' callback functions.
22807     *
22808     * @see elm_map_marker_class_new()
22809     * @see elm_map_marker_group_class_new()
22810     * @see elm_map_marker_remove()
22811     *
22812     * @ingroup Map
22813     */
22814    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);
22815
22816    /**
22817     * Set the maximum numbers of markers' content to be displayed in a group.
22818     *
22819     * @param obj The map object.
22820     * @param max The maximum numbers of items displayed in a bubble.
22821     *
22822     * A bubble will be displayed when the user clicks over the group,
22823     * and will place the content of markers that belong to this group
22824     * inside it.
22825     *
22826     * A group can have a long list of markers, consequently the creation
22827     * of the content of the bubble can be very slow.
22828     *
22829     * In order to avoid this, a maximum number of items is displayed
22830     * in a bubble.
22831     *
22832     * By default this number is 30.
22833     *
22834     * Marker with the same group class are grouped if they are close.
22835     *
22836     * @see elm_map_marker_add()
22837     *
22838     * @ingroup Map
22839     */
22840    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22841
22842    /**
22843     * Remove a marker from the map.
22844     *
22845     * @param marker The marker to remove.
22846     *
22847     * @see elm_map_marker_add()
22848     *
22849     * @ingroup Map
22850     */
22851    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22852
22853    /**
22854     * Get the current coordinates of the marker.
22855     *
22856     * @param marker marker.
22857     * @param lat Pointer where to store the marker's latitude.
22858     * @param lon Pointer where to store the marker's longitude.
22859     *
22860     * These values are set when adding markers, with function
22861     * elm_map_marker_add().
22862     *
22863     * @see elm_map_marker_add()
22864     *
22865     * @ingroup Map
22866     */
22867    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22868
22869    /**
22870     * Animatedly bring in given marker to the center of the map.
22871     *
22872     * @param marker The marker to center at.
22873     *
22874     * This causes map to jump to the given @p marker's coordinates
22875     * and show it (by scrolling) in the center of the viewport, if it is not
22876     * already centered. This will use animation to do so and take a period
22877     * of time to complete.
22878     *
22879     * @see elm_map_marker_show() for a function to avoid animation.
22880     * @see elm_map_marker_region_get()
22881     *
22882     * @ingroup Map
22883     */
22884    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22885
22886    /**
22887     * Show the given marker at the center of the map, @b immediately.
22888     *
22889     * @param marker The marker to center at.
22890     *
22891     * This causes map to @b redraw its viewport's contents to the
22892     * region contining the given @p marker's coordinates, that will be
22893     * moved to the center of the map.
22894     *
22895     * @see elm_map_marker_bring_in() for a function to move with animation.
22896     * @see elm_map_markers_list_show() if more than one marker need to be
22897     * displayed.
22898     * @see elm_map_marker_region_get()
22899     *
22900     * @ingroup Map
22901     */
22902    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22903
22904    /**
22905     * Move and zoom the map to display a list of markers.
22906     *
22907     * @param markers A list of #Elm_Map_Marker handles.
22908     *
22909     * The map will be centered on the center point of the markers in the list.
22910     * Then the map will be zoomed in order to fit the markers using the maximum
22911     * zoom which allows display of all the markers.
22912     *
22913     * @warning All the markers should belong to the same map object.
22914     *
22915     * @see elm_map_marker_show() to show a single marker.
22916     * @see elm_map_marker_bring_in()
22917     *
22918     * @ingroup Map
22919     */
22920    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22921
22922    /**
22923     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22924     *
22925     * @param marker The marker wich content should be returned.
22926     * @return Return the evas object if it exists, else @c NULL.
22927     *
22928     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22929     * elm_map_marker_class_get_cb_set() should be used.
22930     *
22931     * This content is what will be inside the bubble that will be displayed
22932     * when an user clicks over the marker.
22933     *
22934     * This returns the actual Evas object used to be placed inside
22935     * the bubble. This may be @c NULL, as it may
22936     * not have been created or may have been deleted, at any time, by
22937     * the map. <b>Do not modify this object</b> (move, resize,
22938     * show, hide, etc.), as the map is controlling it. This
22939     * function is for querying, emitting custom signals or hooking
22940     * lower level callbacks for events on that object. Do not delete
22941     * this object under any circumstances.
22942     *
22943     * @ingroup Map
22944     */
22945    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22946
22947    /**
22948     * Update the marker
22949     *
22950     * @param marker The marker to be updated.
22951     *
22952     * If a content is set to this marker, it will call function to delete it,
22953     * #ElmMapMarkerDelFunc, and then will fetch the content again with
22954     * #ElmMapMarkerGetFunc.
22955     *
22956     * These functions are set for the marker class with
22957     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22958     *
22959     * @ingroup Map
22960     */
22961    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22962
22963    /**
22964     * Close all the bubbles opened by the user.
22965     *
22966     * @param obj The map object.
22967     *
22968     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22969     * when the user clicks on a marker.
22970     *
22971     * This functions is set for the marker class with
22972     * elm_map_marker_class_get_cb_set().
22973     *
22974     * @ingroup Map
22975     */
22976    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22977
22978    /**
22979     * Create a new group class.
22980     *
22981     * @param obj The map object.
22982     * @return Returns the new group class.
22983     *
22984     * Each marker must be associated to a group class. Markers in the same
22985     * group are grouped if they are close.
22986     *
22987     * The group class defines the style of the marker when a marker is grouped
22988     * to others markers. When it is alone, another class will be used.
22989     *
22990     * A group class will need to be provided when creating a marker with
22991     * elm_map_marker_add().
22992     *
22993     * Some properties and functions can be set by class, as:
22994     * - style, with elm_map_group_class_style_set()
22995     * - data - to be associated to the group class. It can be set using
22996     *   elm_map_group_class_data_set().
22997     * - min zoom to display markers, set with
22998     *   elm_map_group_class_zoom_displayed_set().
22999     * - max zoom to group markers, set using
23000     *   elm_map_group_class_zoom_grouped_set().
23001     * - visibility - set if markers will be visible or not, set with
23002     *   elm_map_group_class_hide_set().
23003     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23004     *   It can be set using elm_map_group_class_icon_cb_set().
23005     *
23006     * @see elm_map_marker_add()
23007     * @see elm_map_group_class_style_set()
23008     * @see elm_map_group_class_data_set()
23009     * @see elm_map_group_class_zoom_displayed_set()
23010     * @see elm_map_group_class_zoom_grouped_set()
23011     * @see elm_map_group_class_hide_set()
23012     * @see elm_map_group_class_icon_cb_set()
23013     *
23014     * @ingroup Map
23015     */
23016    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23017
23018    /**
23019     * Set the marker's style of a group class.
23020     *
23021     * @param clas The group class.
23022     * @param style The style to be used by markers.
23023     *
23024     * Each marker must be associated to a group class, and will use the style
23025     * defined by such class when grouped to other markers.
23026     *
23027     * The following styles are provided by default theme:
23028     * @li @c radio - blue circle
23029     * @li @c radio2 - green circle
23030     * @li @c empty
23031     *
23032     * @see elm_map_group_class_new() for more details.
23033     * @see elm_map_marker_add()
23034     *
23035     * @ingroup Map
23036     */
23037    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23038
23039    /**
23040     * Set the icon callback function of a group class.
23041     *
23042     * @param clas The group class.
23043     * @param icon_get The callback function that will return the icon.
23044     *
23045     * Each marker must be associated to a group class, and it can display a
23046     * custom icon. The function @p icon_get must return this icon.
23047     *
23048     * @see elm_map_group_class_new() for more details.
23049     * @see elm_map_marker_add()
23050     *
23051     * @ingroup Map
23052     */
23053    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23054
23055    /**
23056     * Set the data associated to the group class.
23057     *
23058     * @param clas The group class.
23059     * @param data The new user data.
23060     *
23061     * This data will be passed for callback functions, like icon get callback,
23062     * that can be set with elm_map_group_class_icon_cb_set().
23063     *
23064     * If a data was previously set, the object will lose the pointer for it,
23065     * so if needs to be freed, you must do it yourself.
23066     *
23067     * @see elm_map_group_class_new() for more details.
23068     * @see elm_map_group_class_icon_cb_set()
23069     * @see elm_map_marker_add()
23070     *
23071     * @ingroup Map
23072     */
23073    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23074
23075    /**
23076     * Set the minimum zoom from where the markers are displayed.
23077     *
23078     * @param clas The group class.
23079     * @param zoom The minimum zoom.
23080     *
23081     * Markers only will be displayed when the map is displayed at @p zoom
23082     * or bigger.
23083     *
23084     * @see elm_map_group_class_new() for more details.
23085     * @see elm_map_marker_add()
23086     *
23087     * @ingroup Map
23088     */
23089    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23090
23091    /**
23092     * Set the zoom from where the markers are no more grouped.
23093     *
23094     * @param clas The group class.
23095     * @param zoom The maximum zoom.
23096     *
23097     * Markers only will be grouped when the map is displayed at
23098     * less than @p zoom.
23099     *
23100     * @see elm_map_group_class_new() for more details.
23101     * @see elm_map_marker_add()
23102     *
23103     * @ingroup Map
23104     */
23105    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23106
23107    /**
23108     * Set if the markers associated to the group class @clas are hidden or not.
23109     *
23110     * @param clas The group class.
23111     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23112     * to show them.
23113     *
23114     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23115     * is to show them.
23116     *
23117     * @ingroup Map
23118     */
23119    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23120
23121    /**
23122     * Create a new marker class.
23123     *
23124     * @param obj The map object.
23125     * @return Returns the new group class.
23126     *
23127     * Each marker must be associated to a class.
23128     *
23129     * The marker class defines the style of the marker when a marker is
23130     * displayed alone, i.e., not grouped to to others markers. When grouped
23131     * it will use group class style.
23132     *
23133     * A marker class will need to be provided when creating a marker with
23134     * elm_map_marker_add().
23135     *
23136     * Some properties and functions can be set by class, as:
23137     * - style, with elm_map_marker_class_style_set()
23138     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23139     *   It can be set using elm_map_marker_class_icon_cb_set().
23140     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23141     *   Set using elm_map_marker_class_get_cb_set().
23142     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23143     *   Set using elm_map_marker_class_del_cb_set().
23144     *
23145     * @see elm_map_marker_add()
23146     * @see elm_map_marker_class_style_set()
23147     * @see elm_map_marker_class_icon_cb_set()
23148     * @see elm_map_marker_class_get_cb_set()
23149     * @see elm_map_marker_class_del_cb_set()
23150     *
23151     * @ingroup Map
23152     */
23153    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23154
23155    /**
23156     * Set the marker's style of a marker class.
23157     *
23158     * @param clas The marker class.
23159     * @param style The style to be used by markers.
23160     *
23161     * Each marker must be associated to a marker class, and will use the style
23162     * defined by such class when alone, i.e., @b not grouped to other markers.
23163     *
23164     * The following styles are provided by default theme:
23165     * @li @c radio
23166     * @li @c radio2
23167     * @li @c empty
23168     *
23169     * @see elm_map_marker_class_new() for more details.
23170     * @see elm_map_marker_add()
23171     *
23172     * @ingroup Map
23173     */
23174    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23175
23176    /**
23177     * Set the icon callback function of a marker class.
23178     *
23179     * @param clas The marker class.
23180     * @param icon_get The callback function that will return the icon.
23181     *
23182     * Each marker must be associated to a marker class, and it can display a
23183     * custom icon. The function @p icon_get must return this icon.
23184     *
23185     * @see elm_map_marker_class_new() for more details.
23186     * @see elm_map_marker_add()
23187     *
23188     * @ingroup Map
23189     */
23190    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23191
23192    /**
23193     * Set the bubble content callback function of a marker class.
23194     *
23195     * @param clas The marker class.
23196     * @param get The callback function that will return the content.
23197     *
23198     * Each marker must be associated to a marker class, and it can display a
23199     * a content on a bubble that opens when the user click over the marker.
23200     * The function @p get must return this content object.
23201     *
23202     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23203     * can be used.
23204     *
23205     * @see elm_map_marker_class_new() for more details.
23206     * @see elm_map_marker_class_del_cb_set()
23207     * @see elm_map_marker_add()
23208     *
23209     * @ingroup Map
23210     */
23211    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23212
23213    /**
23214     * Set the callback function used to delete bubble content of a marker class.
23215     *
23216     * @param clas The marker class.
23217     * @param del The callback function that will delete the content.
23218     *
23219     * Each marker must be associated to a marker class, and it can display a
23220     * a content on a bubble that opens when the user click over the marker.
23221     * The function to return such content can be set with
23222     * elm_map_marker_class_get_cb_set().
23223     *
23224     * If this content must be freed, a callback function need to be
23225     * set for that task with this function.
23226     *
23227     * If this callback is defined it will have to delete (or not) the
23228     * object inside, but if the callback is not defined the object will be
23229     * destroyed with evas_object_del().
23230     *
23231     * @see elm_map_marker_class_new() for more details.
23232     * @see elm_map_marker_class_get_cb_set()
23233     * @see elm_map_marker_add()
23234     *
23235     * @ingroup Map
23236     */
23237    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23238
23239    /**
23240     * Get the list of available sources.
23241     *
23242     * @param obj The map object.
23243     * @return The source names list.
23244     *
23245     * It will provide a list with all available sources, that can be set as
23246     * current source with elm_map_source_name_set(), or get with
23247     * elm_map_source_name_get().
23248     *
23249     * Available sources:
23250     * @li "Mapnik"
23251     * @li "Osmarender"
23252     * @li "CycleMap"
23253     * @li "Maplint"
23254     *
23255     * @see elm_map_source_name_set() for more details.
23256     * @see elm_map_source_name_get()
23257     *
23258     * @ingroup Map
23259     */
23260    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23261
23262    /**
23263     * Set the source of the map.
23264     *
23265     * @param obj The map object.
23266     * @param source The source to be used.
23267     *
23268     * Map widget retrieves images that composes the map from a web service.
23269     * This web service can be set with this method.
23270     *
23271     * A different service can return a different maps with different
23272     * information and it can use different zoom values.
23273     *
23274     * The @p source_name need to match one of the names provided by
23275     * elm_map_source_names_get().
23276     *
23277     * The current source can be get using elm_map_source_name_get().
23278     *
23279     * @see elm_map_source_names_get()
23280     * @see elm_map_source_name_get()
23281     *
23282     *
23283     * @ingroup Map
23284     */
23285    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23286
23287    /**
23288     * Get the name of currently used source.
23289     *
23290     * @param obj The map object.
23291     * @return Returns the name of the source in use.
23292     *
23293     * @see elm_map_source_name_set() for more details.
23294     *
23295     * @ingroup Map
23296     */
23297    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23298
23299    /**
23300     * Set the source of the route service to be used by the map.
23301     *
23302     * @param obj The map object.
23303     * @param source The route service to be used, being it one of
23304     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23305     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23306     *
23307     * Each one has its own algorithm, so the route retrieved may
23308     * differ depending on the source route. Now, only the default is working.
23309     *
23310     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23311     * http://www.yournavigation.org/.
23312     *
23313     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23314     * assumptions. Its routing core is based on Contraction Hierarchies.
23315     *
23316     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23317     *
23318     * @see elm_map_route_source_get().
23319     *
23320     * @ingroup Map
23321     */
23322    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23323
23324    /**
23325     * Get the current route source.
23326     *
23327     * @param obj The map object.
23328     * @return The source of the route service used by the map.
23329     *
23330     * @see elm_map_route_source_set() for details.
23331     *
23332     * @ingroup Map
23333     */
23334    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23335
23336    /**
23337     * Set the minimum zoom of the source.
23338     *
23339     * @param obj The map object.
23340     * @param zoom New minimum zoom value to be used.
23341     *
23342     * By default, it's 0.
23343     *
23344     * @ingroup Map
23345     */
23346    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23347
23348    /**
23349     * Get the minimum zoom of the source.
23350     *
23351     * @param obj The map object.
23352     * @return Returns the minimum zoom of the source.
23353     *
23354     * @see elm_map_source_zoom_min_set() for details.
23355     *
23356     * @ingroup Map
23357     */
23358    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23359
23360    /**
23361     * Set the maximum zoom of the source.
23362     *
23363     * @param obj The map object.
23364     * @param zoom New maximum zoom value to be used.
23365     *
23366     * By default, it's 18.
23367     *
23368     * @ingroup Map
23369     */
23370    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23371
23372    /**
23373     * Get the maximum zoom of the source.
23374     *
23375     * @param obj The map object.
23376     * @return Returns the maximum zoom of the source.
23377     *
23378     * @see elm_map_source_zoom_min_set() for details.
23379     *
23380     * @ingroup Map
23381     */
23382    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23383
23384    /**
23385     * Set the user agent used by the map object to access routing services.
23386     *
23387     * @param obj The map object.
23388     * @param user_agent The user agent to be used by the map.
23389     *
23390     * User agent is a client application implementing a network protocol used
23391     * in communications within a client–server distributed computing system
23392     *
23393     * The @p user_agent identification string will transmitted in a header
23394     * field @c User-Agent.
23395     *
23396     * @see elm_map_user_agent_get()
23397     *
23398     * @ingroup Map
23399     */
23400    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23401
23402    /**
23403     * Get the user agent used by the map object.
23404     *
23405     * @param obj The map object.
23406     * @return The user agent identification string used by the map.
23407     *
23408     * @see elm_map_user_agent_set() for details.
23409     *
23410     * @ingroup Map
23411     */
23412    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23413
23414    /**
23415     * Add a new route to the map object.
23416     *
23417     * @param obj The map object.
23418     * @param type The type of transport to be considered when tracing a route.
23419     * @param method The routing method, what should be priorized.
23420     * @param flon The start longitude.
23421     * @param flat The start latitude.
23422     * @param tlon The destination longitude.
23423     * @param tlat The destination latitude.
23424     *
23425     * @return The created route or @c NULL upon failure.
23426     *
23427     * A route will be traced by point on coordinates (@p flat, @p flon)
23428     * to point on coordinates (@p tlat, @p tlon), using the route service
23429     * set with elm_map_route_source_set().
23430     *
23431     * It will take @p type on consideration to define the route,
23432     * depending if the user will be walking or driving, the route may vary.
23433     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23434     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23435     *
23436     * Another parameter is what the route should priorize, the minor distance
23437     * or the less time to be spend on the route. So @p method should be one
23438     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23439     *
23440     * Routes created with this method can be deleted with
23441     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23442     * and distance can be get with elm_map_route_distance_get().
23443     *
23444     * @see elm_map_route_remove()
23445     * @see elm_map_route_color_set()
23446     * @see elm_map_route_distance_get()
23447     * @see elm_map_route_source_set()
23448     *
23449     * @ingroup Map
23450     */
23451    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);
23452
23453    /**
23454     * Remove a route from the map.
23455     *
23456     * @param route The route to remove.
23457     *
23458     * @see elm_map_route_add()
23459     *
23460     * @ingroup Map
23461     */
23462    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23463
23464    /**
23465     * Set the route color.
23466     *
23467     * @param route The route object.
23468     * @param r Red channel value, from 0 to 255.
23469     * @param g Green channel value, from 0 to 255.
23470     * @param b Blue channel value, from 0 to 255.
23471     * @param a Alpha channel value, from 0 to 255.
23472     *
23473     * It uses an additive color model, so each color channel represents
23474     * how much of each primary colors must to be used. 0 represents
23475     * ausence of this color, so if all of the three are set to 0,
23476     * the color will be black.
23477     *
23478     * These component values should be integers in the range 0 to 255,
23479     * (single 8-bit byte).
23480     *
23481     * This sets the color used for the route. By default, it is set to
23482     * solid red (r = 255, g = 0, b = 0, a = 255).
23483     *
23484     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23485     *
23486     * @see elm_map_route_color_get()
23487     *
23488     * @ingroup Map
23489     */
23490    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23491
23492    /**
23493     * Get the route color.
23494     *
23495     * @param route The route object.
23496     * @param r Pointer where to store the red channel value.
23497     * @param g Pointer where to store the green channel value.
23498     * @param b Pointer where to store the blue channel value.
23499     * @param a Pointer where to store the alpha channel value.
23500     *
23501     * @see elm_map_route_color_set() for details.
23502     *
23503     * @ingroup Map
23504     */
23505    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23506
23507    /**
23508     * Get the route distance in kilometers.
23509     *
23510     * @param route The route object.
23511     * @return The distance of route (unit : km).
23512     *
23513     * @ingroup Map
23514     */
23515    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23516
23517    /**
23518     * Get the information of route nodes.
23519     *
23520     * @param route The route object.
23521     * @return Returns a string with the nodes of route.
23522     *
23523     * @ingroup Map
23524     */
23525    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23526
23527    /**
23528     * Get the information of route waypoint.
23529     *
23530     * @param route the route object.
23531     * @return Returns a string with information about waypoint of route.
23532     *
23533     * @ingroup Map
23534     */
23535    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23536
23537    /**
23538     * Get the address of the name.
23539     *
23540     * @param name The name handle.
23541     * @return Returns the address string of @p name.
23542     *
23543     * This gets the coordinates of the @p name, created with one of the
23544     * conversion functions.
23545     *
23546     * @see elm_map_utils_convert_name_into_coord()
23547     * @see elm_map_utils_convert_coord_into_name()
23548     *
23549     * @ingroup Map
23550     */
23551    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23552
23553    /**
23554     * Get the current coordinates of the name.
23555     *
23556     * @param name The name handle.
23557     * @param lat Pointer where to store the latitude.
23558     * @param lon Pointer where to store The longitude.
23559     *
23560     * This gets the coordinates of the @p name, created with one of the
23561     * conversion functions.
23562     *
23563     * @see elm_map_utils_convert_name_into_coord()
23564     * @see elm_map_utils_convert_coord_into_name()
23565     *
23566     * @ingroup Map
23567     */
23568    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23569
23570    /**
23571     * Remove a name from the map.
23572     *
23573     * @param name The name to remove.
23574     *
23575     * Basically the struct handled by @p name will be freed, so convertions
23576     * between address and coordinates will be lost.
23577     *
23578     * @see elm_map_utils_convert_name_into_coord()
23579     * @see elm_map_utils_convert_coord_into_name()
23580     *
23581     * @ingroup Map
23582     */
23583    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23584
23585    /**
23586     * Rotate the map.
23587     *
23588     * @param obj The map object.
23589     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23590     * @param cx Rotation's center horizontal position.
23591     * @param cy Rotation's center vertical position.
23592     *
23593     * @see elm_map_rotate_get()
23594     *
23595     * @ingroup Map
23596     */
23597    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23598
23599    /**
23600     * Get the rotate degree of the map
23601     *
23602     * @param obj The map object
23603     * @param degree Pointer where to store degrees from 0.0 to 360.0
23604     * to rotate arount Z axis.
23605     * @param cx Pointer where to store rotation's center horizontal position.
23606     * @param cy Pointer where to store rotation's center vertical position.
23607     *
23608     * @see elm_map_rotate_set() to set map rotation.
23609     *
23610     * @ingroup Map
23611     */
23612    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);
23613
23614    /**
23615     * Enable or disable mouse wheel to be used to zoom in / out the map.
23616     *
23617     * @param obj The map object.
23618     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23619     * to enable it.
23620     *
23621     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23622     *
23623     * It's disabled by default.
23624     *
23625     * @see elm_map_wheel_disabled_get()
23626     *
23627     * @ingroup Map
23628     */
23629    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23630
23631    /**
23632     * Get a value whether mouse wheel is enabled or not.
23633     *
23634     * @param obj The map object.
23635     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23636     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23637     *
23638     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23639     *
23640     * @see elm_map_wheel_disabled_set() for details.
23641     *
23642     * @ingroup Map
23643     */
23644    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23645
23646 #ifdef ELM_EMAP
23647    /**
23648     * Add a track on the map
23649     *
23650     * @param obj The map object.
23651     * @param emap The emap route object.
23652     * @return The route object. This is an elm object of type Route.
23653     *
23654     * @see elm_route_add() for details.
23655     *
23656     * @ingroup Map
23657     */
23658    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23659 #endif
23660
23661    /**
23662     * Remove a track from the map
23663     *
23664     * @param obj The map object.
23665     * @param route The track to remove.
23666     *
23667     * @ingroup Map
23668     */
23669    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23670
23671    /**
23672     * @}
23673     */
23674
23675    /* Route */
23676    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23677 #ifdef ELM_EMAP
23678    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23679 #endif
23680    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23681    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23682    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23683    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23684
23685
23686    /**
23687     * @defgroup Panel Panel
23688     *
23689     * @image html img/widget/panel/preview-00.png
23690     * @image latex img/widget/panel/preview-00.eps
23691     *
23692     * @brief A panel is a type of animated container that contains subobjects.
23693     * It can be expanded or contracted by clicking the button on it's edge.
23694     *
23695     * Orientations are as follows:
23696     * @li ELM_PANEL_ORIENT_TOP
23697     * @li ELM_PANEL_ORIENT_LEFT
23698     * @li ELM_PANEL_ORIENT_RIGHT
23699     *
23700     * To set/get/unset the content of the panel, you can use
23701     * elm_object_content_set/get/unset APIs.
23702     * Once the content object is set, a previously set one will be deleted.
23703     * If you want to keep that old content object, use the
23704     * elm_object_content_unset() function
23705     *
23706     * @ref tutorial_panel shows one way to use this widget.
23707     * @{
23708     */
23709    typedef enum _Elm_Panel_Orient
23710      {
23711         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23712         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23713         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23714         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23715      } Elm_Panel_Orient;
23716    /**
23717     * @brief Adds a panel object
23718     *
23719     * @param parent The parent object
23720     *
23721     * @return The panel object, or NULL on failure
23722     */
23723    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23724    /**
23725     * @brief Sets the orientation of the panel
23726     *
23727     * @param parent The parent object
23728     * @param orient The panel orientation. Can be one of the following:
23729     * @li ELM_PANEL_ORIENT_TOP
23730     * @li ELM_PANEL_ORIENT_LEFT
23731     * @li ELM_PANEL_ORIENT_RIGHT
23732     *
23733     * Sets from where the panel will (dis)appear.
23734     */
23735    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23736    /**
23737     * @brief Get the orientation of the panel.
23738     *
23739     * @param obj The panel object
23740     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23741     */
23742    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23743    /**
23744     * @brief Set the content of the panel.
23745     *
23746     * @param obj The panel object
23747     * @param content The panel content
23748     *
23749     * Once the content object is set, a previously set one will be deleted.
23750     * If you want to keep that old content object, use the
23751     * elm_panel_content_unset() function.
23752     */
23753    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23754    /**
23755     * @brief Get the content of the panel.
23756     *
23757     * @param obj The panel object
23758     * @return The content that is being used
23759     *
23760     * Return the content object which is set for this widget.
23761     *
23762     * @see elm_panel_content_set()
23763     */
23764    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23765    /**
23766     * @brief Unset the content of the panel.
23767     *
23768     * @param obj The panel object
23769     * @return The content that was being used
23770     *
23771     * Unparent and return the content object which was set for this widget.
23772     *
23773     * @see elm_panel_content_set()
23774     */
23775    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23776    /**
23777     * @brief Set the state of the panel.
23778     *
23779     * @param obj The panel object
23780     * @param hidden If true, the panel will run the animation to contract
23781     */
23782    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23783    /**
23784     * @brief Get the state of the panel.
23785     *
23786     * @param obj The panel object
23787     * @param hidden If true, the panel is in the "hide" state
23788     */
23789    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23790    /**
23791     * @brief Toggle the hidden state of the panel from code
23792     *
23793     * @param obj The panel object
23794     */
23795    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23796    /**
23797     * @}
23798     */
23799
23800    /**
23801     * @defgroup Panes Panes
23802     * @ingroup Elementary
23803     *
23804     * @image html img/widget/panes/preview-00.png
23805     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23806     *
23807     * @image html img/panes.png
23808     * @image latex img/panes.eps width=\textwidth
23809     *
23810     * The panes adds a dragable bar between two contents. When dragged
23811     * this bar will resize contents size.
23812     *
23813     * Panes can be displayed vertically or horizontally, and contents
23814     * size proportion can be customized (homogeneous by default).
23815     *
23816     * Smart callbacks one can listen to:
23817     * - "press" - The panes has been pressed (button wasn't released yet).
23818     * - "unpressed" - The panes was released after being pressed.
23819     * - "clicked" - The panes has been clicked>
23820     * - "clicked,double" - The panes has been double clicked
23821     *
23822     * Available styles for it:
23823     * - @c "default"
23824     *
23825     * Default contents parts of the panes widget that you can use for are:
23826     * @li "elm.swallow.left" - A leftside content of the panes
23827     * @li "elm.swallow.right" - A rightside content of the panes
23828     *
23829     * If panes is displayed vertically, left content will be displayed at
23830     * top.
23831     * 
23832     * Here is an example on its usage:
23833     * @li @ref panes_example
23834     */
23835
23836 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23837 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23838
23839    /**
23840     * @addtogroup Panes
23841     * @{
23842     */
23843
23844    /**
23845     * Add a new panes widget to the given parent Elementary
23846     * (container) object.
23847     *
23848     * @param parent The parent object.
23849     * @return a new panes widget handle or @c NULL, on errors.
23850     *
23851     * This function inserts a new panes widget on the canvas.
23852     *
23853     * @ingroup Panes
23854     */
23855    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23856
23857    /**
23858     * Set the left content of the panes widget.
23859     *
23860     * @param obj The panes object.
23861     * @param content The new left content object.
23862     *
23863     * Once the content object is set, a previously set one will be deleted.
23864     * If you want to keep that old content object, use the
23865     * elm_panes_content_left_unset() function.
23866     *
23867     * If panes is displayed vertically, left content will be displayed at
23868     * top.
23869     *
23870     * @see elm_panes_content_left_get()
23871     * @see elm_panes_content_right_set() to set content on the other side.
23872     *
23873     * @ingroup Panes
23874     */
23875    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23876
23877    /**
23878     * Set the right content of the panes widget.
23879     *
23880     * @param obj The panes object.
23881     * @param content The new right content object.
23882     *
23883     * Once the content object is set, a previously set one will be deleted.
23884     * If you want to keep that old content object, use the
23885     * elm_panes_content_right_unset() function.
23886     *
23887     * If panes is displayed vertically, left content will be displayed at
23888     * bottom.
23889     *
23890     * @see elm_panes_content_right_get()
23891     * @see elm_panes_content_left_set() to set content on the other side.
23892     *
23893     * @ingroup Panes
23894     */
23895    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23896
23897    /**
23898     * Get the left content of the panes.
23899     *
23900     * @param obj The panes object.
23901     * @return The left content object that is being used.
23902     *
23903     * Return the left content object which is set for this widget.
23904     *
23905     * @see elm_panes_content_left_set() for details.
23906     *
23907     * @ingroup Panes
23908     */
23909    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23910
23911    /**
23912     * Get the right content of the panes.
23913     *
23914     * @param obj The panes object
23915     * @return The right content object that is being used
23916     *
23917     * Return the right content object which is set for this widget.
23918     *
23919     * @see elm_panes_content_right_set() for details.
23920     *
23921     * @ingroup Panes
23922     */
23923    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23924
23925    /**
23926     * Unset the left content used for the panes.
23927     *
23928     * @param obj The panes object.
23929     * @return The left content object that was being used.
23930     *
23931     * Unparent and return the left content object which was set for this widget.
23932     *
23933     * @see elm_panes_content_left_set() for details.
23934     * @see elm_panes_content_left_get().
23935     *
23936     * @ingroup Panes
23937     */
23938    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23939
23940    /**
23941     * Unset the right content used for the panes.
23942     *
23943     * @param obj The panes object.
23944     * @return The right content object that was being used.
23945     *
23946     * Unparent and return the right content object which was set for this
23947     * widget.
23948     *
23949     * @see elm_panes_content_right_set() for details.
23950     * @see elm_panes_content_right_get().
23951     *
23952     * @ingroup Panes
23953     */
23954    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23955
23956    /**
23957     * Get the size proportion of panes widget's left side.
23958     *
23959     * @param obj The panes object.
23960     * @return float value between 0.0 and 1.0 representing size proportion
23961     * of left side.
23962     *
23963     * @see elm_panes_content_left_size_set() for more details.
23964     *
23965     * @ingroup Panes
23966     */
23967    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23968
23969    /**
23970     * Set the size proportion of panes widget's left side.
23971     *
23972     * @param obj The panes object.
23973     * @param size Value between 0.0 and 1.0 representing size proportion
23974     * of left side.
23975     *
23976     * By default it's homogeneous, i.e., both sides have the same size.
23977     *
23978     * If something different is required, it can be set with this function.
23979     * For example, if the left content should be displayed over
23980     * 75% of the panes size, @p size should be passed as @c 0.75.
23981     * This way, right content will be resized to 25% of panes size.
23982     *
23983     * If displayed vertically, left content is displayed at top, and
23984     * right content at bottom.
23985     *
23986     * @note This proportion will change when user drags the panes bar.
23987     *
23988     * @see elm_panes_content_left_size_get()
23989     *
23990     * @ingroup Panes
23991     */
23992    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23993
23994   /**
23995    * Set the orientation of a given panes widget.
23996    *
23997    * @param obj The panes object.
23998    * @param horizontal Use @c EINA_TRUE to make @p obj to be
23999    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24000    *
24001    * Use this function to change how your panes is to be
24002    * disposed: vertically or horizontally.
24003    *
24004    * By default it's displayed horizontally.
24005    *
24006    * @see elm_panes_horizontal_get()
24007    *
24008    * @ingroup Panes
24009    */
24010    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24011
24012    /**
24013     * Retrieve the orientation of a given panes widget.
24014     *
24015     * @param obj The panes object.
24016     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24017     * @c EINA_FALSE if it's @b vertical (and on errors).
24018     *
24019     * @see elm_panes_horizontal_set() for more details.
24020     *
24021     * @ingroup Panes
24022     */
24023    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24024    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24025    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24026
24027    /**
24028     * @}
24029     */
24030
24031    /**
24032     * @defgroup Flip Flip
24033     *
24034     * @image html img/widget/flip/preview-00.png
24035     * @image latex img/widget/flip/preview-00.eps
24036     *
24037     * This widget holds 2 content objects(Evas_Object): one on the front and one
24038     * on the back. It allows you to flip from front to back and vice-versa using
24039     * various animations.
24040     *
24041     * If either the front or back contents are not set the flip will treat that
24042     * as transparent. So if you wore to set the front content but not the back,
24043     * and then call elm_flip_go() you would see whatever is below the flip.
24044     *
24045     * For a list of supported animations see elm_flip_go().
24046     *
24047     * Signals that you can add callbacks for are:
24048     * "animate,begin" - when a flip animation was started
24049     * "animate,done" - when a flip animation is finished
24050     *
24051     * @ref tutorial_flip show how to use most of the API.
24052     *
24053     * @{
24054     */
24055    typedef enum _Elm_Flip_Mode
24056      {
24057         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24058         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24059         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24060         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24061         ELM_FLIP_CUBE_LEFT,
24062         ELM_FLIP_CUBE_RIGHT,
24063         ELM_FLIP_CUBE_UP,
24064         ELM_FLIP_CUBE_DOWN,
24065         ELM_FLIP_PAGE_LEFT,
24066         ELM_FLIP_PAGE_RIGHT,
24067         ELM_FLIP_PAGE_UP,
24068         ELM_FLIP_PAGE_DOWN
24069      } Elm_Flip_Mode;
24070    typedef enum _Elm_Flip_Interaction
24071      {
24072         ELM_FLIP_INTERACTION_NONE,
24073         ELM_FLIP_INTERACTION_ROTATE,
24074         ELM_FLIP_INTERACTION_CUBE,
24075         ELM_FLIP_INTERACTION_PAGE
24076      } Elm_Flip_Interaction;
24077    typedef enum _Elm_Flip_Direction
24078      {
24079         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24080         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24081         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24082         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24083      } Elm_Flip_Direction;
24084    /**
24085     * @brief Add a new flip to the parent
24086     *
24087     * @param parent The parent object
24088     * @return The new object or NULL if it cannot be created
24089     */
24090    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24091    /**
24092     * @brief Set the front content of the flip widget.
24093     *
24094     * @param obj The flip object
24095     * @param content The new front content object
24096     *
24097     * Once the content object is set, a previously set one will be deleted.
24098     * If you want to keep that old content object, use the
24099     * elm_flip_content_front_unset() function.
24100     */
24101    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24102    /**
24103     * @brief Set the back content of the flip widget.
24104     *
24105     * @param obj The flip object
24106     * @param content The new back content object
24107     *
24108     * Once the content object is set, a previously set one will be deleted.
24109     * If you want to keep that old content object, use the
24110     * elm_flip_content_back_unset() function.
24111     */
24112    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24113    /**
24114     * @brief Get the front content used for the flip
24115     *
24116     * @param obj The flip object
24117     * @return The front content object that is being used
24118     *
24119     * Return the front content object which is set for this widget.
24120     */
24121    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24122    /**
24123     * @brief Get the back content used for the flip
24124     *
24125     * @param obj The flip object
24126     * @return The back content object that is being used
24127     *
24128     * Return the back content object which is set for this widget.
24129     */
24130    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24131    /**
24132     * @brief Unset the front content used for the flip
24133     *
24134     * @param obj The flip object
24135     * @return The front content object that was being used
24136     *
24137     * Unparent and return the front content object which was set for this widget.
24138     */
24139    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24140    /**
24141     * @brief Unset the back content used for the flip
24142     *
24143     * @param obj The flip object
24144     * @return The back content object that was being used
24145     *
24146     * Unparent and return the back content object which was set for this widget.
24147     */
24148    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24149    /**
24150     * @brief Get flip front visibility state
24151     *
24152     * @param obj The flip objct
24153     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24154     * showing.
24155     */
24156    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24157    /**
24158     * @brief Set flip perspective
24159     *
24160     * @param obj The flip object
24161     * @param foc The coordinate to set the focus on
24162     * @param x The X coordinate
24163     * @param y The Y coordinate
24164     *
24165     * @warning This function currently does nothing.
24166     */
24167    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24168    /**
24169     * @brief Runs the flip animation
24170     *
24171     * @param obj The flip object
24172     * @param mode The mode type
24173     *
24174     * Flips the front and back contents using the @p mode animation. This
24175     * efectively hides the currently visible content and shows the hidden one.
24176     *
24177     * There a number of possible animations to use for the flipping:
24178     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24179     * around a horizontal axis in the middle of its height, the other content
24180     * is shown as the other side of the flip.
24181     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24182     * around a vertical axis in the middle of its width, the other content is
24183     * shown as the other side of the flip.
24184     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24185     * around a diagonal axis in the middle of its width, the other content is
24186     * shown as the other side of the flip.
24187     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24188     * around a diagonal axis in the middle of its height, the other content is
24189     * shown as the other side of the flip.
24190     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24191     * as if the flip was a cube, the other content is show as the right face of
24192     * the cube.
24193     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24194     * right as if the flip was a cube, the other content is show as the left
24195     * face of the cube.
24196     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24197     * flip was a cube, the other content is show as the bottom face of the cube.
24198     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24199     * the flip was a cube, the other content is show as the upper face of the
24200     * cube.
24201     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24202     * if the flip was a book, the other content is shown as the page below that.
24203     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24204     * as if the flip was a book, the other content is shown as the page below
24205     * that.
24206     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24207     * flip was a book, the other content is shown as the page below that.
24208     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24209     * flip was a book, the other content is shown as the page below that.
24210     *
24211     * @image html elm_flip.png
24212     * @image latex elm_flip.eps width=\textwidth
24213     */
24214    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24215    /**
24216     * @brief Set the interactive flip mode
24217     *
24218     * @param obj The flip object
24219     * @param mode The interactive flip mode to use
24220     *
24221     * This sets if the flip should be interactive (allow user to click and
24222     * drag a side of the flip to reveal the back page and cause it to flip).
24223     * By default a flip is not interactive. You may also need to set which
24224     * sides of the flip are "active" for flipping and how much space they use
24225     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24226     * and elm_flip_interacton_direction_hitsize_set()
24227     *
24228     * The four avilable mode of interaction are:
24229     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24230     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24231     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24232     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24233     *
24234     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24235     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24236     * happen, those can only be acheived with elm_flip_go();
24237     */
24238    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24239    /**
24240     * @brief Get the interactive flip mode
24241     *
24242     * @param obj The flip object
24243     * @return The interactive flip mode
24244     *
24245     * Returns the interactive flip mode set by elm_flip_interaction_set()
24246     */
24247    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24248    /**
24249     * @brief Set which directions of the flip respond to interactive flip
24250     *
24251     * @param obj The flip object
24252     * @param dir The direction to change
24253     * @param enabled If that direction is enabled or not
24254     *
24255     * By default all directions are disabled, so you may want to enable the
24256     * desired directions for flipping if you need interactive flipping. You must
24257     * call this function once for each direction that should be enabled.
24258     *
24259     * @see elm_flip_interaction_set()
24260     */
24261    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24262    /**
24263     * @brief Get the enabled state of that flip direction
24264     *
24265     * @param obj The flip object
24266     * @param dir The direction to check
24267     * @return If that direction is enabled or not
24268     *
24269     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24270     *
24271     * @see elm_flip_interaction_set()
24272     */
24273    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24274    /**
24275     * @brief Set the amount of the flip that is sensitive to interactive flip
24276     *
24277     * @param obj The flip object
24278     * @param dir The direction to modify
24279     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24280     *
24281     * Set the amount of the flip that is sensitive to interactive flip, with 0
24282     * representing no area in the flip and 1 representing the entire flip. There
24283     * is however a consideration to be made in that the area will never be
24284     * smaller than the finger size set(as set in your Elementary configuration).
24285     *
24286     * @see elm_flip_interaction_set()
24287     */
24288    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24289    /**
24290     * @brief Get the amount of the flip that is sensitive to interactive flip
24291     *
24292     * @param obj The flip object
24293     * @param dir The direction to check
24294     * @return The size set for that direction
24295     *
24296     * Returns the amount os sensitive area set by
24297     * elm_flip_interacton_direction_hitsize_set().
24298     */
24299    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24300    /**
24301     * @}
24302     */
24303
24304    /* scrolledentry */
24305    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24306    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24307    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24308    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24309    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24310    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24311    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24312    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24313    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24314    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24315    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24316    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24317    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24318    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24319    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24320    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24321    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24322    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24323    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24324    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24325    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24326    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24327    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24328    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24329    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24330    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24331    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24332    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24333    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24334    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24335    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24336    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24337    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24338    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24339    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24340    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);
24341    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24342    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24343    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);
24344    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24345    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);
24346    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24347    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24348    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24349    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24350    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24351    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24352    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24353    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24354    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);
24355    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);
24356    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);
24357    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);
24358    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);
24359    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);
24360    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24361    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24362    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24363    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24364    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24365    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24366    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24367
24368    /**
24369     * @defgroup Conformant Conformant
24370     * @ingroup Elementary
24371     *
24372     * @image html img/widget/conformant/preview-00.png
24373     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24374     *
24375     * @image html img/conformant.png
24376     * @image latex img/conformant.eps width=\textwidth
24377     *
24378     * The aim is to provide a widget that can be used in elementary apps to
24379     * account for space taken up by the indicator, virtual keypad & softkey
24380     * windows when running the illume2 module of E17.
24381     *
24382     * So conformant content will be sized and positioned considering the
24383     * space required for such stuff, and when they popup, as a keyboard
24384     * shows when an entry is selected, conformant content won't change.
24385     *
24386     * Available styles for it:
24387     * - @c "default"
24388     *
24389     * Default contents parts of the conformant widget that you can use for are:
24390     * @li "elm.swallow.content" - A content of the conformant
24391     *
24392     * See how to use this widget in this example:
24393     * @ref conformant_example
24394     */
24395
24396    /**
24397     * @addtogroup Conformant
24398     * @{
24399     */
24400
24401    /**
24402     * Add a new conformant widget to the given parent Elementary
24403     * (container) object.
24404     *
24405     * @param parent The parent object.
24406     * @return A new conformant widget handle or @c NULL, on errors.
24407     *
24408     * This function inserts a new conformant widget on the canvas.
24409     *
24410     * @ingroup Conformant
24411     */
24412    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24413
24414    /**
24415     * Set the content of the conformant widget.
24416     *
24417     * @param obj The conformant object.
24418     * @param content The content to be displayed by the conformant.
24419     *
24420     * Content will be sized and positioned considering the space required
24421     * to display a virtual keyboard. So it won't fill all the conformant
24422     * size. This way is possible to be sure that content won't resize
24423     * or be re-positioned after the keyboard is displayed.
24424     *
24425     * Once the content object is set, a previously set one will be deleted.
24426     * If you want to keep that old content object, use the
24427     * elm_object_content_unset() function.
24428     *
24429     * @see elm_object_content_unset()
24430     * @see elm_object_content_get()
24431     *
24432     * @ingroup Conformant
24433     */
24434    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24435
24436    /**
24437     * Get the content of the conformant widget.
24438     *
24439     * @param obj The conformant object.
24440     * @return The content that is being used.
24441     *
24442     * Return the content object which is set for this widget.
24443     * It won't be unparent from conformant. For that, use
24444     * elm_object_content_unset().
24445     *
24446     * @see elm_object_content_set().
24447     * @see elm_object_content_unset()
24448     *
24449     * @ingroup Conformant
24450     */
24451    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24452
24453    /**
24454     * Unset the content of the conformant widget.
24455     *
24456     * @param obj The conformant object.
24457     * @return The content that was being used.
24458     *
24459     * Unparent and return the content object which was set for this widget.
24460     *
24461     * @see elm_object_content_set().
24462     *
24463     * @ingroup Conformant
24464     */
24465    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24466
24467    /**
24468     * Returns the Evas_Object that represents the content area.
24469     *
24470     * @param obj The conformant object.
24471     * @return The content area of the widget.
24472     *
24473     * @ingroup Conformant
24474     */
24475    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24476
24477    /**
24478     * @}
24479     */
24480
24481    /**
24482     * @defgroup Mapbuf Mapbuf
24483     * @ingroup Elementary
24484     *
24485     * @image html img/widget/mapbuf/preview-00.png
24486     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24487     *
24488     * This holds one content object and uses an Evas Map of transformation
24489     * points to be later used with this content. So the content will be
24490     * moved, resized, etc as a single image. So it will improve performance
24491     * when you have a complex interafce, with a lot of elements, and will
24492     * need to resize or move it frequently (the content object and its
24493     * children).
24494     *
24495     * To set/get/unset the content of the mapbuf, you can use 
24496     * elm_object_content_set/get/unset APIs. 
24497     * Once the content object is set, a previously set one will be deleted.
24498     * If you want to keep that old content object, use the
24499     * elm_object_content_unset() function.
24500     *
24501     * To enable map, elm_mapbuf_enabled_set() should be used.
24502     * 
24503     * See how to use this widget in this example:
24504     * @ref mapbuf_example
24505     */
24506
24507    /**
24508     * @addtogroup Mapbuf
24509     * @{
24510     */
24511
24512    /**
24513     * Add a new mapbuf widget to the given parent Elementary
24514     * (container) object.
24515     *
24516     * @param parent The parent object.
24517     * @return A new mapbuf widget handle or @c NULL, on errors.
24518     *
24519     * This function inserts a new mapbuf widget on the canvas.
24520     *
24521     * @ingroup Mapbuf
24522     */
24523    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24524
24525    /**
24526     * Set the content of the mapbuf.
24527     *
24528     * @param obj The mapbuf object.
24529     * @param content The content that will be filled in this mapbuf object.
24530     *
24531     * Once the content object is set, a previously set one will be deleted.
24532     * If you want to keep that old content object, use the
24533     * elm_mapbuf_content_unset() function.
24534     *
24535     * To enable map, elm_mapbuf_enabled_set() should be used.
24536     *
24537     * @ingroup Mapbuf
24538     */
24539    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24540
24541    /**
24542     * Get the content of the mapbuf.
24543     *
24544     * @param obj The mapbuf object.
24545     * @return The content that is being used.
24546     *
24547     * Return the content object which is set for this widget.
24548     *
24549     * @see elm_mapbuf_content_set() for details.
24550     *
24551     * @ingroup Mapbuf
24552     */
24553    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24554
24555    /**
24556     * Unset the content of the mapbuf.
24557     *
24558     * @param obj The mapbuf object.
24559     * @return The content that was being used.
24560     *
24561     * Unparent and return the content object which was set for this widget.
24562     *
24563     * @see elm_mapbuf_content_set() for details.
24564     *
24565     * @ingroup Mapbuf
24566     */
24567    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24568
24569    /**
24570     * Enable or disable the map.
24571     *
24572     * @param obj The mapbuf object.
24573     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24574     *
24575     * This enables the map that is set or disables it. On enable, the object
24576     * geometry will be saved, and the new geometry will change (position and
24577     * size) to reflect the map geometry set.
24578     *
24579     * Also, when enabled, alpha and smooth states will be used, so if the
24580     * content isn't solid, alpha should be enabled, for example, otherwise
24581     * a black retangle will fill the content.
24582     *
24583     * When disabled, the stored map will be freed and geometry prior to
24584     * enabling the map will be restored.
24585     *
24586     * It's disabled by default.
24587     *
24588     * @see elm_mapbuf_alpha_set()
24589     * @see elm_mapbuf_smooth_set()
24590     *
24591     * @ingroup Mapbuf
24592     */
24593    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24594
24595    /**
24596     * Get a value whether map is enabled or not.
24597     *
24598     * @param obj The mapbuf object.
24599     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24600     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24601     *
24602     * @see elm_mapbuf_enabled_set() for details.
24603     *
24604     * @ingroup Mapbuf
24605     */
24606    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24607
24608    /**
24609     * Enable or disable smooth map rendering.
24610     *
24611     * @param obj The mapbuf object.
24612     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24613     * to disable it.
24614     *
24615     * This sets smoothing for map rendering. If the object is a type that has
24616     * its own smoothing settings, then both the smooth settings for this object
24617     * and the map must be turned off.
24618     *
24619     * By default smooth maps are enabled.
24620     *
24621     * @ingroup Mapbuf
24622     */
24623    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24624
24625    /**
24626     * Get a value whether smooth map rendering is enabled or not.
24627     *
24628     * @param obj The mapbuf object.
24629     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24630     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24631     *
24632     * @see elm_mapbuf_smooth_set() for details.
24633     *
24634     * @ingroup Mapbuf
24635     */
24636    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24637
24638    /**
24639     * Set or unset alpha flag for map rendering.
24640     *
24641     * @param obj The mapbuf object.
24642     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24643     * to disable it.
24644     *
24645     * This sets alpha flag for map rendering. If the object is a type that has
24646     * its own alpha settings, then this will take precedence. Only image objects
24647     * have this currently. It stops alpha blending of the map area, and is
24648     * useful if you know the object and/or all sub-objects is 100% solid.
24649     *
24650     * Alpha is enabled by default.
24651     *
24652     * @ingroup Mapbuf
24653     */
24654    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24655
24656    /**
24657     * Get a value whether alpha blending is enabled or not.
24658     *
24659     * @param obj The mapbuf object.
24660     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24661     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24662     *
24663     * @see elm_mapbuf_alpha_set() for details.
24664     *
24665     * @ingroup Mapbuf
24666     */
24667    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24668
24669    /**
24670     * @}
24671     */
24672
24673    /**
24674     * @defgroup Flipselector Flip Selector
24675     *
24676     * @image html img/widget/flipselector/preview-00.png
24677     * @image latex img/widget/flipselector/preview-00.eps
24678     *
24679     * A flip selector is a widget to show a set of @b text items, one
24680     * at a time, with the same sheet switching style as the @ref Clock
24681     * "clock" widget, when one changes the current displaying sheet
24682     * (thus, the "flip" in the name).
24683     *
24684     * User clicks to flip sheets which are @b held for some time will
24685     * make the flip selector to flip continuosly and automatically for
24686     * the user. The interval between flips will keep growing in time,
24687     * so that it helps the user to reach an item which is distant from
24688     * the current selection.
24689     *
24690     * Smart callbacks one can register to:
24691     * - @c "selected" - when the widget's selected text item is changed
24692     * - @c "overflowed" - when the widget's current selection is changed
24693     *   from the first item in its list to the last
24694     * - @c "underflowed" - when the widget's current selection is changed
24695     *   from the last item in its list to the first
24696     *
24697     * Available styles for it:
24698     * - @c "default"
24699     *
24700     * Here is an example on its usage:
24701     * @li @ref flipselector_example
24702     */
24703
24704    /**
24705     * @addtogroup Flipselector
24706     * @{
24707     */
24708
24709    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24710
24711    /**
24712     * Add a new flip selector widget to the given parent Elementary
24713     * (container) widget
24714     *
24715     * @param parent The parent object
24716     * @return a new flip selector widget handle or @c NULL, on errors
24717     *
24718     * This function inserts a new flip selector widget on the canvas.
24719     *
24720     * @ingroup Flipselector
24721     */
24722    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24723
24724    /**
24725     * Programmatically select the next item of a flip selector widget
24726     *
24727     * @param obj The flipselector object
24728     *
24729     * @note The selection will be animated. Also, if it reaches the
24730     * end of its list of member items, it will continue with the first
24731     * one onwards.
24732     *
24733     * @ingroup Flipselector
24734     */
24735    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24736
24737    /**
24738     * Programmatically select the previous item of a flip selector
24739     * widget
24740     *
24741     * @param obj The flipselector object
24742     *
24743     * @note The selection will be animated.  Also, if it reaches the
24744     * beginning of its list of member items, it will continue with the
24745     * last one backwards.
24746     *
24747     * @ingroup Flipselector
24748     */
24749    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24750
24751    /**
24752     * Append a (text) item to a flip selector widget
24753     *
24754     * @param obj The flipselector object
24755     * @param label The (text) label of the new item
24756     * @param func Convenience callback function to take place when
24757     * item is selected
24758     * @param data Data passed to @p func, above
24759     * @return A handle to the item added or @c NULL, on errors
24760     *
24761     * The widget's list of labels to show will be appended with the
24762     * given value. If the user wishes so, a callback function pointer
24763     * can be passed, which will get called when this same item is
24764     * selected.
24765     *
24766     * @note The current selection @b won't be modified by appending an
24767     * element to the list.
24768     *
24769     * @note The maximum length of the text label is going to be
24770     * determined <b>by the widget's theme</b>. Strings larger than
24771     * that value are going to be @b truncated.
24772     *
24773     * @ingroup Flipselector
24774     */
24775    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24776
24777    /**
24778     * Prepend a (text) item to a flip selector widget
24779     *
24780     * @param obj The flipselector object
24781     * @param label The (text) label of the new item
24782     * @param func Convenience callback function to take place when
24783     * item is selected
24784     * @param data Data passed to @p func, above
24785     * @return A handle to the item added or @c NULL, on errors
24786     *
24787     * The widget's list of labels to show will be prepended with the
24788     * given value. If the user wishes so, a callback function pointer
24789     * can be passed, which will get called when this same item is
24790     * selected.
24791     *
24792     * @note The current selection @b won't be modified by prepending
24793     * an element to the list.
24794     *
24795     * @note The maximum length of the text label is going to be
24796     * determined <b>by the widget's theme</b>. Strings larger than
24797     * that value are going to be @b truncated.
24798     *
24799     * @ingroup Flipselector
24800     */
24801    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24802
24803    /**
24804     * Get the internal list of items in a given flip selector widget.
24805     *
24806     * @param obj The flipselector object
24807     * @return The list of items (#Elm_Flipselector_Item as data) or
24808     * @c NULL on errors.
24809     *
24810     * This list is @b not to be modified in any way and must not be
24811     * freed. Use the list members with functions like
24812     * elm_flipselector_item_label_set(),
24813     * elm_flipselector_item_label_get(),
24814     * elm_flipselector_item_del(),
24815     * elm_flipselector_item_selected_get(),
24816     * elm_flipselector_item_selected_set().
24817     *
24818     * @warning This list is only valid until @p obj object's internal
24819     * items list is changed. It should be fetched again with another
24820     * call to this function when changes happen.
24821     *
24822     * @ingroup Flipselector
24823     */
24824    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24825
24826    /**
24827     * Get the first item in the given flip selector widget's list of
24828     * items.
24829     *
24830     * @param obj The flipselector object
24831     * @return The first item or @c NULL, if it has no items (and on
24832     * errors)
24833     *
24834     * @see elm_flipselector_item_append()
24835     * @see elm_flipselector_last_item_get()
24836     *
24837     * @ingroup Flipselector
24838     */
24839    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24840
24841    /**
24842     * Get the last item in the given flip selector widget's list of
24843     * items.
24844     *
24845     * @param obj The flipselector object
24846     * @return The last item or @c NULL, if it has no items (and on
24847     * errors)
24848     *
24849     * @see elm_flipselector_item_prepend()
24850     * @see elm_flipselector_first_item_get()
24851     *
24852     * @ingroup Flipselector
24853     */
24854    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24855
24856    /**
24857     * Get the currently selected item in a flip selector widget.
24858     *
24859     * @param obj The flipselector object
24860     * @return The selected item or @c NULL, if the widget has no items
24861     * (and on erros)
24862     *
24863     * @ingroup Flipselector
24864     */
24865    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24866
24867    /**
24868     * Set whether a given flip selector widget's item should be the
24869     * currently selected one.
24870     *
24871     * @param item The flip selector item
24872     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24873     *
24874     * This sets whether @p item is or not the selected (thus, under
24875     * display) one. If @p item is different than one under display,
24876     * the latter will be unselected. If the @p item is set to be
24877     * unselected, on the other hand, the @b first item in the widget's
24878     * internal members list will be the new selected one.
24879     *
24880     * @see elm_flipselector_item_selected_get()
24881     *
24882     * @ingroup Flipselector
24883     */
24884    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24885
24886    /**
24887     * Get whether a given flip selector widget's item is the currently
24888     * selected one.
24889     *
24890     * @param item The flip selector item
24891     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24892     * (or on errors).
24893     *
24894     * @see elm_flipselector_item_selected_set()
24895     *
24896     * @ingroup Flipselector
24897     */
24898    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24899
24900    /**
24901     * Delete a given item from a flip selector widget.
24902     *
24903     * @param item The item to delete
24904     *
24905     * @ingroup Flipselector
24906     */
24907    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24908
24909    /**
24910     * Get the label of a given flip selector widget's item.
24911     *
24912     * @param item The item to get label from
24913     * @return The text label of @p item or @c NULL, on errors
24914     *
24915     * @see elm_flipselector_item_label_set()
24916     *
24917     * @ingroup Flipselector
24918     */
24919    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24920
24921    /**
24922     * Set the label of a given flip selector widget's item.
24923     *
24924     * @param item The item to set label on
24925     * @param label The text label string, in UTF-8 encoding
24926     *
24927     * @see elm_flipselector_item_label_get()
24928     *
24929     * @ingroup Flipselector
24930     */
24931    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24932
24933    /**
24934     * Gets the item before @p item in a flip selector widget's
24935     * internal list of items.
24936     *
24937     * @param item The item to fetch previous from
24938     * @return The item before the @p item, in its parent's list. If
24939     *         there is no previous item for @p item or there's an
24940     *         error, @c NULL is returned.
24941     *
24942     * @see elm_flipselector_item_next_get()
24943     *
24944     * @ingroup Flipselector
24945     */
24946    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24947
24948    /**
24949     * Gets the item after @p item in a flip selector widget's
24950     * internal list of items.
24951     *
24952     * @param item The item to fetch next from
24953     * @return The item after the @p item, in its parent's list. If
24954     *         there is no next item for @p item or there's an
24955     *         error, @c NULL is returned.
24956     *
24957     * @see elm_flipselector_item_next_get()
24958     *
24959     * @ingroup Flipselector
24960     */
24961    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24962
24963    /**
24964     * Set the interval on time updates for an user mouse button hold
24965     * on a flip selector widget.
24966     *
24967     * @param obj The flip selector object
24968     * @param interval The (first) interval value in seconds
24969     *
24970     * This interval value is @b decreased while the user holds the
24971     * mouse pointer either flipping up or flipping doww a given flip
24972     * selector.
24973     *
24974     * This helps the user to get to a given item distant from the
24975     * current one easier/faster, as it will start to flip quicker and
24976     * quicker on mouse button holds.
24977     *
24978     * The calculation for the next flip interval value, starting from
24979     * the one set with this call, is the previous interval divided by
24980     * 1.05, so it decreases a little bit.
24981     *
24982     * The default starting interval value for automatic flips is
24983     * @b 0.85 seconds.
24984     *
24985     * @see elm_flipselector_interval_get()
24986     *
24987     * @ingroup Flipselector
24988     */
24989    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24990
24991    /**
24992     * Get the interval on time updates for an user mouse button hold
24993     * on a flip selector widget.
24994     *
24995     * @param obj The flip selector object
24996     * @return The (first) interval value, in seconds, set on it
24997     *
24998     * @see elm_flipselector_interval_set() for more details
24999     *
25000     * @ingroup Flipselector
25001     */
25002    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25003    /**
25004     * @}
25005     */
25006
25007    /**
25008     * @addtogroup Calendar
25009     * @{
25010     */
25011
25012    /**
25013     * @enum _Elm_Calendar_Mark_Repeat
25014     * @typedef Elm_Calendar_Mark_Repeat
25015     *
25016     * Event periodicity, used to define if a mark should be repeated
25017     * @b beyond event's day. It's set when a mark is added.
25018     *
25019     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25020     * there will be marks every week after this date. Marks will be displayed
25021     * at 13th, 20th, 27th, 3rd June ...
25022     *
25023     * Values don't work as bitmask, only one can be choosen.
25024     *
25025     * @see elm_calendar_mark_add()
25026     *
25027     * @ingroup Calendar
25028     */
25029    typedef enum _Elm_Calendar_Mark_Repeat
25030      {
25031         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25032         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25033         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25034         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*/
25035         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. */
25036      } Elm_Calendar_Mark_Repeat;
25037
25038    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(). */
25039
25040    /**
25041     * Add a new calendar widget to the given parent Elementary
25042     * (container) object.
25043     *
25044     * @param parent The parent object.
25045     * @return a new calendar widget handle or @c NULL, on errors.
25046     *
25047     * This function inserts a new calendar widget on the canvas.
25048     *
25049     * @ref calendar_example_01
25050     *
25051     * @ingroup Calendar
25052     */
25053    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25054
25055    /**
25056     * Get weekdays names displayed by the calendar.
25057     *
25058     * @param obj The calendar object.
25059     * @return Array of seven strings to be used as weekday names.
25060     *
25061     * By default, weekdays abbreviations get from system are displayed:
25062     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25063     * The first string is related to Sunday, the second to Monday...
25064     *
25065     * @see elm_calendar_weekdays_name_set()
25066     *
25067     * @ref calendar_example_05
25068     *
25069     * @ingroup Calendar
25070     */
25071    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25072
25073    /**
25074     * Set weekdays names to be displayed by the calendar.
25075     *
25076     * @param obj The calendar object.
25077     * @param weekdays Array of seven strings to be used as weekday names.
25078     * @warning It must have 7 elements, or it will access invalid memory.
25079     * @warning The strings must be NULL terminated ('@\0').
25080     *
25081     * By default, weekdays abbreviations get from system are displayed:
25082     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25083     *
25084     * The first string should be related to Sunday, the second to Monday...
25085     *
25086     * The usage should be like this:
25087     * @code
25088     *   const char *weekdays[] =
25089     *   {
25090     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25091     *      "Thursday", "Friday", "Saturday"
25092     *   };
25093     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25094     * @endcode
25095     *
25096     * @see elm_calendar_weekdays_name_get()
25097     *
25098     * @ref calendar_example_02
25099     *
25100     * @ingroup Calendar
25101     */
25102    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25103
25104    /**
25105     * Set the minimum and maximum values for the year
25106     *
25107     * @param obj The calendar object
25108     * @param min The minimum year, greater than 1901;
25109     * @param max The maximum year;
25110     *
25111     * Maximum must be greater than minimum, except if you don't wan't to set
25112     * maximum year.
25113     * Default values are 1902 and -1.
25114     *
25115     * If the maximum year is a negative value, it will be limited depending
25116     * on the platform architecture (year 2037 for 32 bits);
25117     *
25118     * @see elm_calendar_min_max_year_get()
25119     *
25120     * @ref calendar_example_03
25121     *
25122     * @ingroup Calendar
25123     */
25124    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25125
25126    /**
25127     * Get the minimum and maximum values for the year
25128     *
25129     * @param obj The calendar object.
25130     * @param min The minimum year.
25131     * @param max The maximum year.
25132     *
25133     * Default values are 1902 and -1.
25134     *
25135     * @see elm_calendar_min_max_year_get() for more details.
25136     *
25137     * @ref calendar_example_05
25138     *
25139     * @ingroup Calendar
25140     */
25141    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25142
25143    /**
25144     * Enable or disable day selection
25145     *
25146     * @param obj The calendar object.
25147     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25148     * disable it.
25149     *
25150     * Enabled by default. If disabled, the user still can select months,
25151     * but not days. Selected days are highlighted on calendar.
25152     * It should be used if you won't need such selection for the widget usage.
25153     *
25154     * When a day is selected, or month is changed, smart callbacks for
25155     * signal "changed" will be called.
25156     *
25157     * @see elm_calendar_day_selection_enable_get()
25158     *
25159     * @ref calendar_example_04
25160     *
25161     * @ingroup Calendar
25162     */
25163    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25164
25165    /**
25166     * Get a value whether day selection is enabled or not.
25167     *
25168     * @see elm_calendar_day_selection_enable_set() for details.
25169     *
25170     * @param obj The calendar object.
25171     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25172     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25173     *
25174     * @ref calendar_example_05
25175     *
25176     * @ingroup Calendar
25177     */
25178    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25179
25180
25181    /**
25182     * Set selected date to be highlighted on calendar.
25183     *
25184     * @param obj The calendar object.
25185     * @param selected_time A @b tm struct to represent the selected date.
25186     *
25187     * Set the selected date, changing the displayed month if needed.
25188     * Selected date changes when the user goes to next/previous month or
25189     * select a day pressing over it on calendar.
25190     *
25191     * @see elm_calendar_selected_time_get()
25192     *
25193     * @ref calendar_example_04
25194     *
25195     * @ingroup Calendar
25196     */
25197    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25198
25199    /**
25200     * Get selected date.
25201     *
25202     * @param obj The calendar object
25203     * @param selected_time A @b tm struct to point to selected date
25204     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25205     * be considered.
25206     *
25207     * Get date selected by the user or set by function
25208     * elm_calendar_selected_time_set().
25209     * Selected date changes when the user goes to next/previous month or
25210     * select a day pressing over it on calendar.
25211     *
25212     * @see elm_calendar_selected_time_get()
25213     *
25214     * @ref calendar_example_05
25215     *
25216     * @ingroup Calendar
25217     */
25218    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25219
25220    /**
25221     * Set a function to format the string that will be used to display
25222     * month and year;
25223     *
25224     * @param obj The calendar object
25225     * @param format_function Function to set the month-year string given
25226     * the selected date
25227     *
25228     * By default it uses strftime with "%B %Y" format string.
25229     * It should allocate the memory that will be used by the string,
25230     * that will be freed by the widget after usage.
25231     * A pointer to the string and a pointer to the time struct will be provided.
25232     *
25233     * Example:
25234     * @code
25235     * static char *
25236     * _format_month_year(struct tm *selected_time)
25237     * {
25238     *    char buf[32];
25239     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25240     *    return strdup(buf);
25241     * }
25242     *
25243     * elm_calendar_format_function_set(calendar, _format_month_year);
25244     * @endcode
25245     *
25246     * @ref calendar_example_02
25247     *
25248     * @ingroup Calendar
25249     */
25250    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25251
25252    /**
25253     * Add a new mark to the calendar
25254     *
25255     * @param obj The calendar object
25256     * @param mark_type A string used to define the type of mark. It will be
25257     * emitted to the theme, that should display a related modification on these
25258     * days representation.
25259     * @param mark_time A time struct to represent the date of inclusion of the
25260     * mark. For marks that repeats it will just be displayed after the inclusion
25261     * date in the calendar.
25262     * @param repeat Repeat the event following this periodicity. Can be a unique
25263     * mark (that don't repeat), daily, weekly, monthly or annually.
25264     * @return The created mark or @p NULL upon failure.
25265     *
25266     * Add a mark that will be drawn in the calendar respecting the insertion
25267     * time and periodicity. It will emit the type as signal to the widget theme.
25268     * Default theme supports "holiday" and "checked", but it can be extended.
25269     *
25270     * It won't immediately update the calendar, drawing the marks.
25271     * For this, call elm_calendar_marks_draw(). However, when user selects
25272     * next or previous month calendar forces marks drawn.
25273     *
25274     * Marks created with this method can be deleted with
25275     * elm_calendar_mark_del().
25276     *
25277     * Example
25278     * @code
25279     * struct tm selected_time;
25280     * time_t current_time;
25281     *
25282     * current_time = time(NULL) + 5 * 84600;
25283     * localtime_r(&current_time, &selected_time);
25284     * elm_calendar_mark_add(cal, "holiday", selected_time,
25285     *     ELM_CALENDAR_ANNUALLY);
25286     *
25287     * current_time = time(NULL) + 1 * 84600;
25288     * localtime_r(&current_time, &selected_time);
25289     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25290     *
25291     * elm_calendar_marks_draw(cal);
25292     * @endcode
25293     *
25294     * @see elm_calendar_marks_draw()
25295     * @see elm_calendar_mark_del()
25296     *
25297     * @ref calendar_example_06
25298     *
25299     * @ingroup Calendar
25300     */
25301    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);
25302
25303    /**
25304     * Delete mark from the calendar.
25305     *
25306     * @param mark The mark to be deleted.
25307     *
25308     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25309     * should be used instead of getting marks list and deleting each one.
25310     *
25311     * @see elm_calendar_mark_add()
25312     *
25313     * @ref calendar_example_06
25314     *
25315     * @ingroup Calendar
25316     */
25317    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25318
25319    /**
25320     * Remove all calendar's marks
25321     *
25322     * @param obj The calendar object.
25323     *
25324     * @see elm_calendar_mark_add()
25325     * @see elm_calendar_mark_del()
25326     *
25327     * @ingroup Calendar
25328     */
25329    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25330
25331
25332    /**
25333     * Get a list of all the calendar marks.
25334     *
25335     * @param obj The calendar object.
25336     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25337     *
25338     * @see elm_calendar_mark_add()
25339     * @see elm_calendar_mark_del()
25340     * @see elm_calendar_marks_clear()
25341     *
25342     * @ingroup Calendar
25343     */
25344    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25345
25346    /**
25347     * Draw calendar marks.
25348     *
25349     * @param obj The calendar object.
25350     *
25351     * Should be used after adding, removing or clearing marks.
25352     * It will go through the entire marks list updating the calendar.
25353     * If lots of marks will be added, add all the marks and then call
25354     * this function.
25355     *
25356     * When the month is changed, i.e. user selects next or previous month,
25357     * marks will be drawed.
25358     *
25359     * @see elm_calendar_mark_add()
25360     * @see elm_calendar_mark_del()
25361     * @see elm_calendar_marks_clear()
25362     *
25363     * @ref calendar_example_06
25364     *
25365     * @ingroup Calendar
25366     */
25367    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25368
25369    /**
25370     * Set a day text color to the same that represents Saturdays.
25371     *
25372     * @param obj The calendar object.
25373     * @param pos The text position. Position is the cell counter, from left
25374     * to right, up to down. It starts on 0 and ends on 41.
25375     *
25376     * @deprecated use elm_calendar_mark_add() instead like:
25377     *
25378     * @code
25379     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25380     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25381     * @endcode
25382     *
25383     * @see elm_calendar_mark_add()
25384     *
25385     * @ingroup Calendar
25386     */
25387    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25388
25389    /**
25390     * Set a day text color to the same that represents Sundays.
25391     *
25392     * @param obj The calendar object.
25393     * @param pos The text position. Position is the cell counter, from left
25394     * to right, up to down. It starts on 0 and ends on 41.
25395
25396     * @deprecated use elm_calendar_mark_add() instead like:
25397     *
25398     * @code
25399     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25400     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25401     * @endcode
25402     *
25403     * @see elm_calendar_mark_add()
25404     *
25405     * @ingroup Calendar
25406     */
25407    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25408
25409    /**
25410     * Set a day text color to the same that represents Weekdays.
25411     *
25412     * @param obj The calendar object
25413     * @param pos The text position. Position is the cell counter, from left
25414     * to right, up to down. It starts on 0 and ends on 41.
25415     *
25416     * @deprecated use elm_calendar_mark_add() instead like:
25417     *
25418     * @code
25419     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25420     *
25421     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25422     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25423     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25424     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25425     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25426     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25427     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25428     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25429     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25430     * @endcode
25431     *
25432     * @see elm_calendar_mark_add()
25433     *
25434     * @ingroup Calendar
25435     */
25436    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25437
25438    /**
25439     * Set the interval on time updates for an user mouse button hold
25440     * on calendar widgets' month selection.
25441     *
25442     * @param obj The calendar object
25443     * @param interval The (first) interval value in seconds
25444     *
25445     * This interval value is @b decreased while the user holds the
25446     * mouse pointer either selecting next or previous month.
25447     *
25448     * This helps the user to get to a given month distant from the
25449     * current one easier/faster, as it will start to change quicker and
25450     * quicker on mouse button holds.
25451     *
25452     * The calculation for the next change interval value, starting from
25453     * the one set with this call, is the previous interval divided by
25454     * 1.05, so it decreases a little bit.
25455     *
25456     * The default starting interval value for automatic changes is
25457     * @b 0.85 seconds.
25458     *
25459     * @see elm_calendar_interval_get()
25460     *
25461     * @ingroup Calendar
25462     */
25463    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25464
25465    /**
25466     * Get the interval on time updates for an user mouse button hold
25467     * on calendar widgets' month selection.
25468     *
25469     * @param obj The calendar object
25470     * @return The (first) interval value, in seconds, set on it
25471     *
25472     * @see elm_calendar_interval_set() for more details
25473     *
25474     * @ingroup Calendar
25475     */
25476    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25477
25478    /**
25479     * @}
25480     */
25481
25482    /**
25483     * @defgroup Diskselector Diskselector
25484     * @ingroup Elementary
25485     *
25486     * @image html img/widget/diskselector/preview-00.png
25487     * @image latex img/widget/diskselector/preview-00.eps
25488     *
25489     * A diskselector is a kind of list widget. It scrolls horizontally,
25490     * and can contain label and icon objects. Three items are displayed
25491     * with the selected one in the middle.
25492     *
25493     * It can act like a circular list with round mode and labels can be
25494     * reduced for a defined length for side items.
25495     *
25496     * Smart callbacks one can listen to:
25497     * - "selected" - when item is selected, i.e. scroller stops.
25498     *
25499     * Available styles for it:
25500     * - @c "default"
25501     *
25502     * List of examples:
25503     * @li @ref diskselector_example_01
25504     * @li @ref diskselector_example_02
25505     */
25506
25507    /**
25508     * @addtogroup Diskselector
25509     * @{
25510     */
25511
25512    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(). */
25513
25514    /**
25515     * Add a new diskselector widget to the given parent Elementary
25516     * (container) object.
25517     *
25518     * @param parent The parent object.
25519     * @return a new diskselector widget handle or @c NULL, on errors.
25520     *
25521     * This function inserts a new diskselector widget on the canvas.
25522     *
25523     * @ingroup Diskselector
25524     */
25525    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25526
25527    /**
25528     * Enable or disable round mode.
25529     *
25530     * @param obj The diskselector object.
25531     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25532     * disable it.
25533     *
25534     * Disabled by default. If round mode is enabled the items list will
25535     * work like a circle list, so when the user reaches the last item,
25536     * the first one will popup.
25537     *
25538     * @see elm_diskselector_round_get()
25539     *
25540     * @ingroup Diskselector
25541     */
25542    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25543
25544    /**
25545     * Get a value whether round mode is enabled or not.
25546     *
25547     * @see elm_diskselector_round_set() for details.
25548     *
25549     * @param obj The diskselector object.
25550     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25551     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25552     *
25553     * @ingroup Diskselector
25554     */
25555    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25556
25557    /**
25558     * Get the side labels max length.
25559     *
25560     * @deprecated use elm_diskselector_side_label_length_get() instead:
25561     *
25562     * @param obj The diskselector object.
25563     * @return The max length defined for side labels, or 0 if not a valid
25564     * diskselector.
25565     *
25566     * @ingroup Diskselector
25567     */
25568    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25569
25570    /**
25571     * Set the side labels max length.
25572     *
25573     * @deprecated use elm_diskselector_side_label_length_set() instead:
25574     *
25575     * @param obj The diskselector object.
25576     * @param len The max length defined for side labels.
25577     *
25578     * @ingroup Diskselector
25579     */
25580    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25581
25582    /**
25583     * Get the side labels max length.
25584     *
25585     * @see elm_diskselector_side_label_length_set() for details.
25586     *
25587     * @param obj The diskselector object.
25588     * @return The max length defined for side labels, or 0 if not a valid
25589     * diskselector.
25590     *
25591     * @ingroup Diskselector
25592     */
25593    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25594
25595    /**
25596     * Set the side labels max length.
25597     *
25598     * @param obj The diskselector object.
25599     * @param len The max length defined for side labels.
25600     *
25601     * Length is the number of characters of items' label that will be
25602     * visible when it's set on side positions. It will just crop
25603     * the string after defined size. E.g.:
25604     *
25605     * An item with label "January" would be displayed on side position as
25606     * "Jan" if max length is set to 3, or "Janu", if this property
25607     * is set to 4.
25608     *
25609     * When it's selected, the entire label will be displayed, except for
25610     * width restrictions. In this case label will be cropped and "..."
25611     * will be concatenated.
25612     *
25613     * Default side label max length is 3.
25614     *
25615     * This property will be applyed over all items, included before or
25616     * later this function call.
25617     *
25618     * @ingroup Diskselector
25619     */
25620    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25621
25622    /**
25623     * Set the number of items to be displayed.
25624     *
25625     * @param obj The diskselector object.
25626     * @param num The number of items the diskselector will display.
25627     *
25628     * Default value is 3, and also it's the minimun. If @p num is less
25629     * than 3, it will be set to 3.
25630     *
25631     * Also, it can be set on theme, using data item @c display_item_num
25632     * on group "elm/diskselector/item/X", where X is style set.
25633     * E.g.:
25634     *
25635     * group { name: "elm/diskselector/item/X";
25636     * data {
25637     *     item: "display_item_num" "5";
25638     *     }
25639     *
25640     * @ingroup Diskselector
25641     */
25642    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25643
25644    /**
25645     * Get the number of items in the diskselector object.
25646     *
25647     * @param obj The diskselector object.
25648     *
25649     * @ingroup Diskselector
25650     */
25651    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25652
25653    /**
25654     * Set bouncing behaviour when the scrolled content reaches an edge.
25655     *
25656     * Tell the internal scroller object whether it should bounce or not
25657     * when it reaches the respective edges for each axis.
25658     *
25659     * @param obj The diskselector object.
25660     * @param h_bounce Whether to bounce or not in the horizontal axis.
25661     * @param v_bounce Whether to bounce or not in the vertical axis.
25662     *
25663     * @see elm_scroller_bounce_set()
25664     *
25665     * @ingroup Diskselector
25666     */
25667    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25668
25669    /**
25670     * Get the bouncing behaviour of the internal scroller.
25671     *
25672     * Get whether the internal scroller should bounce when the edge of each
25673     * axis is reached scrolling.
25674     *
25675     * @param obj The diskselector object.
25676     * @param h_bounce Pointer where to store the bounce state of the horizontal
25677     * axis.
25678     * @param v_bounce Pointer where to store the bounce state of the vertical
25679     * axis.
25680     *
25681     * @see elm_scroller_bounce_get()
25682     * @see elm_diskselector_bounce_set()
25683     *
25684     * @ingroup Diskselector
25685     */
25686    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25687
25688    /**
25689     * Get the scrollbar policy.
25690     *
25691     * @see elm_diskselector_scroller_policy_get() for details.
25692     *
25693     * @param obj The diskselector object.
25694     * @param policy_h Pointer where to store horizontal scrollbar policy.
25695     * @param policy_v Pointer where to store vertical scrollbar policy.
25696     *
25697     * @ingroup Diskselector
25698     */
25699    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);
25700
25701    /**
25702     * Set the scrollbar policy.
25703     *
25704     * @param obj The diskselector object.
25705     * @param policy_h Horizontal scrollbar policy.
25706     * @param policy_v Vertical scrollbar policy.
25707     *
25708     * This sets the scrollbar visibility policy for the given scroller.
25709     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25710     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25711     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25712     * This applies respectively for the horizontal and vertical scrollbars.
25713     *
25714     * The both are disabled by default, i.e., are set to
25715     * #ELM_SCROLLER_POLICY_OFF.
25716     *
25717     * @ingroup Diskselector
25718     */
25719    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25720
25721    /**
25722     * Remove all diskselector's items.
25723     *
25724     * @param obj The diskselector object.
25725     *
25726     * @see elm_diskselector_item_del()
25727     * @see elm_diskselector_item_append()
25728     *
25729     * @ingroup Diskselector
25730     */
25731    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25732
25733    /**
25734     * Get a list of all the diskselector items.
25735     *
25736     * @param obj The diskselector object.
25737     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25738     * or @c NULL on failure.
25739     *
25740     * @see elm_diskselector_item_append()
25741     * @see elm_diskselector_item_del()
25742     * @see elm_diskselector_clear()
25743     *
25744     * @ingroup Diskselector
25745     */
25746    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25747
25748    /**
25749     * Appends a new item to the diskselector object.
25750     *
25751     * @param obj The diskselector object.
25752     * @param label The label of the diskselector item.
25753     * @param icon The icon object to use at left side of the item. An
25754     * icon can be any Evas object, but usually it is an icon created
25755     * with elm_icon_add().
25756     * @param func The function to call when the item is selected.
25757     * @param data The data to associate with the item for related callbacks.
25758     *
25759     * @return The created item or @c NULL upon failure.
25760     *
25761     * A new item will be created and appended to the diskselector, i.e., will
25762     * be set as last item. Also, if there is no selected item, it will
25763     * be selected. This will always happens for the first appended item.
25764     *
25765     * If no icon is set, label will be centered on item position, otherwise
25766     * the icon will be placed at left of the label, that will be shifted
25767     * to the right.
25768     *
25769     * Items created with this method can be deleted with
25770     * elm_diskselector_item_del().
25771     *
25772     * Associated @p data can be properly freed when item is deleted if a
25773     * callback function is set with elm_diskselector_item_del_cb_set().
25774     *
25775     * If a function is passed as argument, it will be called everytime this item
25776     * is selected, i.e., the user stops the diskselector with this
25777     * item on center position. If such function isn't needed, just passing
25778     * @c NULL as @p func is enough. The same should be done for @p data.
25779     *
25780     * Simple example (with no function callback or data associated):
25781     * @code
25782     * disk = elm_diskselector_add(win);
25783     * ic = elm_icon_add(win);
25784     * elm_icon_file_set(ic, "path/to/image", NULL);
25785     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25786     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25787     * @endcode
25788     *
25789     * @see elm_diskselector_item_del()
25790     * @see elm_diskselector_item_del_cb_set()
25791     * @see elm_diskselector_clear()
25792     * @see elm_icon_add()
25793     *
25794     * @ingroup Diskselector
25795     */
25796    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);
25797
25798
25799    /**
25800     * Delete them item from the diskselector.
25801     *
25802     * @param it The item of diskselector to be deleted.
25803     *
25804     * If deleting all diskselector items is required, elm_diskselector_clear()
25805     * should be used instead of getting items list and deleting each one.
25806     *
25807     * @see elm_diskselector_clear()
25808     * @see elm_diskselector_item_append()
25809     * @see elm_diskselector_item_del_cb_set()
25810     *
25811     * @ingroup Diskselector
25812     */
25813    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25814
25815    /**
25816     * Set the function called when a diskselector item is freed.
25817     *
25818     * @param it The item to set the callback on
25819     * @param func The function called
25820     *
25821     * If there is a @p func, then it will be called prior item's memory release.
25822     * That will be called with the following arguments:
25823     * @li item's data;
25824     * @li item's Evas object;
25825     * @li item itself;
25826     *
25827     * This way, a data associated to a diskselector item could be properly
25828     * freed.
25829     *
25830     * @ingroup Diskselector
25831     */
25832    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25833
25834    /**
25835     * Get the data associated to the item.
25836     *
25837     * @param it The diskselector item
25838     * @return The data associated to @p it
25839     *
25840     * The return value is a pointer to data associated to @p item when it was
25841     * created, with function elm_diskselector_item_append(). If no data
25842     * was passed as argument, it will return @c NULL.
25843     *
25844     * @see elm_diskselector_item_append()
25845     *
25846     * @ingroup Diskselector
25847     */
25848    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25849
25850    /**
25851     * Set the icon associated to the item.
25852     *
25853     * @param it The diskselector item
25854     * @param icon The icon object to associate with @p it
25855     *
25856     * The icon object to use at left side of the item. An
25857     * icon can be any Evas object, but usually it is an icon created
25858     * with elm_icon_add().
25859     *
25860     * Once the icon object is set, a previously set one will be deleted.
25861     * @warning Setting the same icon for two items will cause the icon to
25862     * dissapear from the first item.
25863     *
25864     * If an icon was passed as argument on item creation, with function
25865     * elm_diskselector_item_append(), it will be already
25866     * associated to the item.
25867     *
25868     * @see elm_diskselector_item_append()
25869     * @see elm_diskselector_item_icon_get()
25870     *
25871     * @ingroup Diskselector
25872     */
25873    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25874
25875    /**
25876     * Get the icon associated to the item.
25877     *
25878     * @param it The diskselector item
25879     * @return The icon associated to @p it
25880     *
25881     * The return value is a pointer to the icon associated to @p item when it was
25882     * created, with function elm_diskselector_item_append(), or later
25883     * with function elm_diskselector_item_icon_set. If no icon
25884     * was passed as argument, it will return @c NULL.
25885     *
25886     * @see elm_diskselector_item_append()
25887     * @see elm_diskselector_item_icon_set()
25888     *
25889     * @ingroup Diskselector
25890     */
25891    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25892
25893    /**
25894     * Set the label of item.
25895     *
25896     * @param it The item of diskselector.
25897     * @param label The label of item.
25898     *
25899     * The label to be displayed by the item.
25900     *
25901     * If no icon is set, label will be centered on item position, otherwise
25902     * the icon will be placed at left of the label, that will be shifted
25903     * to the right.
25904     *
25905     * An item with label "January" would be displayed on side position as
25906     * "Jan" if max length is set to 3 with function
25907     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25908     * is set to 4.
25909     *
25910     * When this @p item is selected, the entire label will be displayed,
25911     * except for width restrictions.
25912     * In this case label will be cropped and "..." will be concatenated,
25913     * but only for display purposes. It will keep the entire string, so
25914     * if diskselector is resized the remaining characters will be displayed.
25915     *
25916     * If a label was passed as argument on item creation, with function
25917     * elm_diskselector_item_append(), it will be already
25918     * displayed by the item.
25919     *
25920     * @see elm_diskselector_side_label_lenght_set()
25921     * @see elm_diskselector_item_label_get()
25922     * @see elm_diskselector_item_append()
25923     *
25924     * @ingroup Diskselector
25925     */
25926    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25927
25928    /**
25929     * Get the label of item.
25930     *
25931     * @param it The item of diskselector.
25932     * @return The label of item.
25933     *
25934     * The return value is a pointer to the label associated to @p item when it was
25935     * created, with function elm_diskselector_item_append(), or later
25936     * with function elm_diskselector_item_label_set. If no label
25937     * was passed as argument, it will return @c NULL.
25938     *
25939     * @see elm_diskselector_item_label_set() for more details.
25940     * @see elm_diskselector_item_append()
25941     *
25942     * @ingroup Diskselector
25943     */
25944    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25945
25946    /**
25947     * Get the selected item.
25948     *
25949     * @param obj The diskselector object.
25950     * @return The selected diskselector item.
25951     *
25952     * The selected item can be unselected with function
25953     * elm_diskselector_item_selected_set(), and the first item of
25954     * diskselector will be selected.
25955     *
25956     * The selected item always will be centered on diskselector, with
25957     * full label displayed, i.e., max lenght set to side labels won't
25958     * apply on the selected item. More details on
25959     * elm_diskselector_side_label_length_set().
25960     *
25961     * @ingroup Diskselector
25962     */
25963    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25964
25965    /**
25966     * Set the selected state of an item.
25967     *
25968     * @param it The diskselector item
25969     * @param selected The selected state
25970     *
25971     * This sets the selected state of the given item @p it.
25972     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25973     *
25974     * If a new item is selected the previosly selected will be unselected.
25975     * Previoulsy selected item can be get with function
25976     * elm_diskselector_selected_item_get().
25977     *
25978     * If the item @p it is unselected, the first item of diskselector will
25979     * be selected.
25980     *
25981     * Selected items will be visible on center position of diskselector.
25982     * So if it was on another position before selected, or was invisible,
25983     * diskselector will animate items until the selected item reaches center
25984     * position.
25985     *
25986     * @see elm_diskselector_item_selected_get()
25987     * @see elm_diskselector_selected_item_get()
25988     *
25989     * @ingroup Diskselector
25990     */
25991    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25992
25993    /*
25994     * Get whether the @p item is selected or not.
25995     *
25996     * @param it The diskselector item.
25997     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25998     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25999     *
26000     * @see elm_diskselector_selected_item_set() for details.
26001     * @see elm_diskselector_item_selected_get()
26002     *
26003     * @ingroup Diskselector
26004     */
26005    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26006
26007    /**
26008     * Get the first item of the diskselector.
26009     *
26010     * @param obj The diskselector object.
26011     * @return The first item, or @c NULL if none.
26012     *
26013     * The list of items follows append order. So it will return the first
26014     * item appended to the widget that wasn't deleted.
26015     *
26016     * @see elm_diskselector_item_append()
26017     * @see elm_diskselector_items_get()
26018     *
26019     * @ingroup Diskselector
26020     */
26021    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26022
26023    /**
26024     * Get the last item of the diskselector.
26025     *
26026     * @param obj The diskselector object.
26027     * @return The last item, or @c NULL if none.
26028     *
26029     * The list of items follows append order. So it will return last first
26030     * item appended to the widget that wasn't deleted.
26031     *
26032     * @see elm_diskselector_item_append()
26033     * @see elm_diskselector_items_get()
26034     *
26035     * @ingroup Diskselector
26036     */
26037    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26038
26039    /**
26040     * Get the item before @p item in diskselector.
26041     *
26042     * @param it The diskselector item.
26043     * @return The item before @p item, or @c NULL if none or on failure.
26044     *
26045     * The list of items follows append order. So it will return item appended
26046     * just before @p item and that wasn't deleted.
26047     *
26048     * If it is the first item, @c NULL will be returned.
26049     * First item can be get by elm_diskselector_first_item_get().
26050     *
26051     * @see elm_diskselector_item_append()
26052     * @see elm_diskselector_items_get()
26053     *
26054     * @ingroup Diskselector
26055     */
26056    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26057
26058    /**
26059     * Get the item after @p item in diskselector.
26060     *
26061     * @param it The diskselector item.
26062     * @return The item after @p item, or @c NULL if none or on failure.
26063     *
26064     * The list of items follows append order. So it will return item appended
26065     * just after @p item and that wasn't deleted.
26066     *
26067     * If it is the last item, @c NULL will be returned.
26068     * Last item can be get by elm_diskselector_last_item_get().
26069     *
26070     * @see elm_diskselector_item_append()
26071     * @see elm_diskselector_items_get()
26072     *
26073     * @ingroup Diskselector
26074     */
26075    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26076
26077    /**
26078     * Set the text to be shown in the diskselector item.
26079     *
26080     * @param item Target item
26081     * @param text The text to set in the content
26082     *
26083     * Setup the text as tooltip to object. The item can have only one tooltip,
26084     * so any previous tooltip data is removed.
26085     *
26086     * @see elm_object_tooltip_text_set() for more details.
26087     *
26088     * @ingroup Diskselector
26089     */
26090    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26091
26092    /**
26093     * Set the content to be shown in the tooltip item.
26094     *
26095     * Setup the tooltip to item. The item can have only one tooltip,
26096     * so any previous tooltip data is removed. @p func(with @p data) will
26097     * be called every time that need show the tooltip and it should
26098     * return a valid Evas_Object. This object is then managed fully by
26099     * tooltip system and is deleted when the tooltip is gone.
26100     *
26101     * @param item the diskselector item being attached a tooltip.
26102     * @param func the function used to create the tooltip contents.
26103     * @param data what to provide to @a func as callback data/context.
26104     * @param del_cb called when data is not needed anymore, either when
26105     *        another callback replaces @p func, the tooltip is unset with
26106     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26107     *        dies. This callback receives as the first parameter the
26108     *        given @a data, and @c event_info is the item.
26109     *
26110     * @see elm_object_tooltip_content_cb_set() for more details.
26111     *
26112     * @ingroup Diskselector
26113     */
26114    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);
26115
26116    /**
26117     * Unset tooltip from item.
26118     *
26119     * @param item diskselector item to remove previously set tooltip.
26120     *
26121     * Remove tooltip from item. The callback provided as del_cb to
26122     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26123     * it is not used anymore.
26124     *
26125     * @see elm_object_tooltip_unset() for more details.
26126     * @see elm_diskselector_item_tooltip_content_cb_set()
26127     *
26128     * @ingroup Diskselector
26129     */
26130    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26131
26132
26133    /**
26134     * Sets a different style for this item tooltip.
26135     *
26136     * @note before you set a style you should define a tooltip with
26137     *       elm_diskselector_item_tooltip_content_cb_set() or
26138     *       elm_diskselector_item_tooltip_text_set()
26139     *
26140     * @param item diskselector item with tooltip already set.
26141     * @param style the theme style to use (default, transparent, ...)
26142     *
26143     * @see elm_object_tooltip_style_set() for more details.
26144     *
26145     * @ingroup Diskselector
26146     */
26147    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26148
26149    /**
26150     * Get the style for this item tooltip.
26151     *
26152     * @param item diskselector item with tooltip already set.
26153     * @return style the theme style in use, defaults to "default". If the
26154     *         object does not have a tooltip set, then NULL is returned.
26155     *
26156     * @see elm_object_tooltip_style_get() for more details.
26157     * @see elm_diskselector_item_tooltip_style_set()
26158     *
26159     * @ingroup Diskselector
26160     */
26161    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26162
26163    /**
26164     * Set the cursor to be shown when mouse is over the diskselector item
26165     *
26166     * @param item Target item
26167     * @param cursor the cursor name to be used.
26168     *
26169     * @see elm_object_cursor_set() for more details.
26170     *
26171     * @ingroup Diskselector
26172     */
26173    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26174
26175    /**
26176     * Get the cursor to be shown when mouse is over the diskselector item
26177     *
26178     * @param item diskselector item with cursor already set.
26179     * @return the cursor name.
26180     *
26181     * @see elm_object_cursor_get() for more details.
26182     * @see elm_diskselector_cursor_set()
26183     *
26184     * @ingroup Diskselector
26185     */
26186    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26187
26188
26189    /**
26190     * Unset the cursor to be shown when mouse is over the diskselector item
26191     *
26192     * @param item Target item
26193     *
26194     * @see elm_object_cursor_unset() for more details.
26195     * @see elm_diskselector_cursor_set()
26196     *
26197     * @ingroup Diskselector
26198     */
26199    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26200
26201    /**
26202     * Sets a different style for this item cursor.
26203     *
26204     * @note before you set a style you should define a cursor with
26205     *       elm_diskselector_item_cursor_set()
26206     *
26207     * @param item diskselector item with cursor already set.
26208     * @param style the theme style to use (default, transparent, ...)
26209     *
26210     * @see elm_object_cursor_style_set() for more details.
26211     *
26212     * @ingroup Diskselector
26213     */
26214    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26215
26216
26217    /**
26218     * Get the style for this item cursor.
26219     *
26220     * @param item diskselector item with cursor already set.
26221     * @return style the theme style in use, defaults to "default". If the
26222     *         object does not have a cursor set, then @c NULL is returned.
26223     *
26224     * @see elm_object_cursor_style_get() for more details.
26225     * @see elm_diskselector_item_cursor_style_set()
26226     *
26227     * @ingroup Diskselector
26228     */
26229    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26230
26231
26232    /**
26233     * Set if the cursor set should be searched on the theme or should use
26234     * the provided by the engine, only.
26235     *
26236     * @note before you set if should look on theme you should define a cursor
26237     * with elm_diskselector_item_cursor_set().
26238     * By default it will only look for cursors provided by the engine.
26239     *
26240     * @param item widget item with cursor already set.
26241     * @param engine_only boolean to define if cursors set with
26242     * elm_diskselector_item_cursor_set() should be searched only
26243     * between cursors provided by the engine or searched on widget's
26244     * theme as well.
26245     *
26246     * @see elm_object_cursor_engine_only_set() for more details.
26247     *
26248     * @ingroup Diskselector
26249     */
26250    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26251
26252    /**
26253     * Get the cursor engine only usage for this item cursor.
26254     *
26255     * @param item widget item with cursor already set.
26256     * @return engine_only boolean to define it cursors should be looked only
26257     * between the provided by the engine or searched on widget's theme as well.
26258     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26259     *
26260     * @see elm_object_cursor_engine_only_get() for more details.
26261     * @see elm_diskselector_item_cursor_engine_only_set()
26262     *
26263     * @ingroup Diskselector
26264     */
26265    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26266
26267    /**
26268     * @}
26269     */
26270
26271    /**
26272     * @defgroup Colorselector Colorselector
26273     *
26274     * @{
26275     *
26276     * @image html img/widget/colorselector/preview-00.png
26277     * @image latex img/widget/colorselector/preview-00.eps
26278     *
26279     * @brief Widget for user to select a color.
26280     *
26281     * Signals that you can add callbacks for are:
26282     * "changed" - When the color value changes(event_info is NULL).
26283     *
26284     * See @ref tutorial_colorselector.
26285     */
26286    /**
26287     * @brief Add a new colorselector to the parent
26288     *
26289     * @param parent The parent object
26290     * @return The new object or NULL if it cannot be created
26291     *
26292     * @ingroup Colorselector
26293     */
26294    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26295    /**
26296     * Set a color for the colorselector
26297     *
26298     * @param obj   Colorselector object
26299     * @param r     r-value of color
26300     * @param g     g-value of color
26301     * @param b     b-value of color
26302     * @param a     a-value of color
26303     *
26304     * @ingroup Colorselector
26305     */
26306    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26307    /**
26308     * Get a color from the colorselector
26309     *
26310     * @param obj   Colorselector object
26311     * @param r     integer pointer for r-value of color
26312     * @param g     integer pointer for g-value of color
26313     * @param b     integer pointer for b-value of color
26314     * @param a     integer pointer for a-value of color
26315     *
26316     * @ingroup Colorselector
26317     */
26318    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26319    /**
26320     * @}
26321     */
26322
26323    /**
26324     * @defgroup Ctxpopup Ctxpopup
26325     *
26326     * @image html img/widget/ctxpopup/preview-00.png
26327     * @image latex img/widget/ctxpopup/preview-00.eps
26328     *
26329     * @brief Context popup widet.
26330     *
26331     * A ctxpopup is a widget that, when shown, pops up a list of items.
26332     * It automatically chooses an area inside its parent object's view
26333     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26334     * optimally fit into it. In the default theme, it will also point an
26335     * arrow to it's top left position at the time one shows it. Ctxpopup
26336     * items have a label and/or an icon. It is intended for a small
26337     * number of items (hence the use of list, not genlist).
26338     *
26339     * @note Ctxpopup is a especialization of @ref Hover.
26340     *
26341     * Signals that you can add callbacks for are:
26342     * "dismissed" - the ctxpopup was dismissed
26343     *
26344     * Default contents parts of the ctxpopup widget that you can use for are:
26345     * @li "elm.swallow.content" - A content of the ctxpopup
26346     *
26347     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26348     * @{
26349     */
26350    typedef enum _Elm_Ctxpopup_Direction
26351      {
26352         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26353                                           area */
26354         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26355                                            the clicked area */
26356         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26357                                           the clicked area */
26358         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26359                                         area */
26360         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26361      } Elm_Ctxpopup_Direction;
26362
26363    /**
26364     * @brief Add a new Ctxpopup object to the parent.
26365     *
26366     * @param parent Parent object
26367     * @return New object or @c NULL, if it cannot be created
26368     */
26369    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26370    /**
26371     * @brief Set the Ctxpopup's parent
26372     *
26373     * @param obj The ctxpopup object
26374     * @param area The parent to use
26375     *
26376     * Set the parent object.
26377     *
26378     * @note elm_ctxpopup_add() will automatically call this function
26379     * with its @c parent argument.
26380     *
26381     * @see elm_ctxpopup_add()
26382     * @see elm_hover_parent_set()
26383     */
26384    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26385    /**
26386     * @brief Get the Ctxpopup's parent
26387     *
26388     * @param obj The ctxpopup object
26389     *
26390     * @see elm_ctxpopup_hover_parent_set() for more information
26391     */
26392    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26393    /**
26394     * @brief Clear all items in the given ctxpopup object.
26395     *
26396     * @param obj Ctxpopup object
26397     */
26398    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26399    /**
26400     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26401     *
26402     * @param obj Ctxpopup object
26403     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26404     */
26405    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26406    /**
26407     * @brief Get the value of current ctxpopup object's orientation.
26408     *
26409     * @param obj Ctxpopup object
26410     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26411     *
26412     * @see elm_ctxpopup_horizontal_set()
26413     */
26414    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26415    /**
26416     * @brief Add a new item to a ctxpopup object.
26417     *
26418     * @param obj Ctxpopup object
26419     * @param icon Icon to be set on new item
26420     * @param label The Label of the new item
26421     * @param func Convenience function called when item selected
26422     * @param data Data passed to @p func
26423     * @return A handle to the item added or @c NULL, on errors
26424     *
26425     * @warning Ctxpopup can't hold both an item list and a content at the same
26426     * time. When an item is added, any previous content will be removed.
26427     *
26428     * @see elm_ctxpopup_content_set()
26429     */
26430    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);
26431    /**
26432     * @brief Delete the given item in a ctxpopup object.
26433     *
26434     * @param it Ctxpopup item to be deleted
26435     *
26436     * @see elm_ctxpopup_item_append()
26437     */
26438    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26439    /**
26440     * @brief Set the ctxpopup item's state as disabled or enabled.
26441     *
26442     * @param it Ctxpopup item to be enabled/disabled
26443     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26444     *
26445     * When disabled the item is greyed out to indicate it's state.
26446     */
26447    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26448    /**
26449     * @brief Get the ctxpopup item's disabled/enabled state.
26450     *
26451     * @param it Ctxpopup item to be enabled/disabled
26452     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26453     *
26454     * @see elm_ctxpopup_item_disabled_set()
26455     */
26456    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26457    /**
26458     * @brief Get the icon object for the given ctxpopup item.
26459     *
26460     * @param it Ctxpopup item
26461     * @return icon object or @c NULL, if the item does not have icon or an error
26462     * occurred
26463     *
26464     * @see elm_ctxpopup_item_append()
26465     * @see elm_ctxpopup_item_icon_set()
26466     */
26467    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26468    /**
26469     * @brief Sets the side icon associated with the ctxpopup item
26470     *
26471     * @param it Ctxpopup item
26472     * @param icon Icon object to be set
26473     *
26474     * Once the icon object is set, a previously set one will be deleted.
26475     * @warning Setting the same icon for two items will cause the icon to
26476     * dissapear from the first item.
26477     *
26478     * @see elm_ctxpopup_item_append()
26479     */
26480    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26481    /**
26482     * @brief Get the label for the given ctxpopup item.
26483     *
26484     * @param it Ctxpopup item
26485     * @return label string or @c NULL, if the item does not have label or an
26486     * error occured
26487     *
26488     * @see elm_ctxpopup_item_append()
26489     * @see elm_ctxpopup_item_label_set()
26490     */
26491    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26492    /**
26493     * @brief (Re)set the label on the given ctxpopup item.
26494     *
26495     * @param it Ctxpopup item
26496     * @param label String to set as label
26497     */
26498    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26499    /**
26500     * @brief Set an elm widget as the content of the ctxpopup.
26501     *
26502     * @param obj Ctxpopup object
26503     * @param content Content to be swallowed
26504     *
26505     * If the content object is already set, a previous one will bedeleted. If
26506     * you want to keep that old content object, use the
26507     * elm_ctxpopup_content_unset() function.
26508     *
26509     * @deprecated use elm_object_content_set()
26510     *
26511     * @warning Ctxpopup can't hold both a item list and a content at the same
26512     * time. When a content is set, any previous items will be removed.
26513     */
26514    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26515    /**
26516     * @brief Unset the ctxpopup content
26517     *
26518     * @param obj Ctxpopup object
26519     * @return The content that was being used
26520     *
26521     * Unparent and return the content object which was set for this widget.
26522     *
26523     * @deprecated use elm_object_content_unset()
26524     *
26525     * @see elm_ctxpopup_content_set()
26526     */
26527    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26528    /**
26529     * @brief Set the direction priority of a ctxpopup.
26530     *
26531     * @param obj Ctxpopup object
26532     * @param first 1st priority of direction
26533     * @param second 2nd priority of direction
26534     * @param third 3th priority of direction
26535     * @param fourth 4th priority of direction
26536     *
26537     * This functions gives a chance to user to set the priority of ctxpopup
26538     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26539     * requested direction.
26540     *
26541     * @see Elm_Ctxpopup_Direction
26542     */
26543    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);
26544    /**
26545     * @brief Get the direction priority of a ctxpopup.
26546     *
26547     * @param obj Ctxpopup object
26548     * @param first 1st priority of direction to be returned
26549     * @param second 2nd priority of direction to be returned
26550     * @param third 3th priority of direction to be returned
26551     * @param fourth 4th priority of direction to be returned
26552     *
26553     * @see elm_ctxpopup_direction_priority_set() for more information.
26554     */
26555    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);
26556
26557    /**
26558     * @brief Get the current direction of a ctxpopup.
26559     *
26560     * @param obj Ctxpopup object
26561     * @return current direction of a ctxpopup
26562     *
26563     * @warning Once the ctxpopup showed up, the direction would be determined
26564     */
26565    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26566
26567    /**
26568     * @}
26569     */
26570
26571    /* transit */
26572    /**
26573     *
26574     * @defgroup Transit Transit
26575     * @ingroup Elementary
26576     *
26577     * Transit is designed to apply various animated transition effects to @c
26578     * Evas_Object, such like translation, rotation, etc. For using these
26579     * effects, create an @ref Elm_Transit and add the desired transition effects.
26580     *
26581     * Once the effects are added into transit, they will be automatically
26582     * managed (their callback will be called until the duration is ended, and
26583     * they will be deleted on completion).
26584     *
26585     * Example:
26586     * @code
26587     * Elm_Transit *trans = elm_transit_add();
26588     * elm_transit_object_add(trans, obj);
26589     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26590     * elm_transit_duration_set(transit, 1);
26591     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26592     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26593     * elm_transit_repeat_times_set(transit, 3);
26594     * @endcode
26595     *
26596     * Some transition effects are used to change the properties of objects. They
26597     * are:
26598     * @li @ref elm_transit_effect_translation_add
26599     * @li @ref elm_transit_effect_color_add
26600     * @li @ref elm_transit_effect_rotation_add
26601     * @li @ref elm_transit_effect_wipe_add
26602     * @li @ref elm_transit_effect_zoom_add
26603     * @li @ref elm_transit_effect_resizing_add
26604     *
26605     * Other transition effects are used to make one object disappear and another
26606     * object appear on its old place. These effects are:
26607     *
26608     * @li @ref elm_transit_effect_flip_add
26609     * @li @ref elm_transit_effect_resizable_flip_add
26610     * @li @ref elm_transit_effect_fade_add
26611     * @li @ref elm_transit_effect_blend_add
26612     *
26613     * It's also possible to make a transition chain with @ref
26614     * elm_transit_chain_transit_add.
26615     *
26616     * @warning We strongly recommend to use elm_transit just when edje can not do
26617     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26618     * animations can be manipulated inside the theme.
26619     *
26620     * List of examples:
26621     * @li @ref transit_example_01_explained
26622     * @li @ref transit_example_02_explained
26623     * @li @ref transit_example_03_c
26624     * @li @ref transit_example_04_c
26625     *
26626     * @{
26627     */
26628
26629    /**
26630     * @enum Elm_Transit_Tween_Mode
26631     *
26632     * The type of acceleration used in the transition.
26633     */
26634    typedef enum
26635      {
26636         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26637         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26638                                              over time, then decrease again
26639                                              and stop slowly */
26640         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26641                                              speed over time */
26642         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26643                                             over time */
26644      } Elm_Transit_Tween_Mode;
26645
26646    /**
26647     * @enum Elm_Transit_Effect_Flip_Axis
26648     *
26649     * The axis where flip effect should be applied.
26650     */
26651    typedef enum
26652      {
26653         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26654         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26655      } Elm_Transit_Effect_Flip_Axis;
26656    /**
26657     * @enum Elm_Transit_Effect_Wipe_Dir
26658     *
26659     * The direction where the wipe effect should occur.
26660     */
26661    typedef enum
26662      {
26663         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26664         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26665         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26666         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26667      } Elm_Transit_Effect_Wipe_Dir;
26668    /** @enum Elm_Transit_Effect_Wipe_Type
26669     *
26670     * Whether the wipe effect should show or hide the object.
26671     */
26672    typedef enum
26673      {
26674         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26675                                              animation */
26676         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26677                                             animation */
26678      } Elm_Transit_Effect_Wipe_Type;
26679
26680    /**
26681     * @typedef Elm_Transit
26682     *
26683     * The Transit created with elm_transit_add(). This type has the information
26684     * about the objects which the transition will be applied, and the
26685     * transition effects that will be used. It also contains info about
26686     * duration, number of repetitions, auto-reverse, etc.
26687     */
26688    typedef struct _Elm_Transit Elm_Transit;
26689    typedef void Elm_Transit_Effect;
26690    /**
26691     * @typedef Elm_Transit_Effect_Transition_Cb
26692     *
26693     * Transition callback called for this effect on each transition iteration.
26694     */
26695    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26696    /**
26697     * Elm_Transit_Effect_End_Cb
26698     *
26699     * Transition callback called for this effect when the transition is over.
26700     */
26701    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26702
26703    /**
26704     * Elm_Transit_Del_Cb
26705     *
26706     * A callback called when the transit is deleted.
26707     */
26708    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26709
26710    /**
26711     * Add new transit.
26712     *
26713     * @note Is not necessary to delete the transit object, it will be deleted at
26714     * the end of its operation.
26715     * @note The transit will start playing when the program enter in the main loop, is not
26716     * necessary to give a start to the transit.
26717     *
26718     * @return The transit object.
26719     *
26720     * @ingroup Transit
26721     */
26722    EAPI Elm_Transit                *elm_transit_add(void);
26723
26724    /**
26725     * Stops the animation and delete the @p transit object.
26726     *
26727     * Call this function if you wants to stop the animation before the duration
26728     * time. Make sure the @p transit object is still alive with
26729     * elm_transit_del_cb_set() function.
26730     * All added effects will be deleted, calling its repective data_free_cb
26731     * functions. The function setted by elm_transit_del_cb_set() will be called.
26732     *
26733     * @see elm_transit_del_cb_set()
26734     *
26735     * @param transit The transit object to be deleted.
26736     *
26737     * @ingroup Transit
26738     * @warning Just call this function if you are sure the transit is alive.
26739     */
26740    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26741
26742    /**
26743     * Add a new effect to the transit.
26744     *
26745     * @note The cb function and the data are the key to the effect. If you try to
26746     * add an already added effect, nothing is done.
26747     * @note After the first addition of an effect in @p transit, if its
26748     * effect list become empty again, the @p transit will be killed by
26749     * elm_transit_del(transit) function.
26750     *
26751     * Exemple:
26752     * @code
26753     * Elm_Transit *transit = elm_transit_add();
26754     * elm_transit_effect_add(transit,
26755     *                        elm_transit_effect_blend_op,
26756     *                        elm_transit_effect_blend_context_new(),
26757     *                        elm_transit_effect_blend_context_free);
26758     * @endcode
26759     *
26760     * @param transit The transit object.
26761     * @param transition_cb The operation function. It is called when the
26762     * animation begins, it is the function that actually performs the animation.
26763     * It is called with the @p data, @p transit and the time progression of the
26764     * animation (a double value between 0.0 and 1.0).
26765     * @param effect The context data of the effect.
26766     * @param end_cb The function to free the context data, it will be called
26767     * at the end of the effect, it must finalize the animation and free the
26768     * @p data.
26769     *
26770     * @ingroup Transit
26771     * @warning The transit free the context data at the and of the transition with
26772     * the data_free_cb function, do not use the context data in another transit.
26773     */
26774    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);
26775
26776    /**
26777     * Delete an added effect.
26778     *
26779     * This function will remove the effect from the @p transit, calling the
26780     * data_free_cb to free the @p data.
26781     *
26782     * @see elm_transit_effect_add()
26783     *
26784     * @note If the effect is not found, nothing is done.
26785     * @note If the effect list become empty, this function will call
26786     * elm_transit_del(transit), that is, it will kill the @p transit.
26787     *
26788     * @param transit The transit object.
26789     * @param transition_cb The operation function.
26790     * @param effect The context data of the effect.
26791     *
26792     * @ingroup Transit
26793     */
26794    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);
26795
26796    /**
26797     * Add new object to apply the effects.
26798     *
26799     * @note After the first addition of an object in @p transit, if its
26800     * object list become empty again, the @p transit will be killed by
26801     * elm_transit_del(transit) function.
26802     * @note If the @p obj belongs to another transit, the @p obj will be
26803     * removed from it and it will only belong to the @p transit. If the old
26804     * transit stays without objects, it will die.
26805     * @note When you add an object into the @p transit, its state from
26806     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26807     * transit ends, if you change this state whith evas_object_pass_events_set()
26808     * after add the object, this state will change again when @p transit stops to
26809     * run.
26810     *
26811     * @param transit The transit object.
26812     * @param obj Object to be animated.
26813     *
26814     * @ingroup Transit
26815     * @warning It is not allowed to add a new object after transit begins to go.
26816     */
26817    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26818
26819    /**
26820     * Removes an added object from the transit.
26821     *
26822     * @note If the @p obj is not in the @p transit, nothing is done.
26823     * @note If the list become empty, this function will call
26824     * elm_transit_del(transit), that is, it will kill the @p transit.
26825     *
26826     * @param transit The transit object.
26827     * @param obj Object to be removed from @p transit.
26828     *
26829     * @ingroup Transit
26830     * @warning It is not allowed to remove objects after transit begins to go.
26831     */
26832    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26833
26834    /**
26835     * Get the objects of the transit.
26836     *
26837     * @param transit The transit object.
26838     * @return a Eina_List with the objects from the transit.
26839     *
26840     * @ingroup Transit
26841     */
26842    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26843
26844    /**
26845     * Enable/disable keeping up the objects states.
26846     * If it is not kept, the objects states will be reset when transition ends.
26847     *
26848     * @note @p transit can not be NULL.
26849     * @note One state includes geometry, color, map data.
26850     *
26851     * @param transit The transit object.
26852     * @param state_keep Keeping or Non Keeping.
26853     *
26854     * @ingroup Transit
26855     */
26856    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26857
26858    /**
26859     * Get a value whether the objects states will be reset or not.
26860     *
26861     * @note @p transit can not be NULL
26862     *
26863     * @see elm_transit_objects_final_state_keep_set()
26864     *
26865     * @param transit The transit object.
26866     * @return EINA_TRUE means the states of the objects will be reset.
26867     * If @p transit is NULL, EINA_FALSE is returned
26868     *
26869     * @ingroup Transit
26870     */
26871    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26872
26873    /**
26874     * Set the event enabled when transit is operating.
26875     *
26876     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26877     * events from mouse and keyboard during the animation.
26878     * @note When you add an object with elm_transit_object_add(), its state from
26879     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26880     * transit ends, if you change this state with evas_object_pass_events_set()
26881     * after adding the object, this state will change again when @p transit stops
26882     * to run.
26883     *
26884     * @param transit The transit object.
26885     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26886     * ignored otherwise.
26887     *
26888     * @ingroup Transit
26889     */
26890    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26891
26892    /**
26893     * Get the value of event enabled status.
26894     *
26895     * @see elm_transit_event_enabled_set()
26896     *
26897     * @param transit The Transit object
26898     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26899     * EINA_FALSE is returned
26900     *
26901     * @ingroup Transit
26902     */
26903    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26904
26905    /**
26906     * Set the user-callback function when the transit is deleted.
26907     *
26908     * @note Using this function twice will overwrite the first function setted.
26909     * @note the @p transit object will be deleted after call @p cb function.
26910     *
26911     * @param transit The transit object.
26912     * @param cb Callback function pointer. This function will be called before
26913     * the deletion of the transit.
26914     * @param data Callback funtion user data. It is the @p op parameter.
26915     *
26916     * @ingroup Transit
26917     */
26918    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26919
26920    /**
26921     * Set reverse effect automatically.
26922     *
26923     * If auto reverse is setted, after running the effects with the progress
26924     * parameter from 0 to 1, it will call the effecs again with the progress
26925     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26926     * where the duration was setted with the function elm_transit_add and
26927     * the repeat with the function elm_transit_repeat_times_set().
26928     *
26929     * @param transit The transit object.
26930     * @param reverse EINA_TRUE means the auto_reverse is on.
26931     *
26932     * @ingroup Transit
26933     */
26934    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26935
26936    /**
26937     * Get if the auto reverse is on.
26938     *
26939     * @see elm_transit_auto_reverse_set()
26940     *
26941     * @param transit The transit object.
26942     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26943     * EINA_FALSE is returned
26944     *
26945     * @ingroup Transit
26946     */
26947    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26948
26949    /**
26950     * Set the transit repeat count. Effect will be repeated by repeat count.
26951     *
26952     * This function sets the number of repetition the transit will run after
26953     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26954     * If the @p repeat is a negative number, it will repeat infinite times.
26955     *
26956     * @note If this function is called during the transit execution, the transit
26957     * will run @p repeat times, ignoring the times it already performed.
26958     *
26959     * @param transit The transit object
26960     * @param repeat Repeat count
26961     *
26962     * @ingroup Transit
26963     */
26964    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26965
26966    /**
26967     * Get the transit repeat count.
26968     *
26969     * @see elm_transit_repeat_times_set()
26970     *
26971     * @param transit The Transit object.
26972     * @return The repeat count. If @p transit is NULL
26973     * 0 is returned
26974     *
26975     * @ingroup Transit
26976     */
26977    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26978
26979    /**
26980     * Set the transit animation acceleration type.
26981     *
26982     * This function sets the tween mode of the transit that can be:
26983     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26984     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26985     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26986     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26987     *
26988     * @param transit The transit object.
26989     * @param tween_mode The tween type.
26990     *
26991     * @ingroup Transit
26992     */
26993    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26994
26995    /**
26996     * Get the transit animation acceleration type.
26997     *
26998     * @note @p transit can not be NULL
26999     *
27000     * @param transit The transit object.
27001     * @return The tween type. If @p transit is NULL
27002     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27003     *
27004     * @ingroup Transit
27005     */
27006    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27007
27008    /**
27009     * Set the transit animation time
27010     *
27011     * @note @p transit can not be NULL
27012     *
27013     * @param transit The transit object.
27014     * @param duration The animation time.
27015     *
27016     * @ingroup Transit
27017     */
27018    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27019
27020    /**
27021     * Get the transit animation time
27022     *
27023     * @note @p transit can not be NULL
27024     *
27025     * @param transit The transit object.
27026     *
27027     * @return The transit animation time.
27028     *
27029     * @ingroup Transit
27030     */
27031    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27032
27033    /**
27034     * Starts the transition.
27035     * Once this API is called, the transit begins to measure the time.
27036     *
27037     * @note @p transit can not be NULL
27038     *
27039     * @param transit The transit object.
27040     *
27041     * @ingroup Transit
27042     */
27043    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27044
27045    /**
27046     * Pause/Resume the transition.
27047     *
27048     * If you call elm_transit_go again, the transit will be started from the
27049     * beginning, and will be unpaused.
27050     *
27051     * @note @p transit can not be NULL
27052     *
27053     * @param transit The transit object.
27054     * @param paused Whether the transition should be paused or not.
27055     *
27056     * @ingroup Transit
27057     */
27058    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27059
27060    /**
27061     * Get the value of paused status.
27062     *
27063     * @see elm_transit_paused_set()
27064     *
27065     * @note @p transit can not be NULL
27066     *
27067     * @param transit The transit object.
27068     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27069     * EINA_FALSE is returned
27070     *
27071     * @ingroup Transit
27072     */
27073    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27074
27075    /**
27076     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27077     *
27078     * The value returned is a fraction (current time / total time). It
27079     * represents the progression position relative to the total.
27080     *
27081     * @note @p transit can not be NULL
27082     *
27083     * @param transit The transit object.
27084     *
27085     * @return The time progression value. If @p transit is NULL
27086     * 0 is returned
27087     *
27088     * @ingroup Transit
27089     */
27090    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27091
27092    /**
27093     * Makes the chain relationship between two transits.
27094     *
27095     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27096     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27097     *
27098     * @param transit The transit object.
27099     * @param chain_transit The chain transit object. This transit will be operated
27100     *        after transit is done.
27101     *
27102     * This function adds @p chain_transit transition to a chain after the @p
27103     * transit, and will be started as soon as @p transit ends. See @ref
27104     * transit_example_02_explained for a full example.
27105     *
27106     * @ingroup Transit
27107     */
27108    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27109
27110    /**
27111     * Cut off the chain relationship between two transits.
27112     *
27113     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27114     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27115     *
27116     * @param transit The transit object.
27117     * @param chain_transit The chain transit object.
27118     *
27119     * This function remove the @p chain_transit transition from the @p transit.
27120     *
27121     * @ingroup Transit
27122     */
27123    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27124
27125    /**
27126     * Get the current chain transit list.
27127     *
27128     * @note @p transit can not be NULL.
27129     *
27130     * @param transit The transit object.
27131     * @return chain transit list.
27132     *
27133     * @ingroup Transit
27134     */
27135    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27136
27137    /**
27138     * Add the Resizing Effect to Elm_Transit.
27139     *
27140     * @note This API is one of the facades. It creates resizing effect context
27141     * and add it's required APIs to elm_transit_effect_add.
27142     *
27143     * @see elm_transit_effect_add()
27144     *
27145     * @param transit Transit object.
27146     * @param from_w Object width size when effect begins.
27147     * @param from_h Object height size when effect begins.
27148     * @param to_w Object width size when effect ends.
27149     * @param to_h Object height size when effect ends.
27150     * @return Resizing effect context data.
27151     *
27152     * @ingroup Transit
27153     */
27154    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);
27155
27156    /**
27157     * Add the Translation Effect to Elm_Transit.
27158     *
27159     * @note This API is one of the facades. It creates translation effect context
27160     * and add it's required APIs to elm_transit_effect_add.
27161     *
27162     * @see elm_transit_effect_add()
27163     *
27164     * @param transit Transit object.
27165     * @param from_dx X Position variation when effect begins.
27166     * @param from_dy Y Position variation when effect begins.
27167     * @param to_dx X Position variation when effect ends.
27168     * @param to_dy Y Position variation when effect ends.
27169     * @return Translation effect context data.
27170     *
27171     * @ingroup Transit
27172     * @warning It is highly recommended just create a transit with this effect when
27173     * the window that the objects of the transit belongs has already been created.
27174     * This is because this effect needs the geometry information about the objects,
27175     * and if the window was not created yet, it can get a wrong information.
27176     */
27177    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);
27178
27179    /**
27180     * Add the Zoom Effect to Elm_Transit.
27181     *
27182     * @note This API is one of the facades. It creates zoom effect context
27183     * and add it's required APIs to elm_transit_effect_add.
27184     *
27185     * @see elm_transit_effect_add()
27186     *
27187     * @param transit Transit object.
27188     * @param from_rate Scale rate when effect begins (1 is current rate).
27189     * @param to_rate Scale rate when effect ends.
27190     * @return Zoom effect context data.
27191     *
27192     * @ingroup Transit
27193     * @warning It is highly recommended just create a transit with this effect when
27194     * the window that the objects of the transit belongs has already been created.
27195     * This is because this effect needs the geometry information about the objects,
27196     * and if the window was not created yet, it can get a wrong information.
27197     */
27198    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27199
27200    /**
27201     * Add the Flip Effect to Elm_Transit.
27202     *
27203     * @note This API is one of the facades. It creates flip effect context
27204     * and add it's required APIs to elm_transit_effect_add.
27205     * @note This effect is applied to each pair of objects in the order they are listed
27206     * in the transit list of objects. The first object in the pair will be the
27207     * "front" object and the second will be the "back" object.
27208     *
27209     * @see elm_transit_effect_add()
27210     *
27211     * @param transit Transit object.
27212     * @param axis Flipping Axis(X or Y).
27213     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27214     * @return Flip effect context data.
27215     *
27216     * @ingroup Transit
27217     * @warning It is highly recommended just create a transit with this effect when
27218     * the window that the objects of the transit belongs has already been created.
27219     * This is because this effect needs the geometry information about the objects,
27220     * and if the window was not created yet, it can get a wrong information.
27221     */
27222    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27223
27224    /**
27225     * Add the Resizable Flip Effect to Elm_Transit.
27226     *
27227     * @note This API is one of the facades. It creates resizable flip effect context
27228     * and add it's required APIs to elm_transit_effect_add.
27229     * @note This effect is applied to each pair of objects in the order they are listed
27230     * in the transit list of objects. The first object in the pair will be the
27231     * "front" object and the second will be the "back" object.
27232     *
27233     * @see elm_transit_effect_add()
27234     *
27235     * @param transit Transit object.
27236     * @param axis Flipping Axis(X or Y).
27237     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27238     * @return Resizable flip effect context data.
27239     *
27240     * @ingroup Transit
27241     * @warning It is highly recommended just create a transit with this effect when
27242     * the window that the objects of the transit belongs has already been created.
27243     * This is because this effect needs the geometry information about the objects,
27244     * and if the window was not created yet, it can get a wrong information.
27245     */
27246    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27247
27248    /**
27249     * Add the Wipe Effect to Elm_Transit.
27250     *
27251     * @note This API is one of the facades. It creates wipe effect context
27252     * and add it's required APIs to elm_transit_effect_add.
27253     *
27254     * @see elm_transit_effect_add()
27255     *
27256     * @param transit Transit object.
27257     * @param type Wipe type. Hide or show.
27258     * @param dir Wipe Direction.
27259     * @return Wipe effect context data.
27260     *
27261     * @ingroup Transit
27262     * @warning It is highly recommended just create a transit with this effect when
27263     * the window that the objects of the transit belongs has already been created.
27264     * This is because this effect needs the geometry information about the objects,
27265     * and if the window was not created yet, it can get a wrong information.
27266     */
27267    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27268
27269    /**
27270     * Add the Color Effect to Elm_Transit.
27271     *
27272     * @note This API is one of the facades. It creates color effect context
27273     * and add it's required APIs to elm_transit_effect_add.
27274     *
27275     * @see elm_transit_effect_add()
27276     *
27277     * @param transit        Transit object.
27278     * @param  from_r        RGB R when effect begins.
27279     * @param  from_g        RGB G when effect begins.
27280     * @param  from_b        RGB B when effect begins.
27281     * @param  from_a        RGB A when effect begins.
27282     * @param  to_r          RGB R when effect ends.
27283     * @param  to_g          RGB G when effect ends.
27284     * @param  to_b          RGB B when effect ends.
27285     * @param  to_a          RGB A when effect ends.
27286     * @return               Color effect context data.
27287     *
27288     * @ingroup Transit
27289     */
27290    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);
27291
27292    /**
27293     * Add the Fade Effect to Elm_Transit.
27294     *
27295     * @note This API is one of the facades. It creates fade effect context
27296     * and add it's required APIs to elm_transit_effect_add.
27297     * @note This effect is applied to each pair of objects in the order they are listed
27298     * in the transit list of objects. The first object in the pair will be the
27299     * "before" object and the second will be the "after" object.
27300     *
27301     * @see elm_transit_effect_add()
27302     *
27303     * @param transit Transit object.
27304     * @return Fade effect context data.
27305     *
27306     * @ingroup Transit
27307     * @warning It is highly recommended just create a transit with this effect when
27308     * the window that the objects of the transit belongs has already been created.
27309     * This is because this effect needs the color information about the objects,
27310     * and if the window was not created yet, it can get a wrong information.
27311     */
27312    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27313
27314    /**
27315     * Add the Blend Effect to Elm_Transit.
27316     *
27317     * @note This API is one of the facades. It creates blend effect context
27318     * and add it's required APIs to elm_transit_effect_add.
27319     * @note This effect is applied to each pair of objects in the order they are listed
27320     * in the transit list of objects. The first object in the pair will be the
27321     * "before" object and the second will be the "after" object.
27322     *
27323     * @see elm_transit_effect_add()
27324     *
27325     * @param transit Transit object.
27326     * @return Blend effect context data.
27327     *
27328     * @ingroup Transit
27329     * @warning It is highly recommended just create a transit with this effect when
27330     * the window that the objects of the transit belongs has already been created.
27331     * This is because this effect needs the color information about the objects,
27332     * and if the window was not created yet, it can get a wrong information.
27333     */
27334    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27335
27336    /**
27337     * Add the Rotation Effect to Elm_Transit.
27338     *
27339     * @note This API is one of the facades. It creates rotation effect context
27340     * and add it's required APIs to elm_transit_effect_add.
27341     *
27342     * @see elm_transit_effect_add()
27343     *
27344     * @param transit Transit object.
27345     * @param from_degree Degree when effect begins.
27346     * @param to_degree Degree when effect is ends.
27347     * @return Rotation effect context data.
27348     *
27349     * @ingroup Transit
27350     * @warning It is highly recommended just create a transit with this effect when
27351     * the window that the objects of the transit belongs has already been created.
27352     * This is because this effect needs the geometry information about the objects,
27353     * and if the window was not created yet, it can get a wrong information.
27354     */
27355    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27356
27357    /**
27358     * Add the ImageAnimation Effect to Elm_Transit.
27359     *
27360     * @note This API is one of the facades. It creates image animation effect context
27361     * and add it's required APIs to elm_transit_effect_add.
27362     * The @p images parameter is a list images paths. This list and
27363     * its contents will be deleted at the end of the effect by
27364     * elm_transit_effect_image_animation_context_free() function.
27365     *
27366     * Example:
27367     * @code
27368     * char buf[PATH_MAX];
27369     * Eina_List *images = NULL;
27370     * Elm_Transit *transi = elm_transit_add();
27371     *
27372     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27373     * images = eina_list_append(images, eina_stringshare_add(buf));
27374     *
27375     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27376     * images = eina_list_append(images, eina_stringshare_add(buf));
27377     * elm_transit_effect_image_animation_add(transi, images);
27378     *
27379     * @endcode
27380     *
27381     * @see elm_transit_effect_add()
27382     *
27383     * @param transit Transit object.
27384     * @param images Eina_List of images file paths. This list and
27385     * its contents will be deleted at the end of the effect by
27386     * elm_transit_effect_image_animation_context_free() function.
27387     * @return Image Animation effect context data.
27388     *
27389     * @ingroup Transit
27390     */
27391    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27392    /**
27393     * @}
27394     */
27395
27396    typedef struct _Elm_Store                      Elm_Store;
27397    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27398    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27399    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27400    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27401    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27402    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27403    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27404    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27405    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27406    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27407
27408    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27409    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27410    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27411    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27412
27413    typedef enum
27414      {
27415         ELM_STORE_ITEM_MAPPING_NONE = 0,
27416         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27417         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27418         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27419         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27420         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27421         // can add more here as needed by common apps
27422         ELM_STORE_ITEM_MAPPING_LAST
27423      } Elm_Store_Item_Mapping_Type;
27424
27425    struct _Elm_Store_Item_Mapping_Icon
27426      {
27427         // FIXME: allow edje file icons
27428         int                   w, h;
27429         Elm_Icon_Lookup_Order lookup_order;
27430         Eina_Bool             standard_name : 1;
27431         Eina_Bool             no_scale : 1;
27432         Eina_Bool             smooth : 1;
27433         Eina_Bool             scale_up : 1;
27434         Eina_Bool             scale_down : 1;
27435      };
27436
27437    struct _Elm_Store_Item_Mapping_Empty
27438      {
27439         Eina_Bool             dummy;
27440      };
27441
27442    struct _Elm_Store_Item_Mapping_Photo
27443      {
27444         int                   size;
27445      };
27446
27447    struct _Elm_Store_Item_Mapping_Custom
27448      {
27449         Elm_Store_Item_Mapping_Cb func;
27450      };
27451
27452    struct _Elm_Store_Item_Mapping
27453      {
27454         Elm_Store_Item_Mapping_Type     type;
27455         const char                     *part;
27456         int                             offset;
27457         union
27458           {
27459              Elm_Store_Item_Mapping_Empty  empty;
27460              Elm_Store_Item_Mapping_Icon   icon;
27461              Elm_Store_Item_Mapping_Photo  photo;
27462              Elm_Store_Item_Mapping_Custom custom;
27463              // add more types here
27464           } details;
27465      };
27466
27467    struct _Elm_Store_Item_Info
27468      {
27469         Elm_Genlist_Item_Class       *item_class;
27470         const Elm_Store_Item_Mapping *mapping;
27471         void                         *data;
27472         char                         *sort_id;
27473      };
27474
27475    struct _Elm_Store_Item_Info_Filesystem
27476      {
27477         Elm_Store_Item_Info  base;
27478         char                *path;
27479      };
27480
27481 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27482 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27483
27484    EAPI void                    elm_store_free(Elm_Store *st);
27485
27486    EAPI Elm_Store              *elm_store_filesystem_new(void);
27487    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27488    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27489    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27490
27491    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27492
27493    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27494    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27495    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27496    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27497    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27498    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27499
27500    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27501    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27502    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27503    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27504    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27505    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27506    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27507
27508    /**
27509     * @defgroup SegmentControl SegmentControl
27510     * @ingroup Elementary
27511     *
27512     * @image html img/widget/segment_control/preview-00.png
27513     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27514     *
27515     * @image html img/segment_control.png
27516     * @image latex img/segment_control.eps width=\textwidth
27517     *
27518     * Segment control widget is a horizontal control made of multiple segment
27519     * items, each segment item functioning similar to discrete two state button.
27520     * A segment control groups the items together and provides compact
27521     * single button with multiple equal size segments.
27522     *
27523     * Segment item size is determined by base widget
27524     * size and the number of items added.
27525     * Only one segment item can be at selected state. A segment item can display
27526     * combination of Text and any Evas_Object like Images or other widget.
27527     *
27528     * Smart callbacks one can listen to:
27529     * - "changed" - When the user clicks on a segment item which is not
27530     *   previously selected and get selected. The event_info parameter is the
27531     *   segment item pointer.
27532     *
27533     * Available styles for it:
27534     * - @c "default"
27535     *
27536     * Here is an example on its usage:
27537     * @li @ref segment_control_example
27538     */
27539
27540    /**
27541     * @addtogroup SegmentControl
27542     * @{
27543     */
27544
27545    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27546
27547    /**
27548     * Add a new segment control widget to the given parent Elementary
27549     * (container) object.
27550     *
27551     * @param parent The parent object.
27552     * @return a new segment control widget handle or @c NULL, on errors.
27553     *
27554     * This function inserts a new segment control widget on the canvas.
27555     *
27556     * @ingroup SegmentControl
27557     */
27558    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27559
27560    /**
27561     * Append a new item to the segment control object.
27562     *
27563     * @param obj The segment control object.
27564     * @param icon The icon object to use for the left side of the item. An
27565     * icon can be any Evas object, but usually it is an icon created
27566     * with elm_icon_add().
27567     * @param label The label of the item.
27568     *        Note that, NULL is different from empty string "".
27569     * @return The created item or @c NULL upon failure.
27570     *
27571     * A new item will be created and appended to the segment control, i.e., will
27572     * be set as @b last item.
27573     *
27574     * If it should be inserted at another position,
27575     * elm_segment_control_item_insert_at() should be used instead.
27576     *
27577     * Items created with this function can be deleted with function
27578     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27579     *
27580     * @note @p label set to @c NULL is different from empty string "".
27581     * If an item
27582     * only has icon, it will be displayed bigger and centered. If it has
27583     * icon and label, even that an empty string, icon will be smaller and
27584     * positioned at left.
27585     *
27586     * Simple example:
27587     * @code
27588     * sc = elm_segment_control_add(win);
27589     * ic = elm_icon_add(win);
27590     * elm_icon_file_set(ic, "path/to/image", NULL);
27591     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27592     * elm_segment_control_item_add(sc, ic, "label");
27593     * evas_object_show(sc);
27594     * @endcode
27595     *
27596     * @see elm_segment_control_item_insert_at()
27597     * @see elm_segment_control_item_del()
27598     *
27599     * @ingroup SegmentControl
27600     */
27601    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27602
27603    /**
27604     * Insert a new item to the segment control object at specified position.
27605     *
27606     * @param obj The segment control object.
27607     * @param icon The icon object to use for the left side of the item. An
27608     * icon can be any Evas object, but usually it is an icon created
27609     * with elm_icon_add().
27610     * @param label The label of the item.
27611     * @param index Item position. Value should be between 0 and items count.
27612     * @return The created item or @c NULL upon failure.
27613
27614     * Index values must be between @c 0, when item will be prepended to
27615     * segment control, and items count, that can be get with
27616     * elm_segment_control_item_count_get(), case when item will be appended
27617     * to segment control, just like elm_segment_control_item_add().
27618     *
27619     * Items created with this function can be deleted with function
27620     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27621     *
27622     * @note @p label set to @c NULL is different from empty string "".
27623     * If an item
27624     * only has icon, it will be displayed bigger and centered. If it has
27625     * icon and label, even that an empty string, icon will be smaller and
27626     * positioned at left.
27627     *
27628     * @see elm_segment_control_item_add()
27629     * @see elm_segment_control_item_count_get()
27630     * @see elm_segment_control_item_del()
27631     *
27632     * @ingroup SegmentControl
27633     */
27634    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);
27635
27636    /**
27637     * Remove a segment control item from its parent, deleting it.
27638     *
27639     * @param it The item to be removed.
27640     *
27641     * Items can be added with elm_segment_control_item_add() or
27642     * elm_segment_control_item_insert_at().
27643     *
27644     * @ingroup SegmentControl
27645     */
27646    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27647
27648    /**
27649     * Remove a segment control item at given index from its parent,
27650     * deleting it.
27651     *
27652     * @param obj The segment control object.
27653     * @param index The position of the segment control item to be deleted.
27654     *
27655     * Items can be added with elm_segment_control_item_add() or
27656     * elm_segment_control_item_insert_at().
27657     *
27658     * @ingroup SegmentControl
27659     */
27660    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27661
27662    /**
27663     * Get the Segment items count from segment control.
27664     *
27665     * @param obj The segment control object.
27666     * @return Segment items count.
27667     *
27668     * It will just return the number of items added to segment control @p obj.
27669     *
27670     * @ingroup SegmentControl
27671     */
27672    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27673
27674    /**
27675     * Get the item placed at specified index.
27676     *
27677     * @param obj The segment control object.
27678     * @param index The index of the segment item.
27679     * @return The segment control item or @c NULL on failure.
27680     *
27681     * Index is the position of an item in segment control widget. Its
27682     * range is from @c 0 to <tt> count - 1 </tt>.
27683     * Count is the number of items, that can be get with
27684     * elm_segment_control_item_count_get().
27685     *
27686     * @ingroup SegmentControl
27687     */
27688    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27689
27690    /**
27691     * Get the label of item.
27692     *
27693     * @param obj The segment control object.
27694     * @param index The index of the segment item.
27695     * @return The label of the item at @p index.
27696     *
27697     * The return value is a pointer to the label associated to the item when
27698     * it was created, with function elm_segment_control_item_add(), or later
27699     * with function elm_segment_control_item_label_set. If no label
27700     * was passed as argument, it will return @c NULL.
27701     *
27702     * @see elm_segment_control_item_label_set() for more details.
27703     * @see elm_segment_control_item_add()
27704     *
27705     * @ingroup SegmentControl
27706     */
27707    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27708
27709    /**
27710     * Set the label of item.
27711     *
27712     * @param it The item of segment control.
27713     * @param text The label of item.
27714     *
27715     * The label to be displayed by the item.
27716     * Label will be at right of the icon (if set).
27717     *
27718     * If a label was passed as argument on item creation, with function
27719     * elm_control_segment_item_add(), it will be already
27720     * displayed by the item.
27721     *
27722     * @see elm_segment_control_item_label_get()
27723     * @see elm_segment_control_item_add()
27724     *
27725     * @ingroup SegmentControl
27726     */
27727    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27728
27729    /**
27730     * Get the icon associated to the item.
27731     *
27732     * @param obj The segment control object.
27733     * @param index The index of the segment item.
27734     * @return The left side icon associated to the item at @p index.
27735     *
27736     * The return value is a pointer to the icon associated to the item when
27737     * it was created, with function elm_segment_control_item_add(), or later
27738     * with function elm_segment_control_item_icon_set(). If no icon
27739     * was passed as argument, it will return @c NULL.
27740     *
27741     * @see elm_segment_control_item_add()
27742     * @see elm_segment_control_item_icon_set()
27743     *
27744     * @ingroup SegmentControl
27745     */
27746    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27747
27748    /**
27749     * Set the icon associated to the item.
27750     *
27751     * @param it The segment control item.
27752     * @param icon The icon object to associate with @p it.
27753     *
27754     * The icon object to use at left side of the item. An
27755     * icon can be any Evas object, but usually it is an icon created
27756     * with elm_icon_add().
27757     *
27758     * Once the icon object is set, a previously set one will be deleted.
27759     * @warning Setting the same icon for two items will cause the icon to
27760     * dissapear from the first item.
27761     *
27762     * If an icon was passed as argument on item creation, with function
27763     * elm_segment_control_item_add(), it will be already
27764     * associated to the item.
27765     *
27766     * @see elm_segment_control_item_add()
27767     * @see elm_segment_control_item_icon_get()
27768     *
27769     * @ingroup SegmentControl
27770     */
27771    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27772
27773    /**
27774     * Get the index of an item.
27775     *
27776     * @param it The segment control item.
27777     * @return The position of item in segment control widget.
27778     *
27779     * Index is the position of an item in segment control widget. Its
27780     * range is from @c 0 to <tt> count - 1 </tt>.
27781     * Count is the number of items, that can be get with
27782     * elm_segment_control_item_count_get().
27783     *
27784     * @ingroup SegmentControl
27785     */
27786    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27787
27788    /**
27789     * Get the base object of the item.
27790     *
27791     * @param it The segment control item.
27792     * @return The base object associated with @p it.
27793     *
27794     * Base object is the @c Evas_Object that represents that item.
27795     *
27796     * @ingroup SegmentControl
27797     */
27798    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27799
27800    /**
27801     * Get the selected item.
27802     *
27803     * @param obj The segment control object.
27804     * @return The selected item or @c NULL if none of segment items is
27805     * selected.
27806     *
27807     * The selected item can be unselected with function
27808     * elm_segment_control_item_selected_set().
27809     *
27810     * The selected item always will be highlighted on segment control.
27811     *
27812     * @ingroup SegmentControl
27813     */
27814    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27815
27816    /**
27817     * Set the selected state of an item.
27818     *
27819     * @param it The segment control item
27820     * @param select The selected state
27821     *
27822     * This sets the selected state of the given item @p it.
27823     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27824     *
27825     * If a new item is selected the previosly selected will be unselected.
27826     * Previoulsy selected item can be get with function
27827     * elm_segment_control_item_selected_get().
27828     *
27829     * The selected item always will be highlighted on segment control.
27830     *
27831     * @see elm_segment_control_item_selected_get()
27832     *
27833     * @ingroup SegmentControl
27834     */
27835    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27836
27837    /**
27838     * @}
27839     */
27840
27841    /**
27842     * @defgroup Grid Grid
27843     *
27844     * The grid is a grid layout widget that lays out a series of children as a
27845     * fixed "grid" of widgets using a given percentage of the grid width and
27846     * height each using the child object.
27847     *
27848     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27849     * widgets size itself. The default is 100 x 100, so that means the
27850     * position and sizes of children will effectively be percentages (0 to 100)
27851     * of the width or height of the grid widget
27852     *
27853     * @{
27854     */
27855
27856    /**
27857     * Add a new grid to the parent
27858     *
27859     * @param parent The parent object
27860     * @return The new object or NULL if it cannot be created
27861     *
27862     * @ingroup Grid
27863     */
27864    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27865
27866    /**
27867     * Set the virtual size of the grid
27868     *
27869     * @param obj The grid object
27870     * @param w The virtual width of the grid
27871     * @param h The virtual height of the grid
27872     *
27873     * @ingroup Grid
27874     */
27875    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27876
27877    /**
27878     * Get the virtual size of the grid
27879     *
27880     * @param obj The grid object
27881     * @param w Pointer to integer to store the virtual width of the grid
27882     * @param h Pointer to integer to store the virtual height of the grid
27883     *
27884     * @ingroup Grid
27885     */
27886    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27887
27888    /**
27889     * Pack child at given position and size
27890     *
27891     * @param obj The grid object
27892     * @param subobj The child to pack
27893     * @param x The virtual x coord at which to pack it
27894     * @param y The virtual y coord at which to pack it
27895     * @param w The virtual width at which to pack it
27896     * @param h The virtual height at which to pack it
27897     *
27898     * @ingroup Grid
27899     */
27900    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27901
27902    /**
27903     * Unpack a child from a grid object
27904     *
27905     * @param obj The grid object
27906     * @param subobj The child to unpack
27907     *
27908     * @ingroup Grid
27909     */
27910    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27911
27912    /**
27913     * Faster way to remove all child objects from a grid object.
27914     *
27915     * @param obj The grid object
27916     * @param clear If true, it will delete just removed children
27917     *
27918     * @ingroup Grid
27919     */
27920    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27921
27922    /**
27923     * Set packing of an existing child at to position and size
27924     *
27925     * @param subobj The child to set packing of
27926     * @param x The virtual x coord at which to pack it
27927     * @param y The virtual y coord at which to pack it
27928     * @param w The virtual width at which to pack it
27929     * @param h The virtual height at which to pack it
27930     *
27931     * @ingroup Grid
27932     */
27933    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27934
27935    /**
27936     * get packing of a child
27937     *
27938     * @param subobj The child to query
27939     * @param x Pointer to integer to store the virtual x coord
27940     * @param y Pointer to integer to store the virtual y coord
27941     * @param w Pointer to integer to store the virtual width
27942     * @param h Pointer to integer to store the virtual height
27943     *
27944     * @ingroup Grid
27945     */
27946    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27947
27948    /**
27949     * @}
27950     */
27951
27952    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27953    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27954    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27955    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27956    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
27957    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
27958
27959    /**
27960     * @defgroup Video Video
27961     *
27962     * @addtogroup Video
27963     * @{
27964     *
27965     * Elementary comes with two object that help design application that need
27966     * to display video. The main one, Elm_Video, display a video by using Emotion.
27967     * It does embedded the video inside an Edje object, so you can do some
27968     * animation depending on the video state change. It does also implement a
27969     * ressource management policy to remove this burden from the application writer.
27970     *
27971     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27972     * It take care of updating its content according to Emotion event and provide a
27973     * way to theme itself. It also does automatically raise the priority of the
27974     * linked Elm_Video so it will use the video decoder if available. It also does
27975     * activate the remember function on the linked Elm_Video object.
27976     *
27977     * Signals that you can add callback for are :
27978     *
27979     * "forward,clicked" - the user clicked the forward button.
27980     * "info,clicked" - the user clicked the info button.
27981     * "next,clicked" - the user clicked the next button.
27982     * "pause,clicked" - the user clicked the pause button.
27983     * "play,clicked" - the user clicked the play button.
27984     * "prev,clicked" - the user clicked the prev button.
27985     * "rewind,clicked" - the user clicked the rewind button.
27986     * "stop,clicked" - the user clicked the stop button.
27987     */
27988
27989    /**
27990     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27991     *
27992     * @param parent The parent object
27993     * @return a new player widget handle or @c NULL, on errors.
27994     *
27995     * This function inserts a new player widget on the canvas.
27996     *
27997     * @see elm_player_video_set()
27998     *
27999     * @ingroup Video
28000     */
28001    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28002
28003    /**
28004     * @brief Link a Elm_Payer with an Elm_Video object.
28005     *
28006     * @param player the Elm_Player object.
28007     * @param video The Elm_Video object.
28008     *
28009     * This mean that action on the player widget will affect the
28010     * video object and the state of the video will be reflected in
28011     * the player itself.
28012     *
28013     * @see elm_player_add()
28014     * @see elm_video_add()
28015     *
28016     * @ingroup Video
28017     */
28018    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28019
28020    /**
28021     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28022     *
28023     * @param parent The parent object
28024     * @return a new video widget handle or @c NULL, on errors.
28025     *
28026     * This function inserts a new video widget on the canvas.
28027     *
28028     * @seeelm_video_file_set()
28029     * @see elm_video_uri_set()
28030     *
28031     * @ingroup Video
28032     */
28033    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28034
28035    /**
28036     * @brief Define the file that will be the video source.
28037     *
28038     * @param video The video object to define the file for.
28039     * @param filename The file to target.
28040     *
28041     * This function will explicitly define a filename as a source
28042     * for the video of the Elm_Video object.
28043     *
28044     * @see elm_video_uri_set()
28045     * @see elm_video_add()
28046     * @see elm_player_add()
28047     *
28048     * @ingroup Video
28049     */
28050    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28051
28052    /**
28053     * @brief Define the uri that will be the video source.
28054     *
28055     * @param video The video object to define the file for.
28056     * @param uri The uri to target.
28057     *
28058     * This function will define an uri as a source for the video of the
28059     * Elm_Video object. URI could be remote source of video, like http:// or local source
28060     * like for example WebCam who are most of the time v4l2:// (but that depend and
28061     * you should use Emotion API to request and list the available Webcam on your system).
28062     *
28063     * @see elm_video_file_set()
28064     * @see elm_video_add()
28065     * @see elm_player_add()
28066     *
28067     * @ingroup Video
28068     */
28069    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28070
28071    /**
28072     * @brief Get the underlying Emotion object.
28073     *
28074     * @param video The video object to proceed the request on.
28075     * @return the underlying Emotion object.
28076     *
28077     * @ingroup Video
28078     */
28079    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
28080
28081    /**
28082     * @brief Start to play the video
28083     *
28084     * @param video The video object to proceed the request on.
28085     *
28086     * Start to play the video and cancel all suspend state.
28087     *
28088     * @ingroup Video
28089     */
28090    EAPI void elm_video_play(Evas_Object *video);
28091
28092    /**
28093     * @brief Pause the video
28094     *
28095     * @param video The video object to proceed the request on.
28096     *
28097     * Pause the video and start a timer to trigger suspend mode.
28098     *
28099     * @ingroup Video
28100     */
28101    EAPI void elm_video_pause(Evas_Object *video);
28102
28103    /**
28104     * @brief Stop the video
28105     *
28106     * @param video The video object to proceed the request on.
28107     *
28108     * Stop the video and put the emotion in deep sleep mode.
28109     *
28110     * @ingroup Video
28111     */
28112    EAPI void elm_video_stop(Evas_Object *video);
28113
28114    /**
28115     * @brief Is the video actually playing.
28116     *
28117     * @param video The video object to proceed the request on.
28118     * @return EINA_TRUE if the video is actually playing.
28119     *
28120     * You should consider watching event on the object instead of polling
28121     * the object state.
28122     *
28123     * @ingroup Video
28124     */
28125    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
28126
28127    /**
28128     * @brief Is it possible to seek inside the video.
28129     *
28130     * @param video The video object to proceed the request on.
28131     * @return EINA_TRUE if is possible to seek inside the video.
28132     *
28133     * @ingroup Video
28134     */
28135    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
28136
28137    /**
28138     * @brief Is the audio muted.
28139     *
28140     * @param video The video object to proceed the request on.
28141     * @return EINA_TRUE if the audio is muted.
28142     *
28143     * @ingroup Video
28144     */
28145    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
28146
28147    /**
28148     * @brief Change the mute state of the Elm_Video object.
28149     *
28150     * @param video The video object to proceed the request on.
28151     * @param mute The new mute state.
28152     *
28153     * @ingroup Video
28154     */
28155    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28156
28157    /**
28158     * @brief Get the audio level of the current video.
28159     *
28160     * @param video The video object to proceed the request on.
28161     * @return the current audio level.
28162     *
28163     * @ingroup Video
28164     */
28165    EAPI double elm_video_audio_level_get(Evas_Object *video);
28166
28167    /**
28168     * @brief Set the audio level of anElm_Video object.
28169     *
28170     * @param video The video object to proceed the request on.
28171     * @param volume The new audio volume.
28172     *
28173     * @ingroup Video
28174     */
28175    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28176
28177    EAPI double elm_video_play_position_get(Evas_Object *video);
28178    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28179    EAPI double elm_video_play_length_get(Evas_Object *video);
28180    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28181    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
28182    EAPI const char *elm_video_title_get(Evas_Object *video);
28183    /**
28184     * @}
28185     */
28186
28187    /**
28188     * @defgroup Naviframe Naviframe
28189     * @ingroup Elementary
28190     *
28191     * @brief Naviframe is a kind of view manager for the applications.
28192     *
28193     * Naviframe provides functions to switch different pages with stack
28194     * mechanism. It means if one page(item) needs to be changed to the new one,
28195     * then naviframe would push the new page to it's internal stack. Of course,
28196     * it can be back to the previous page by popping the top page. Naviframe
28197     * provides some transition effect while the pages are switching (same as
28198     * pager).
28199     *
28200     * Since each item could keep the different styles, users could keep the
28201     * same look & feel for the pages or different styles for the items in it's
28202     * application.
28203     *
28204     * Signals that you can add callback for are:
28205     * @li "transition,finished" - When the transition is finished in changing
28206     *     the item
28207     * @li "title,clicked" - User clicked title area
28208     *
28209     * Default contents parts of the naviframe items that you can use for are:
28210     * @li "elm.swallow.content" - A main content of the page
28211     * @li "elm.swallow.icon" - A icon in the title area
28212     * @li "elm.swallow.prev_btn" - A button to go to the previous page
28213     * @li "elm.swallow.next_btn" - A button to go to the next page
28214     *
28215     * Default text parts of the naviframe items that you can use for are:
28216     * @li "elm.text.title" - Title label in the title area
28217     * @li "elm.text.subtitle" - Sub-title label in the title area
28218     *
28219     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28220     */
28221
28222 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28223 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28224 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28225 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28226
28227    /**
28228     * @addtogroup Naviframe
28229     * @{
28230     */
28231
28232    /**
28233     * @brief Add a new Naviframe object to the parent.
28234     *
28235     * @param parent Parent object
28236     * @return New object or @c NULL, if it cannot be created
28237     *
28238     * @ingroup Naviframe
28239     */
28240    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28241    /**
28242     * @brief Push a new item to the top of the naviframe stack (and show it).
28243     *
28244     * @param obj The naviframe object
28245     * @param title_label The label in the title area. The name of the title
28246     *        label part is "elm.text.title"
28247     * @param prev_btn The button to go to the previous item. If it is NULL,
28248     *        then naviframe will create a back button automatically. The name of
28249     *        the prev_btn part is "elm.swallow.prev_btn"
28250     * @param next_btn The button to go to the next item. Or It could be just an
28251     *        extra function button. The name of the next_btn part is
28252     *        "elm.swallow.next_btn"
28253     * @param content The main content object. The name of content part is
28254     *        "elm.swallow.content"
28255     * @param item_style The current item style name. @c NULL would be default.
28256     * @return The created item or @c NULL upon failure.
28257     *
28258     * The item pushed becomes one page of the naviframe, this item will be
28259     * deleted when it is popped.
28260     *
28261     * @see also elm_naviframe_item_style_set()
28262     *
28263     * The following styles are available for this item:
28264     * @li @c "default"
28265     *
28266     * @ingroup Naviframe
28267     */
28268    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);
28269    /**
28270     * @brief Pop an item that is on top of the stack
28271     *
28272     * @param obj The naviframe object
28273     * @return @c NULL or the content object(if the
28274     *         elm_naviframe_content_preserve_on_pop_get is true).
28275     *
28276     * This pops an item that is on the top(visible) of the naviframe, makes it
28277     * disappear, then deletes the item. The item that was underneath it on the
28278     * stack will become visible.
28279     *
28280     * @see also elm_naviframe_content_preserve_on_pop_get()
28281     *
28282     * @ingroup Naviframe
28283     */
28284    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28285    /**
28286     * @brief Pop the items between the top and the above one on the given item.
28287     *
28288     * @param it The naviframe item
28289     *
28290     * @ingroup Naviframe
28291     */
28292    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28293    /**
28294    * Promote an item already in the naviframe stack to the top of the stack
28295    *
28296    * @param it The naviframe item
28297    *
28298    * This will take the indicated item and promote it to the top of the stack
28299    * as if it had been pushed there. The item must already be inside the
28300    * naviframe stack to work.
28301    *
28302    */
28303    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28304    /**
28305     * @brief Delete the given item instantly.
28306     *
28307     * @param it The naviframe item
28308     *
28309     * This just deletes the given item from the naviframe item list instantly.
28310     * So this would not emit any signals for view transitions but just change
28311     * the current view if the given item is a top one.
28312     *
28313     * @ingroup Naviframe
28314     */
28315    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28316    /**
28317     * @brief preserve the content objects when items are popped.
28318     *
28319     * @param obj The naviframe object
28320     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28321     *
28322     * @see also elm_naviframe_content_preserve_on_pop_get()
28323     *
28324     * @ingroup Naviframe
28325     */
28326    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28327    /**
28328     * @brief Get a value whether preserve mode is enabled or not.
28329     *
28330     * @param obj The naviframe object
28331     * @return If @c EINA_TRUE, preserve mode is enabled
28332     *
28333     * @see also elm_naviframe_content_preserve_on_pop_set()
28334     *
28335     * @ingroup Naviframe
28336     */
28337    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28338    /**
28339     * @brief Get a top item on the naviframe stack
28340     *
28341     * @param obj The naviframe object
28342     * @return The top item on the naviframe stack or @c NULL, if the stack is
28343     *         empty
28344     *
28345     * @ingroup Naviframe
28346     */
28347    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28348    /**
28349     * @brief Get a bottom item on the naviframe stack
28350     *
28351     * @param obj The naviframe object
28352     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28353     *         empty
28354     *
28355     * @ingroup Naviframe
28356     */
28357    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28358    /**
28359     * @brief Set an item style
28360     *
28361     * @param obj The naviframe item
28362     * @param item_style The current item style name. @c NULL would be default
28363     *
28364     * The following styles are available for this item:
28365     * @li @c "default"
28366     *
28367     * @see also elm_naviframe_item_style_get()
28368     *
28369     * @ingroup Naviframe
28370     */
28371    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28372    /**
28373     * @brief Get an item style
28374     *
28375     * @param obj The naviframe item
28376     * @return The current item style name
28377     *
28378     * @see also elm_naviframe_item_style_set()
28379     *
28380     * @ingroup Naviframe
28381     */
28382    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28383    /**
28384     * @brief Show/Hide the title area
28385     *
28386     * @param it The naviframe item
28387     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28388     *        otherwise
28389     *
28390     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28391     *
28392     * @see also elm_naviframe_item_title_visible_get()
28393     *
28394     * @ingroup Naviframe
28395     */
28396    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28397    /**
28398     * @brief Get a value whether title area is visible or not.
28399     *
28400     * @param it The naviframe item
28401     * @return If @c EINA_TRUE, title area is visible
28402     *
28403     * @see also elm_naviframe_item_title_visible_set()
28404     *
28405     * @ingroup Naviframe
28406     */
28407    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28408
28409    /**
28410     * @brief Set creating prev button automatically or not
28411     *
28412     * @param obj The naviframe object
28413     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28414     *        be created internally when you pass the @c NULL to the prev_btn
28415     *        parameter in elm_naviframe_item_push
28416     *
28417     * @see also elm_naviframe_item_push()
28418     */
28419    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28420    /**
28421     * @brief Get a value whether prev button(back button) will be auto pushed or
28422     *        not.
28423     *
28424     * @param obj The naviframe object
28425     * @return If @c EINA_TRUE, prev button will be auto pushed.
28426     *
28427     * @see also elm_naviframe_item_push()
28428     *           elm_naviframe_prev_btn_auto_pushed_set()
28429     */
28430    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28431
28432    /**
28433     * @}
28434     */
28435
28436 #ifdef __cplusplus
28437 }
28438 #endif
28439
28440 #endif