cff69a14db75766a78f48e5fea7ee358d529c22d
[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.7.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 in which the widgets will be
33                           layouted.
34
35 @section license License
36
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
39
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
45 */
46
47
48 /**
49  * @defgroup Start Getting Started
50  *
51  * To write an Elementary app, you can get started with the following:
52  *
53 @code
54 #include <Elementary.h>
55 EAPI_MAIN int
56 elm_main(int argc, char **argv)
57 {
58    // create window(s) here and do any application init
59    elm_run(); // run main loop
60    elm_shutdown(); // after mainloop finishes running, shutdown
61    return 0; // exit 0 for exit code
62 }
63 ELM_MAIN()
64 @endcode
65  *
66  * To use autotools (which helps in many ways in the long run, like being able
67  * to immediately create releases of your software directly from your tree
68  * and ensure everything needed to build it is there) you will need a
69  * configure.ac, Makefile.am and autogen.sh file.
70  *
71  * configure.ac:
72  *
73 @verbatim
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_PREREQ(2.52)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
78 AC_PROG_CC
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
81 AC_OUTPUT(Makefile)
82 @endverbatim
83  *
84  * Makefile.am:
85  *
86 @verbatim
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89
90 INCLUDES = -I$(top_srcdir)
91
92 bin_PROGRAMS = myapp
93
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
97 @endverbatim
98  *
99  * autogen.sh:
100  *
101 @verbatim
102 #!/bin/sh
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
107 ./configure "$@"
108 @endverbatim
109  *
110  * To generate all the things needed to bootstrap just run:
111  *
112 @verbatim
113 ./autogen.sh
114 @endverbatim
115  *
116  * This will generate Makefile.in's, the confgure script and everything else.
117  * After this it works like all normal autotools projects:
118 @verbatim
119 ./configure
120 make
121 sudo make install
122 @endverbatim
123  *
124  * Note sudo was assumed to get root permissions, as this would install in
125  * /usr/local which is system-owned. Use any way you like to gain root, or
126  * specify a different prefix with configure:
127  *
128 @verbatim
129 ./confiugre --prefix=$HOME/mysoftware
130 @endverbatim
131  *
132  * Also remember that autotools buys you some useful commands like:
133 @verbatim
134 make uninstall
135 @endverbatim
136  *
137  * This uninstalls the software after it was installed with "make install".
138  * It is very useful to clear up what you built if you wish to clean the
139  * system.
140  *
141 @verbatim
142 make distcheck
143 @endverbatim
144  *
145  * This firstly checks if your build tree is "clean" and ready for
146  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147  * ready to upload and distribute to the world, that contains the generated
148  * Makefile.in's and configure script. The users do not need to run
149  * autogen.sh - just configure and on. They don't need autotools installed.
150  * This tarball also builds cleanly, has all the sources it needs to build
151  * included (that is sources for your application, not libraries it depends
152  * on like Elementary). It builds cleanly in a buildroot and does not
153  * contain any files that are temporarily generated like binaries and other
154  * build-generated files, so the tarball is clean, and no need to worry
155  * about cleaning up your tree before packaging.
156  *
157 @verbatim
158 make clean
159 @endverbatim
160  *
161  * This cleans up all build files (binaries, objects etc.) from the tree.
162  *
163 @verbatim
164 make distclean
165 @endverbatim
166  *
167  * This cleans out all files from the build and from configure's output too.
168  *
169 @verbatim
170 make maintainer-clean
171 @endverbatim
172  *
173  * This deletes all the files autogen.sh will produce so the tree is clean
174  * to be put into a revision-control system (like CVS, SVN or GIT for example).
175  *
176  * There is a more advanced way of making use of the quicklaunch infrastructure
177  * in Elementary (which will not be covered here due to its more advanced
178  * nature).
179  *
180  * Now let's actually create an interactive "Hello World" gui that you can
181  * click the ok button to exit. It's more code because this now does something
182  * much more significant, but it's still very simple:
183  *
184 @code
185 #include <Elementary.h>
186
187 static void
188 on_done(void *data, Evas_Object *obj, void *event_info)
189 {
190    // quit the mainloop (elm_run function will return)
191    elm_exit();
192 }
193
194 EAPI_MAIN int
195 elm_main(int argc, char **argv)
196 {
197    Evas_Object *win, *bg, *box, *lab, *btn;
198
199    // new window - do the usual and give it a name, title and delete handler
200    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201    elm_win_title_set(win, "Hello");
202    // when the user clicks "close" on a window there is a request to delete
203    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
204
205    // add a standard bg
206    bg = elm_bg_add(win);
207    // add object as a resize object for the window (controls window minimum
208    // size as well as gets resized if window is resized)
209    elm_win_resize_object_add(win, bg);
210    evas_object_show(bg);
211
212    // add a box object - default is vertical. a box holds children in a row,
213    // either horizontally or vertically. nothing more.
214    box = elm_box_add(win);
215    // make the box hotizontal
216    elm_box_horizontal_set(box, EINA_TRUE);
217    // add object as a resize object for the window (controls window minimum
218    // size as well as gets resized if window is resized)
219    elm_win_resize_object_add(win, box);
220    evas_object_show(box);
221
222    // add a label widget, set the text and put it in the pad frame
223    lab = elm_label_add(win);
224    // set default text of the label
225    elm_object_text_set(lab, "Hello out there world!");
226    // pack the label at the end of the box
227    elm_box_pack_end(box, lab);
228    evas_object_show(lab);
229
230    // add an ok button
231    btn = elm_button_add(win);
232    // set default text of button to "OK"
233    elm_object_text_set(btn, "OK");
234    // pack the button at the end of the box
235    elm_box_pack_end(box, btn);
236    evas_object_show(btn);
237    // call on_done when button is clicked
238    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239
240    // now we are done, show the window
241    evas_object_show(win);
242
243    // run the mainloop and process events and callbacks
244    elm_run();
245    return 0;
246 }
247 ELM_MAIN()
248 @endcode
249    *
250    */
251
252 /**
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
301 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
302 @author Kim Yunhan <spbear@gmail.com>
303
304 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
305 contact with the developers and maintainers.
306  */
307
308 #ifndef ELEMENTARY_H
309 #define ELEMENTARY_H
310
311 /**
312  * @file Elementary.h
313  * @brief Elementary's API
314  *
315  * Elementary API.
316  */
317
318 @ELM_UNIX_DEF@ ELM_UNIX
319 @ELM_WIN32_DEF@ ELM_WIN32
320 @ELM_WINCE_DEF@ ELM_WINCE
321 @ELM_EDBUS_DEF@ ELM_EDBUS
322 @ELM_EFREET_DEF@ ELM_EFREET
323 @ELM_ETHUMB_DEF@ ELM_ETHUMB
324 @ELM_WEB_DEF@ ELM_WEB
325 @ELM_EMAP_DEF@ ELM_EMAP
326 @ELM_DEBUG_DEF@ ELM_DEBUG
327 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
328 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
329
330 /* Standard headers for standard system calls etc. */
331 #include <stdio.h>
332 #include <stdlib.h>
333 #include <unistd.h>
334 #include <string.h>
335 #include <sys/types.h>
336 #include <sys/stat.h>
337 #include <sys/time.h>
338 #include <sys/param.h>
339 #include <dlfcn.h>
340 #include <math.h>
341 #include <fnmatch.h>
342 #include <limits.h>
343 #include <ctype.h>
344 #include <time.h>
345 #include <dirent.h>
346 #include <pwd.h>
347 #include <errno.h>
348
349 #ifdef ELM_UNIX
350 # include <locale.h>
351 # ifdef ELM_LIBINTL_H
352 #  include <libintl.h>
353 # endif
354 # include <signal.h>
355 # include <grp.h>
356 # include <glob.h>
357 #endif
358
359 #ifdef ELM_ALLOCA_H
360 # include <alloca.h>
361 #endif
362
363 #if defined (ELM_WIN32) || defined (ELM_WINCE)
364 # include <malloc.h>
365 # ifndef alloca
366 #  define alloca _alloca
367 # endif
368 #endif
369
370
371 /* EFL headers */
372 #include <Eina.h>
373 #include <Eet.h>
374 #include <Evas.h>
375 #include <Evas_GL.h>
376 #include <Ecore.h>
377 #include <Ecore_Evas.h>
378 #include <Ecore_File.h>
379 #include <Ecore_IMF.h>
380 #include <Ecore_Con.h>
381 #include <Edje.h>
382
383 #ifdef ELM_EDBUS
384 # include <E_DBus.h>
385 #endif
386
387 #ifdef ELM_EFREET
388 # include <Efreet.h>
389 # include <Efreet_Mime.h>
390 # include <Efreet_Trash.h>
391 #endif
392
393 #ifdef ELM_ETHUMB
394 # include <Ethumb_Client.h>
395 #endif
396
397 #ifdef ELM_EMAP
398 # include <EMap.h>
399 #endif
400
401 #ifdef EAPI
402 # undef EAPI
403 #endif
404
405 #ifdef _WIN32
406 # ifdef ELEMENTARY_BUILD
407 #  ifdef DLL_EXPORT
408 #   define EAPI __declspec(dllexport)
409 #  else
410 #   define EAPI
411 #  endif /* ! DLL_EXPORT */
412 # else
413 #  define EAPI __declspec(dllimport)
414 # endif /* ! EFL_EVAS_BUILD */
415 #else
416 # ifdef __GNUC__
417 #  if __GNUC__ >= 4
418 #   define EAPI __attribute__ ((visibility("default")))
419 #  else
420 #   define EAPI
421 #  endif
422 # else
423 #  define EAPI
424 # endif
425 #endif /* ! _WIN32 */
426
427 #ifdef _WIN32
428 # define EAPI_MAIN
429 #else
430 # define EAPI_MAIN EAPI
431 #endif
432
433 /* allow usage from c++ */
434 #ifdef __cplusplus
435 extern "C" {
436 #endif
437
438 #define ELM_VERSION_MAJOR @VMAJ@
439 #define ELM_VERSION_MINOR @VMIN@
440
441    typedef struct _Elm_Version
442      {
443         int major;
444         int minor;
445         int micro;
446         int revision;
447      } Elm_Version;
448
449    EAPI extern Elm_Version *elm_version;
450
451 /* handy macros */
452 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
453 #define ELM_PI 3.14159265358979323846
454
455    /**
456     * @defgroup General General
457     *
458     * @brief General Elementary API. Functions that don't relate to
459     * Elementary objects specifically.
460     *
461     * Here are documented functions which init/shutdown the library,
462     * that apply to generic Elementary objects, that deal with
463     * configuration, et cetera.
464     *
465     * @ref general_functions_example_page "This" example contemplates
466     * some of these functions.
467     */
468
469    /**
470     * @addtogroup General
471     * @{
472     */
473
474   /**
475    * Defines couple of standard Evas_Object layers to be used
476    * with evas_object_layer_set().
477    *
478    * @note whenever extending with new values, try to keep some padding
479    *       to siblings so there is room for further extensions.
480    */
481   typedef enum _Elm_Object_Layer
482     {
483        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
484        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
485        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
486        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
487        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
488        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
489     } Elm_Object_Layer;
490
491 /**************************************************************************/
492    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
493
494    /**
495     * Emitted when any Elementary's policy value is changed.
496     */
497    EAPI extern int ELM_EVENT_POLICY_CHANGED;
498
499    /**
500     * @typedef Elm_Event_Policy_Changed
501     *
502     * Data on the event when an Elementary policy has changed
503     */
504     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
505
506    /**
507     * @struct _Elm_Event_Policy_Changed
508     *
509     * Data on the event when an Elementary policy has changed
510     */
511     struct _Elm_Event_Policy_Changed
512      {
513         unsigned int policy; /**< the policy identifier */
514         int          new_value; /**< value the policy had before the change */
515         int          old_value; /**< new value the policy got */
516     };
517
518    /**
519     * Policy identifiers.
520     */
521     typedef enum _Elm_Policy
522     {
523         ELM_POLICY_QUIT, /**< under which circumstances the application
524                           * should quit automatically. @see
525                           * Elm_Policy_Quit.
526                           */
527         ELM_POLICY_LAST
528     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
529  */
530
531    typedef enum _Elm_Policy_Quit
532      {
533         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
534                                    * automatically */
535         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
536                                             * application's last
537                                             * window is closed */
538      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
539
540    typedef enum _Elm_Focus_Direction
541      {
542         ELM_FOCUS_PREVIOUS,
543         ELM_FOCUS_NEXT
544      } Elm_Focus_Direction;
545
546    typedef enum _Elm_Text_Format
547      {
548         ELM_TEXT_FORMAT_PLAIN_UTF8,
549         ELM_TEXT_FORMAT_MARKUP_UTF8
550      } Elm_Text_Format;
551
552    /**
553     * Line wrapping types.
554     */
555    typedef enum _Elm_Wrap_Type
556      {
557         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
558         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
559         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
560         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
561         ELM_WRAP_LAST
562      } Elm_Wrap_Type;
563
564    typedef enum
565      {
566         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
567         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
568         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
569         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
570         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
571         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
572         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
573         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
574         ELM_INPUT_PANEL_LAYOUT_INVALID
575      } Elm_Input_Panel_Layout;
576
577    /**
578     * @typedef Elm_Object_Item
579     * An Elementary Object item handle.
580     * @ingroup General
581     */
582    typedef struct _Elm_Object_Item Elm_Object_Item;
583
584
585    /**
586     * Called back when a widget's tooltip is activated and needs content.
587     * @param data user-data given to elm_object_tooltip_content_cb_set()
588     * @param obj owner widget.
589     * @param tooltip The tooltip object (affix content to this!)
590     */
591    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
592
593    /**
594     * Called back when a widget's item tooltip is activated and needs content.
595     * @param data user-data given to elm_object_tooltip_content_cb_set()
596     * @param obj owner widget.
597     * @param tooltip The tooltip object (affix content to this!)
598     * @param item context dependent item. As an example, if tooltip was
599     *        set on Elm_List_Item, then it is of this type.
600     */
601    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
602
603    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. */
604
605 #ifndef ELM_LIB_QUICKLAUNCH
606 #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 */
607 #else
608 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
609 #endif
610
611 /**************************************************************************/
612    /* General calls */
613
614    /**
615     * Initialize Elementary
616     *
617     * @param[in] argc System's argument count value
618     * @param[in] argv System's pointer to array of argument strings
619     * @return The init counter value.
620     *
621     * This function initializes Elementary and increments a counter of
622     * the number of calls to it. It returns the new counter's value.
623     *
624     * @warning This call is exported only for use by the @c ELM_MAIN()
625     * macro. There is no need to use this if you use this macro (which
626     * is highly advisable). An elm_main() should contain the entry
627     * point code for your application, having the same prototype as
628     * elm_init(), and @b not being static (putting the @c EAPI symbol
629     * in front of its type declaration is advisable). The @c
630     * ELM_MAIN() call should be placed just after it.
631     *
632     * Example:
633     * @dontinclude bg_example_01.c
634     * @skip static void
635     * @until ELM_MAIN
636     *
637     * See the full @ref bg_example_01_c "example".
638     *
639     * @see elm_shutdown().
640     * @ingroup General
641     */
642    EAPI int          elm_init(int argc, char **argv);
643
644    /**
645     * Shut down Elementary
646     *
647     * @return The init counter value.
648     *
649     * This should be called at the end of your application, just
650     * before it ceases to do any more processing. This will clean up
651     * any permanent resources your application may have allocated via
652     * Elementary that would otherwise persist.
653     *
654     * @see elm_init() for an example
655     *
656     * @ingroup General
657     */
658    EAPI int          elm_shutdown(void);
659
660    /**
661     * Run Elementary's main loop
662     *
663     * This call should be issued just after all initialization is
664     * completed. This function will not return until elm_exit() is
665     * called. It will keep looping, running the main
666     * (event/processing) loop for Elementary.
667     *
668     * @see elm_init() for an example
669     *
670     * @ingroup General
671     */
672    EAPI void         elm_run(void);
673
674    /**
675     * Exit Elementary's main loop
676     *
677     * If this call is issued, it will flag the main loop to cease
678     * processing and return back to its parent function (usually your
679     * elm_main() function).
680     *
681     * @see elm_init() for an example. There, just after a request to
682     * close the window comes, the main loop will be left.
683     *
684     * @note By using the #ELM_POLICY_QUIT on your Elementary
685     * applications, you'll this function called automatically for you.
686     *
687     * @ingroup General
688     */
689    EAPI void         elm_exit(void);
690
691    /**
692     * Provide information in order to make Elementary determine the @b
693     * run time location of the software in question, so other data files
694     * such as images, sound files, executable utilities, libraries,
695     * modules and locale files can be found.
696     *
697     * @param mainfunc This is your application's main function name,
698     *        whose binary's location is to be found. Providing @c NULL
699     *        will make Elementary not to use it
700     * @param dom This will be used as the application's "domain", in the
701     *        form of a prefix to any environment variables that may
702     *        override prefix detection and the directory name, inside the
703     *        standard share or data directories, where the software's
704     *        data files will be looked for.
705     * @param checkfile This is an (optional) magic file's path to check
706     *        for existence (and it must be located in the data directory,
707     *        under the share directory provided above). Its presence will
708     *        help determine the prefix found was correct. Pass @c NULL if
709     *        the check is not to be done.
710     *
711     * This function allows one to re-locate the application somewhere
712     * else after compilation, if the developer wishes for easier
713     * distribution of pre-compiled binaries.
714     *
715     * The prefix system is designed to locate where the given software is
716     * installed (under a common path prefix) at run time and then report
717     * specific locations of this prefix and common directories inside
718     * this prefix like the binary, library, data and locale directories,
719     * through the @c elm_app_*_get() family of functions.
720     *
721     * Call elm_app_info_set() early on before you change working
722     * directory or anything about @c argv[0], so it gets accurate
723     * information.
724     *
725     * It will then try and trace back which file @p mainfunc comes from,
726     * if provided, to determine the application's prefix directory.
727     *
728     * The @p dom parameter provides a string prefix to prepend before
729     * environment variables, allowing a fallback to @b specific
730     * environment variables to locate the software. You would most
731     * probably provide a lowercase string there, because it will also
732     * serve as directory domain, explained next. For environment
733     * variables purposes, this string is made uppercase. For example if
734     * @c "myapp" is provided as the prefix, then the program would expect
735     * @c "MYAPP_PREFIX" as a master environment variable to specify the
736     * exact install prefix for the software, or more specific environment
737     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
738     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
739     * the user or scripts before launching. If not provided (@c NULL),
740     * environment variables will not be used to override compiled-in
741     * defaults or auto detections.
742     *
743     * The @p dom string also provides a subdirectory inside the system
744     * shared data directory for data files. For example, if the system
745     * directory is @c /usr/local/share, then this directory name is
746     * appended, creating @c /usr/local/share/myapp, if it @p was @c
747     * "myapp". It is expected the application installs data files in
748     * this directory.
749     *
750     * The @p checkfile is a file name or path of something inside the
751     * share or data directory to be used to test that the prefix
752     * detection worked. For example, your app will install a wallpaper
753     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
754     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
755     * checkfile string.
756     *
757     * @see elm_app_compile_bin_dir_set()
758     * @see elm_app_compile_lib_dir_set()
759     * @see elm_app_compile_data_dir_set()
760     * @see elm_app_compile_locale_set()
761     * @see elm_app_prefix_dir_get()
762     * @see elm_app_bin_dir_get()
763     * @see elm_app_lib_dir_get()
764     * @see elm_app_data_dir_get()
765     * @see elm_app_locale_dir_get()
766     */
767    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
768
769    /**
770     * Provide information on the @b fallback application's binaries
771     * directory, on scenarios where they get overriden by
772     * elm_app_info_set().
773     *
774     * @param dir The path to the default binaries directory (compile time
775     * one)
776     *
777     * @note Elementary will as well use this path to determine actual
778     * names of binaries' directory paths, maybe changing it to be @c
779     * something/local/bin instead of @c something/bin, only, for
780     * example.
781     *
782     * @warning You should call this function @b before
783     * elm_app_info_set().
784     */
785    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
786
787    /**
788     * Provide information on the @b fallback application's libraries
789     * directory, on scenarios where they get overriden by
790     * elm_app_info_set().
791     *
792     * @param dir The path to the default libraries directory (compile
793     * time one)
794     *
795     * @note Elementary will as well use this path to determine actual
796     * names of libraries' directory paths, maybe changing it to be @c
797     * something/lib32 or @c something/lib64 instead of @c something/lib,
798     * only, for example.
799     *
800     * @warning You should call this function @b before
801     * elm_app_info_set().
802     */
803    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
804
805    /**
806     * Provide information on the @b fallback application's data
807     * directory, on scenarios where they get overriden by
808     * elm_app_info_set().
809     *
810     * @param dir The path to the default data directory (compile time
811     * one)
812     *
813     * @note Elementary will as well use this path to determine actual
814     * names of data directory paths, maybe changing it to be @c
815     * something/local/share instead of @c something/share, only, for
816     * example.
817     *
818     * @warning You should call this function @b before
819     * elm_app_info_set().
820     */
821    EAPI void         elm_app_compile_data_dir_set(const char *dir);
822
823    /**
824     * Provide information on the @b fallback application's locale
825     * directory, on scenarios where they get overriden by
826     * elm_app_info_set().
827     *
828     * @param dir The path to the default locale directory (compile time
829     * one)
830     *
831     * @warning You should call this function @b before
832     * elm_app_info_set().
833     */
834    EAPI void         elm_app_compile_locale_set(const char *dir);
835
836    /**
837     * Retrieve the application's run time prefix directory, as set by
838     * elm_app_info_set() and the way (environment) the application was
839     * run from.
840     *
841     * @return The directory prefix the application is actually using
842     */
843    EAPI const char  *elm_app_prefix_dir_get(void);
844
845    /**
846     * Retrieve the application's run time binaries prefix directory, as
847     * set by elm_app_info_set() and the way (environment) the application
848     * was run from.
849     *
850     * @return The binaries directory prefix the application is actually
851     * using
852     */
853    EAPI const char  *elm_app_bin_dir_get(void);
854
855    /**
856     * Retrieve the application's run time libraries prefix directory, as
857     * set by elm_app_info_set() and the way (environment) the application
858     * was run from.
859     *
860     * @return The libraries directory prefix the application is actually
861     * using
862     */
863    EAPI const char  *elm_app_lib_dir_get(void);
864
865    /**
866     * Retrieve the application's run time data prefix directory, as
867     * set by elm_app_info_set() and the way (environment) the application
868     * was run from.
869     *
870     * @return The data directory prefix the application is actually
871     * using
872     */
873    EAPI const char  *elm_app_data_dir_get(void);
874
875    /**
876     * Retrieve the application's run time locale prefix directory, as
877     * set by elm_app_info_set() and the way (environment) the application
878     * was run from.
879     *
880     * @return The locale directory prefix the application is actually
881     * using
882     */
883    EAPI const char  *elm_app_locale_dir_get(void);
884
885    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
886    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
887    EAPI int          elm_quicklaunch_init(int argc, char **argv);
888    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
889    EAPI int          elm_quicklaunch_sub_shutdown(void);
890    EAPI int          elm_quicklaunch_shutdown(void);
891    EAPI void         elm_quicklaunch_seed(void);
892    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
893    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
894    EAPI void         elm_quicklaunch_cleanup(void);
895    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
896    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
897
898    EAPI Eina_Bool    elm_need_efreet(void);
899    EAPI Eina_Bool    elm_need_e_dbus(void);
900
901    /**
902     * This must be called before any other function that handle with
903     * elm_thumb objects or ethumb_client instances.
904     *
905     * @ingroup Thumb
906     */
907    EAPI Eina_Bool    elm_need_ethumb(void);
908
909    /**
910     * This must be called before any other function that handle with
911     * elm_web objects or ewk_view instances.
912     *
913     * @ingroup Web
914     */
915    EAPI Eina_Bool    elm_need_web(void);
916
917    /**
918     * Set a new policy's value (for a given policy group/identifier).
919     *
920     * @param policy policy identifier, as in @ref Elm_Policy.
921     * @param value policy value, which depends on the identifier
922     *
923     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
924     *
925     * Elementary policies define applications' behavior,
926     * somehow. These behaviors are divided in policy groups (see
927     * #Elm_Policy enumeration). This call will emit the Ecore event
928     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
929     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
930     * then.
931     *
932     * @note Currently, we have only one policy identifier/group
933     * (#ELM_POLICY_QUIT), which has two possible values.
934     *
935     * @ingroup General
936     */
937    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
938
939    /**
940     * Gets the policy value set for given policy identifier.
941     *
942     * @param policy policy identifier, as in #Elm_Policy.
943     * @return The currently set policy value, for that
944     * identifier. Will be @c 0 if @p policy passed is invalid.
945     *
946     * @ingroup General
947     */
948    EAPI int          elm_policy_get(unsigned int policy);
949
950    /**
951     * Set a label of an object
952     *
953     * @param obj The Elementary object
954     * @param part The text part name to set (NULL for the default label)
955     * @param label The new text of the label
956     *
957     * @note Elementary objects may have many labels (e.g. Action Slider)
958     *
959     * @ingroup General
960     */
961    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
962
963 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
964
965    /**
966     * Get a label of an object
967     *
968     * @param obj The Elementary object
969     * @param part The text part name to get (NULL for the default label)
970     * @return text of the label or NULL for any error
971     *
972     * @note Elementary objects may have many labels (e.g. Action Slider)
973     *
974     * @ingroup General
975     */
976    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
977
978 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
979
980    /**
981     * Set a content of an object
982     *
983     * @param obj The Elementary object
984     * @param part The content part name to set (NULL for the default content)
985     * @param content The new content of the object
986     *
987     * @note Elementary objects may have many contents
988     *
989     * @ingroup General
990     */
991    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
992
993 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
994
995    /**
996     * Get a content of an object
997     *
998     * @param obj The Elementary object
999     * @param item The content part name to get (NULL for the default content)
1000     * @return content of the object or NULL for any error
1001     *
1002     * @note Elementary objects may have many contents
1003     *
1004     * @ingroup General
1005     */
1006    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1007
1008 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1009
1010    /**
1011     * Unset a content of an object
1012     *
1013     * @param obj The Elementary object
1014     * @param item The content part name to unset (NULL for the default content)
1015     *
1016     * @note Elementary objects may have many contents
1017     *
1018     * @ingroup General
1019     */
1020    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1021
1022 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1023
1024    /**
1025     * Get the wiget object's handle which contains a given item
1026     *
1027     * @param item The Elementary object item 
1028     * @return The widget object
1029     *
1030     * @note This returns the widget object itself that an item belongs to.
1031     *
1032     * @ingroup General
1033     */
1034    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1035
1036    /**
1037     * Set a content of an object item
1038     *
1039     * @param it The Elementary object item
1040     * @param part The content part name to set (NULL for the default content)
1041     * @param content The new content of the object item
1042     *
1043     * @note Elementary object items may have many contents
1044     *
1045     * @ingroup General
1046     */
1047    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1048
1049 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1050
1051    /**
1052     * Get a content of an object item
1053     *
1054     * @param it The Elementary object item
1055     * @param part The content part name to unset (NULL for the default content)
1056     * @return content of the object item or NULL for any error
1057     *
1058     * @note Elementary object items may have many contents
1059     *
1060     * @ingroup General
1061     */
1062    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1063
1064 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1065
1066    /**
1067     * Unset a content of an object item
1068     *
1069     * @param it The Elementary object item
1070     * @param part The content part name to unset (NULL for the default content)
1071     *
1072     * @note Elementary object items may have many contents
1073     *
1074     * @ingroup General
1075     */
1076    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1077
1078 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1079
1080    /**
1081     * Set a label of an object item
1082     *
1083     * @param it The Elementary object item
1084     * @param part The text part name to set (NULL for the default label)
1085     * @param label The new text of the label
1086     *
1087     * @note Elementary object items may have many labels
1088     *
1089     * @ingroup General
1090     */
1091    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1092
1093 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1094
1095    /**
1096     * Get a label of an object
1097     *
1098     * @param it The Elementary object item
1099     * @param part The text part name to get (NULL for the default label)
1100     * @return text of the label or NULL for any error
1101     *
1102     * @note Elementary object items may have many labels
1103     *
1104     * @ingroup General
1105     */
1106    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1107
1108 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1109
1110    /**
1111     * Set the text to read out when in accessibility mode
1112     *
1113     * @param obj The object which is to be described
1114     * @param txt The text that describes the widget to people with poor or no vision
1115     *
1116     * @ingroup General
1117     */
1118    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1119
1120    /**
1121     * Set the text to read out when in accessibility mode
1122     *
1123     * @param it The object item which is to be described
1124     * @param txt The text that describes the widget to people with poor or no vision
1125     *
1126     * @ingroup General
1127     */
1128    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1129
1130    /**
1131     * Get the data associated with an object item
1132     * @param it The object item
1133     * @return The data associated with @p it
1134     *
1135     * @ingroup General
1136     */
1137    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1138
1139    /**
1140     * Set the data associated with an object item
1141     * @param it The object item
1142     * @param data The data to be associated with @p it
1143     *
1144     * @ingroup General
1145     */
1146    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1147
1148    /**
1149     * Send a signal to the edje object of the widget item.
1150     *
1151     * This function sends a signal to the edje object of the obj item. An
1152     * edje program can respond to a signal by specifying matching
1153     * 'signal' and 'source' fields.
1154     *
1155     * @param it The Elementary object item
1156     * @param emission The signal's name.
1157     * @param source The signal's source.
1158     * @ingroup General
1159     */
1160    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1161
1162    /**
1163     * @}
1164     */
1165
1166    /**
1167     * @defgroup Caches Caches
1168     *
1169     * These are functions which let one fine-tune some cache values for
1170     * Elementary applications, thus allowing for performance adjustments.
1171     *
1172     * @{
1173     */
1174
1175    /**
1176     * @brief Flush all caches.
1177     *
1178     * Frees all data that was in cache and is not currently being used to reduce
1179     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1180     * to calling all of the following functions:
1181     * @li edje_file_cache_flush()
1182     * @li edje_collection_cache_flush()
1183     * @li eet_clearcache()
1184     * @li evas_image_cache_flush()
1185     * @li evas_font_cache_flush()
1186     * @li evas_render_dump()
1187     * @note Evas caches are flushed for every canvas associated with a window.
1188     *
1189     * @ingroup Caches
1190     */
1191    EAPI void         elm_all_flush(void);
1192
1193    /**
1194     * Get the configured cache flush interval time
1195     *
1196     * This gets the globally configured cache flush interval time, in
1197     * ticks
1198     *
1199     * @return The cache flush interval time
1200     * @ingroup Caches
1201     *
1202     * @see elm_all_flush()
1203     */
1204    EAPI int          elm_cache_flush_interval_get(void);
1205
1206    /**
1207     * Set the configured cache flush interval time
1208     *
1209     * This sets the globally configured cache flush interval time, in ticks
1210     *
1211     * @param size The cache flush interval time
1212     * @ingroup Caches
1213     *
1214     * @see elm_all_flush()
1215     */
1216    EAPI void         elm_cache_flush_interval_set(int size);
1217
1218    /**
1219     * Set the configured cache flush interval time for all applications on the
1220     * display
1221     *
1222     * This sets the globally configured cache flush interval time -- in ticks
1223     * -- for all applications on the display.
1224     *
1225     * @param size The cache flush interval time
1226     * @ingroup Caches
1227     */
1228    EAPI void         elm_cache_flush_interval_all_set(int size);
1229
1230    /**
1231     * Get the configured cache flush enabled state
1232     *
1233     * This gets the globally configured cache flush state - if it is enabled
1234     * or not. When cache flushing is enabled, elementary will regularly
1235     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1236     * memory and allow usage to re-seed caches and data in memory where it
1237     * can do so. An idle application will thus minimise its memory usage as
1238     * data will be freed from memory and not be re-loaded as it is idle and
1239     * not rendering or doing anything graphically right now.
1240     *
1241     * @return The cache flush state
1242     * @ingroup Caches
1243     *
1244     * @see elm_all_flush()
1245     */
1246    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1247
1248    /**
1249     * Set the configured cache flush enabled state
1250     *
1251     * This sets the globally configured cache flush enabled state
1252     *
1253     * @param size The cache flush enabled state
1254     * @ingroup Caches
1255     *
1256     * @see elm_all_flush()
1257     */
1258    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1259
1260    /**
1261     * Set the configured cache flush enabled state for all applications on the
1262     * display
1263     *
1264     * This sets the globally configured cache flush enabled state for all
1265     * applications on the display.
1266     *
1267     * @param size The cache flush enabled state
1268     * @ingroup Caches
1269     */
1270    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1271
1272    /**
1273     * Get the configured font cache size
1274     *
1275     * This gets the globally configured font cache size, in bytes
1276     *
1277     * @return The font cache size
1278     * @ingroup Caches
1279     */
1280    EAPI int          elm_font_cache_get(void);
1281
1282    /**
1283     * Set the configured font cache size
1284     *
1285     * This sets the globally configured font cache size, in bytes
1286     *
1287     * @param size The font cache size
1288     * @ingroup Caches
1289     */
1290    EAPI void         elm_font_cache_set(int size);
1291
1292    /**
1293     * Set the configured font cache size for all applications on the
1294     * display
1295     *
1296     * This sets the globally configured font cache size -- in bytes
1297     * -- for all applications on the display.
1298     *
1299     * @param size The font cache size
1300     * @ingroup Caches
1301     */
1302    EAPI void         elm_font_cache_all_set(int size);
1303
1304    /**
1305     * Get the configured image cache size
1306     *
1307     * This gets the globally configured image cache size, in bytes
1308     *
1309     * @return The image cache size
1310     * @ingroup Caches
1311     */
1312    EAPI int          elm_image_cache_get(void);
1313
1314    /**
1315     * Set the configured image cache size
1316     *
1317     * This sets the globally configured image cache size, in bytes
1318     *
1319     * @param size The image cache size
1320     * @ingroup Caches
1321     */
1322    EAPI void         elm_image_cache_set(int size);
1323
1324    /**
1325     * Set the configured image cache size for all applications on the
1326     * display
1327     *
1328     * This sets the globally configured image cache size -- in bytes
1329     * -- for all applications on the display.
1330     *
1331     * @param size The image cache size
1332     * @ingroup Caches
1333     */
1334    EAPI void         elm_image_cache_all_set(int size);
1335
1336    /**
1337     * Get the configured edje file cache size.
1338     *
1339     * This gets the globally configured edje file cache size, in number
1340     * of files.
1341     *
1342     * @return The edje file cache size
1343     * @ingroup Caches
1344     */
1345    EAPI int          elm_edje_file_cache_get(void);
1346
1347    /**
1348     * Set the configured edje file cache size
1349     *
1350     * This sets the globally configured edje file cache size, in number
1351     * of files.
1352     *
1353     * @param size The edje file cache size
1354     * @ingroup Caches
1355     */
1356    EAPI void         elm_edje_file_cache_set(int size);
1357
1358    /**
1359     * Set the configured edje file cache size for all applications on the
1360     * display
1361     *
1362     * This sets the globally configured edje file cache size -- in number
1363     * of files -- for all applications on the display.
1364     *
1365     * @param size The edje file cache size
1366     * @ingroup Caches
1367     */
1368    EAPI void         elm_edje_file_cache_all_set(int size);
1369
1370    /**
1371     * Get the configured edje collections (groups) cache size.
1372     *
1373     * This gets the globally configured edje collections cache size, in
1374     * number of collections.
1375     *
1376     * @return The edje collections cache size
1377     * @ingroup Caches
1378     */
1379    EAPI int          elm_edje_collection_cache_get(void);
1380
1381    /**
1382     * Set the configured edje collections (groups) cache size
1383     *
1384     * This sets the globally configured edje collections cache size, in
1385     * number of collections.
1386     *
1387     * @param size The edje collections cache size
1388     * @ingroup Caches
1389     */
1390    EAPI void         elm_edje_collection_cache_set(int size);
1391
1392    /**
1393     * Set the configured edje collections (groups) cache size for all
1394     * applications on the display
1395     *
1396     * This sets the globally configured edje collections cache size -- in
1397     * number of collections -- for all applications on the display.
1398     *
1399     * @param size The edje collections cache size
1400     * @ingroup Caches
1401     */
1402    EAPI void         elm_edje_collection_cache_all_set(int size);
1403
1404    /**
1405     * @}
1406     */
1407
1408    /**
1409     * @defgroup Scaling Widget Scaling
1410     *
1411     * Different widgets can be scaled independently. These functions
1412     * allow you to manipulate this scaling on a per-widget basis. The
1413     * object and all its children get their scaling factors multiplied
1414     * by the scale factor set. This is multiplicative, in that if a
1415     * child also has a scale size set it is in turn multiplied by its
1416     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1417     * double size, @c 0.5 is half, etc.
1418     *
1419     * @ref general_functions_example_page "This" example contemplates
1420     * some of these functions.
1421     */
1422
1423    /**
1424     * Get the global scaling factor
1425     *
1426     * This gets the globally configured scaling factor that is applied to all
1427     * objects.
1428     *
1429     * @return The scaling factor
1430     * @ingroup Scaling
1431     */
1432    EAPI double       elm_scale_get(void);
1433
1434    /**
1435     * Set the global scaling factor
1436     *
1437     * This sets the globally configured scaling factor that is applied to all
1438     * objects.
1439     *
1440     * @param scale The scaling factor to set
1441     * @ingroup Scaling
1442     */
1443    EAPI void         elm_scale_set(double scale);
1444
1445    /**
1446     * Set the global scaling factor for all applications on the display
1447     *
1448     * This sets the globally configured scaling factor that is applied to all
1449     * objects for all applications.
1450     * @param scale The scaling factor to set
1451     * @ingroup Scaling
1452     */
1453    EAPI void         elm_scale_all_set(double scale);
1454
1455    /**
1456     * Set the scaling factor for a given Elementary object
1457     *
1458     * @param obj The Elementary to operate on
1459     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1460     * no scaling)
1461     *
1462     * @ingroup Scaling
1463     */
1464    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1465
1466    /**
1467     * Get the scaling factor for a given Elementary object
1468     *
1469     * @param obj The object
1470     * @return The scaling factor set by elm_object_scale_set()
1471     *
1472     * @ingroup Scaling
1473     */
1474    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1475
1476    /**
1477     * @defgroup Password_last_show Password last input show
1478     *
1479     * Last show feature of password mode enables user to view
1480     * the last input entered for few seconds before masking it.
1481     * These functions allow to set this feature in password mode
1482     * of entry widget and also allow to manipulate the duration
1483     * for which the input has to be visible.
1484     *
1485     * @{
1486     */
1487
1488    /**
1489     * Get show last setting of password mode.
1490     *
1491     * This gets the show last input setting of password mode which might be
1492     * enabled or disabled.
1493     *
1494     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1495     *            if it's disabled.
1496     * @ingroup Password_last_show
1497     */
1498    EAPI Eina_Bool elm_password_show_last_get(void);
1499
1500    /**
1501     * Set show last setting in password mode.
1502     *
1503     * This enables or disables show last setting of password mode.
1504     *
1505     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1506     * @see elm_password_show_last_timeout_set()
1507     * @ingroup Password_last_show
1508     */
1509    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1510
1511    /**
1512     * Get's the timeout value in last show password mode.
1513     *
1514     * This gets the time out value for which the last input entered in password
1515     * mode will be visible.
1516     *
1517     * @return The timeout value of last show password mode.
1518     * @ingroup Password_last_show
1519     */
1520    EAPI double elm_password_show_last_timeout_get(void);
1521
1522    /**
1523     * Set's the timeout value in last show password mode.
1524     *
1525     * This sets the time out value for which the last input entered in password
1526     * mode will be visible.
1527     *
1528     * @param password_show_last_timeout The timeout value.
1529     * @see elm_password_show_last_set()
1530     * @ingroup Password_last_show
1531     */
1532    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1533
1534    /**
1535     * @}
1536     */
1537
1538    /**
1539     * @defgroup UI-Mirroring Selective Widget mirroring
1540     *
1541     * These functions allow you to set ui-mirroring on specific
1542     * widgets or the whole interface. Widgets can be in one of two
1543     * modes, automatic and manual.  Automatic means they'll be changed
1544     * according to the system mirroring mode and manual means only
1545     * explicit changes will matter. You are not supposed to change
1546     * mirroring state of a widget set to automatic, will mostly work,
1547     * but the behavior is not really defined.
1548     *
1549     * @{
1550     */
1551
1552    EAPI Eina_Bool    elm_mirrored_get(void);
1553    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1554
1555    /**
1556     * Get the system mirrored mode. This determines the default mirrored mode
1557     * of widgets.
1558     *
1559     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1560     */
1561    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1562
1563    /**
1564     * Set the system mirrored mode. This determines the default mirrored mode
1565     * of widgets.
1566     *
1567     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1568     */
1569    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1570
1571    /**
1572     * Returns the widget's mirrored mode setting.
1573     *
1574     * @param obj The widget.
1575     * @return mirrored mode setting of the object.
1576     *
1577     **/
1578    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579
1580    /**
1581     * Sets the widget's mirrored mode setting.
1582     * When widget in automatic mode, it follows the system mirrored mode set by
1583     * elm_mirrored_set().
1584     * @param obj The widget.
1585     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1586     */
1587    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1588
1589    /**
1590     * @}
1591     */
1592
1593    /**
1594     * Set the style to use by a widget
1595     *
1596     * Sets the style name that will define the appearance of a widget. Styles
1597     * vary from widget to widget and may also be defined by other themes
1598     * by means of extensions and overlays.
1599     *
1600     * @param obj The Elementary widget to style
1601     * @param style The style name to use
1602     *
1603     * @see elm_theme_extension_add()
1604     * @see elm_theme_extension_del()
1605     * @see elm_theme_overlay_add()
1606     * @see elm_theme_overlay_del()
1607     *
1608     * @ingroup Styles
1609     */
1610    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1611    /**
1612     * Get the style used by the widget
1613     *
1614     * This gets the style being used for that widget. Note that the string
1615     * pointer is only valid as longas the object is valid and the style doesn't
1616     * change.
1617     *
1618     * @param obj The Elementary widget to query for its style
1619     * @return The style name used
1620     *
1621     * @see elm_object_style_set()
1622     *
1623     * @ingroup Styles
1624     */
1625    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1626
1627    /**
1628     * @defgroup Styles Styles
1629     *
1630     * Widgets can have different styles of look. These generic API's
1631     * set styles of widgets, if they support them (and if the theme(s)
1632     * do).
1633     *
1634     * @ref general_functions_example_page "This" example contemplates
1635     * some of these functions.
1636     */
1637
1638    /**
1639     * Set the disabled state of an Elementary object.
1640     *
1641     * @param obj The Elementary object to operate on
1642     * @param disabled The state to put in in: @c EINA_TRUE for
1643     *        disabled, @c EINA_FALSE for enabled
1644     *
1645     * Elementary objects can be @b disabled, in which state they won't
1646     * receive input and, in general, will be themed differently from
1647     * their normal state, usually greyed out. Useful for contexts
1648     * where you don't want your users to interact with some of the
1649     * parts of you interface.
1650     *
1651     * This sets the state for the widget, either disabling it or
1652     * enabling it back.
1653     *
1654     * @ingroup Styles
1655     */
1656    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1657
1658    /**
1659     * Get the disabled state of an Elementary object.
1660     *
1661     * @param obj The Elementary object to operate on
1662     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1663     *            if it's enabled (or on errors)
1664     *
1665     * This gets the state of the widget, which might be enabled or disabled.
1666     *
1667     * @ingroup Styles
1668     */
1669    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1670
1671    /**
1672     * @defgroup WidgetNavigation Widget Tree Navigation.
1673     *
1674     * How to check if an Evas Object is an Elementary widget? How to
1675     * get the first elementary widget that is parent of the given
1676     * object?  These are all covered in widget tree navigation.
1677     *
1678     * @ref general_functions_example_page "This" example contemplates
1679     * some of these functions.
1680     */
1681
1682    /**
1683     * Check if the given Evas Object is an Elementary widget.
1684     *
1685     * @param obj the object to query.
1686     * @return @c EINA_TRUE if it is an elementary widget variant,
1687     *         @c EINA_FALSE otherwise
1688     * @ingroup WidgetNavigation
1689     */
1690    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1691
1692    /**
1693     * Get the first parent of the given object that is an Elementary
1694     * widget.
1695     *
1696     * @param obj the Elementary object to query parent from.
1697     * @return the parent object that is an Elementary widget, or @c
1698     *         NULL, if it was not found.
1699     *
1700     * Use this to query for an object's parent widget.
1701     *
1702     * @note Most of Elementary users wouldn't be mixing non-Elementary
1703     * smart objects in the objects tree of an application, as this is
1704     * an advanced usage of Elementary with Evas. So, except for the
1705     * application's window, which is the root of that tree, all other
1706     * objects would have valid Elementary widget parents.
1707     *
1708     * @ingroup WidgetNavigation
1709     */
1710    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1711
1712    /**
1713     * Get the top level parent of an Elementary widget.
1714     *
1715     * @param obj The object to query.
1716     * @return The top level Elementary widget, or @c NULL if parent cannot be
1717     * found.
1718     * @ingroup WidgetNavigation
1719     */
1720    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1721
1722    /**
1723     * Get the string that represents this Elementary widget.
1724     *
1725     * @note Elementary is weird and exposes itself as a single
1726     *       Evas_Object_Smart_Class of type "elm_widget", so
1727     *       evas_object_type_get() always return that, making debug and
1728     *       language bindings hard. This function tries to mitigate this
1729     *       problem, but the solution is to change Elementary to use
1730     *       proper inheritance.
1731     *
1732     * @param obj the object to query.
1733     * @return Elementary widget name, or @c NULL if not a valid widget.
1734     * @ingroup WidgetNavigation
1735     */
1736    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1737
1738    /**
1739     * @defgroup Config Elementary Config
1740     *
1741     * Elementary configuration is formed by a set options bounded to a
1742     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1743     * "finger size", etc. These are functions with which one syncronizes
1744     * changes made to those values to the configuration storing files, de
1745     * facto. You most probably don't want to use the functions in this
1746     * group unlees you're writing an elementary configuration manager.
1747     *
1748     * @{
1749     */
1750
1751    /**
1752     * Save back Elementary's configuration, so that it will persist on
1753     * future sessions.
1754     *
1755     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1756     * @ingroup Config
1757     *
1758     * This function will take effect -- thus, do I/O -- immediately. Use
1759     * it when you want to apply all configuration changes at once. The
1760     * current configuration set will get saved onto the current profile
1761     * configuration file.
1762     *
1763     */
1764    EAPI Eina_Bool    elm_config_save(void);
1765
1766    /**
1767     * Reload Elementary's configuration, bounded to current selected
1768     * profile.
1769     *
1770     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1771     * @ingroup Config
1772     *
1773     * Useful when you want to force reloading of configuration values for
1774     * a profile. If one removes user custom configuration directories,
1775     * for example, it will force a reload with system values insted.
1776     *
1777     */
1778    EAPI void         elm_config_reload(void);
1779
1780    /**
1781     * @}
1782     */
1783
1784    /**
1785     * @defgroup Profile Elementary Profile
1786     *
1787     * Profiles are pre-set options that affect the whole look-and-feel of
1788     * Elementary-based applications. There are, for example, profiles
1789     * aimed at desktop computer applications and others aimed at mobile,
1790     * touchscreen-based ones. You most probably don't want to use the
1791     * functions in this group unlees you're writing an elementary
1792     * configuration manager.
1793     *
1794     * @{
1795     */
1796
1797    /**
1798     * Get Elementary's profile in use.
1799     *
1800     * This gets the global profile that is applied to all Elementary
1801     * applications.
1802     *
1803     * @return The profile's name
1804     * @ingroup Profile
1805     */
1806    EAPI const char  *elm_profile_current_get(void);
1807
1808    /**
1809     * Get an Elementary's profile directory path in the filesystem. One
1810     * may want to fetch a system profile's dir or an user one (fetched
1811     * inside $HOME).
1812     *
1813     * @param profile The profile's name
1814     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1815     *                or a system one (@c EINA_FALSE)
1816     * @return The profile's directory path.
1817     * @ingroup Profile
1818     *
1819     * @note You must free it with elm_profile_dir_free().
1820     */
1821    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1822
1823    /**
1824     * Free an Elementary's profile directory path, as returned by
1825     * elm_profile_dir_get().
1826     *
1827     * @param p_dir The profile's path
1828     * @ingroup Profile
1829     *
1830     */
1831    EAPI void         elm_profile_dir_free(const char *p_dir);
1832
1833    /**
1834     * Get Elementary's list of available profiles.
1835     *
1836     * @return The profiles list. List node data are the profile name
1837     *         strings.
1838     * @ingroup Profile
1839     *
1840     * @note One must free this list, after usage, with the function
1841     *       elm_profile_list_free().
1842     */
1843    EAPI Eina_List   *elm_profile_list_get(void);
1844
1845    /**
1846     * Free Elementary's list of available profiles.
1847     *
1848     * @param l The profiles list, as returned by elm_profile_list_get().
1849     * @ingroup Profile
1850     *
1851     */
1852    EAPI void         elm_profile_list_free(Eina_List *l);
1853
1854    /**
1855     * Set Elementary's profile.
1856     *
1857     * This sets the global profile that is applied to Elementary
1858     * applications. Just the process the call comes from will be
1859     * affected.
1860     *
1861     * @param profile The profile's name
1862     * @ingroup Profile
1863     *
1864     */
1865    EAPI void         elm_profile_set(const char *profile);
1866
1867    /**
1868     * Set Elementary's profile.
1869     *
1870     * This sets the global profile that is applied to all Elementary
1871     * applications. All running Elementary windows will be affected.
1872     *
1873     * @param profile The profile's name
1874     * @ingroup Profile
1875     *
1876     */
1877    EAPI void         elm_profile_all_set(const char *profile);
1878
1879    /**
1880     * @}
1881     */
1882
1883    /**
1884     * @defgroup Engine Elementary Engine
1885     *
1886     * These are functions setting and querying which rendering engine
1887     * Elementary will use for drawing its windows' pixels.
1888     *
1889     * The following are the available engines:
1890     * @li "software_x11"
1891     * @li "fb"
1892     * @li "directfb"
1893     * @li "software_16_x11"
1894     * @li "software_8_x11"
1895     * @li "xrender_x11"
1896     * @li "opengl_x11"
1897     * @li "software_gdi"
1898     * @li "software_16_wince_gdi"
1899     * @li "sdl"
1900     * @li "software_16_sdl"
1901     * @li "opengl_sdl"
1902     * @li "buffer"
1903     * @li "ews"
1904     *
1905     * @{
1906     */
1907
1908    /**
1909     * @brief Get Elementary's rendering engine in use.
1910     *
1911     * @return The rendering engine's name
1912     * @note there's no need to free the returned string, here.
1913     *
1914     * This gets the global rendering engine that is applied to all Elementary
1915     * applications.
1916     *
1917     * @see elm_engine_set()
1918     */
1919    EAPI const char  *elm_engine_current_get(void);
1920
1921    /**
1922     * @brief Set Elementary's rendering engine for use.
1923     *
1924     * @param engine The rendering engine's name
1925     *
1926     * This sets global rendering engine that is applied to all Elementary
1927     * applications. Note that it will take effect only to Elementary windows
1928     * created after this is called.
1929     *
1930     * @see elm_win_add()
1931     */
1932    EAPI void         elm_engine_set(const char *engine);
1933
1934    /**
1935     * @}
1936     */
1937
1938    /**
1939     * @defgroup Fonts Elementary Fonts
1940     *
1941     * These are functions dealing with font rendering, selection and the
1942     * like for Elementary applications. One might fetch which system
1943     * fonts are there to use and set custom fonts for individual classes
1944     * of UI items containing text (text classes).
1945     *
1946     * @{
1947     */
1948
1949   typedef struct _Elm_Text_Class
1950     {
1951        const char *name;
1952        const char *desc;
1953     } Elm_Text_Class;
1954
1955   typedef struct _Elm_Font_Overlay
1956     {
1957        const char     *text_class;
1958        const char     *font;
1959        Evas_Font_Size  size;
1960     } Elm_Font_Overlay;
1961
1962   typedef struct _Elm_Font_Properties
1963     {
1964        const char *name;
1965        Eina_List  *styles;
1966     } Elm_Font_Properties;
1967
1968    /**
1969     * Get Elementary's list of supported text classes.
1970     *
1971     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1972     * @ingroup Fonts
1973     *
1974     * Release the list with elm_text_classes_list_free().
1975     */
1976    EAPI const Eina_List     *elm_text_classes_list_get(void);
1977
1978    /**
1979     * Free Elementary's list of supported text classes.
1980     *
1981     * @ingroup Fonts
1982     *
1983     * @see elm_text_classes_list_get().
1984     */
1985    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1986
1987    /**
1988     * Get Elementary's list of font overlays, set with
1989     * elm_font_overlay_set().
1990     *
1991     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1992     * data.
1993     *
1994     * @ingroup Fonts
1995     *
1996     * For each text class, one can set a <b>font overlay</b> for it,
1997     * overriding the default font properties for that class coming from
1998     * the theme in use. There is no need to free this list.
1999     *
2000     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2001     */
2002    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2003
2004    /**
2005     * Set a font overlay for a given Elementary text class.
2006     *
2007     * @param text_class Text class name
2008     * @param font Font name and style string
2009     * @param size Font size
2010     *
2011     * @ingroup Fonts
2012     *
2013     * @p font has to be in the format returned by
2014     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2015     * and elm_font_overlay_unset().
2016     */
2017    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2018
2019    /**
2020     * Unset a font overlay for a given Elementary text class.
2021     *
2022     * @param text_class Text class name
2023     *
2024     * @ingroup Fonts
2025     *
2026     * This will bring back text elements belonging to text class
2027     * @p text_class back to their default font settings.
2028     */
2029    EAPI void                 elm_font_overlay_unset(const char *text_class);
2030
2031    /**
2032     * Apply the changes made with elm_font_overlay_set() and
2033     * elm_font_overlay_unset() on the current Elementary window.
2034     *
2035     * @ingroup Fonts
2036     *
2037     * This applies all font overlays set to all objects in the UI.
2038     */
2039    EAPI void                 elm_font_overlay_apply(void);
2040
2041    /**
2042     * Apply the changes made with elm_font_overlay_set() and
2043     * elm_font_overlay_unset() on all Elementary application windows.
2044     *
2045     * @ingroup Fonts
2046     *
2047     * This applies all font overlays set to all objects in the UI.
2048     */
2049    EAPI void                 elm_font_overlay_all_apply(void);
2050
2051    /**
2052     * Translate a font (family) name string in fontconfig's font names
2053     * syntax into an @c Elm_Font_Properties struct.
2054     *
2055     * @param font The font name and styles string
2056     * @return the font properties struct
2057     *
2058     * @ingroup Fonts
2059     *
2060     * @note The reverse translation can be achived with
2061     * elm_font_fontconfig_name_get(), for one style only (single font
2062     * instance, not family).
2063     */
2064    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2065
2066    /**
2067     * Free font properties return by elm_font_properties_get().
2068     *
2069     * @param efp the font properties struct
2070     *
2071     * @ingroup Fonts
2072     */
2073    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2074
2075    /**
2076     * Translate a font name, bound to a style, into fontconfig's font names
2077     * syntax.
2078     *
2079     * @param name The font (family) name
2080     * @param style The given style (may be @c NULL)
2081     *
2082     * @return the font name and style string
2083     *
2084     * @ingroup Fonts
2085     *
2086     * @note The reverse translation can be achived with
2087     * elm_font_properties_get(), for one style only (single font
2088     * instance, not family).
2089     */
2090    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2091
2092    /**
2093     * Free the font string return by elm_font_fontconfig_name_get().
2094     *
2095     * @param efp the font properties struct
2096     *
2097     * @ingroup Fonts
2098     */
2099    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2100
2101    /**
2102     * Create a font hash table of available system fonts.
2103     *
2104     * One must call it with @p list being the return value of
2105     * evas_font_available_list(). The hash will be indexed by font
2106     * (family) names, being its values @c Elm_Font_Properties blobs.
2107     *
2108     * @param list The list of available system fonts, as returned by
2109     * evas_font_available_list().
2110     * @return the font hash.
2111     *
2112     * @ingroup Fonts
2113     *
2114     * @note The user is supposed to get it populated at least with 3
2115     * default font families (Sans, Serif, Monospace), which should be
2116     * present on most systems.
2117     */
2118    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2119
2120    /**
2121     * Free the hash return by elm_font_available_hash_add().
2122     *
2123     * @param hash the hash to be freed.
2124     *
2125     * @ingroup Fonts
2126     */
2127    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2128
2129    /**
2130     * @}
2131     */
2132
2133    /**
2134     * @defgroup Fingers Fingers
2135     *
2136     * Elementary is designed to be finger-friendly for touchscreens,
2137     * and so in addition to scaling for display resolution, it can
2138     * also scale based on finger "resolution" (or size). You can then
2139     * customize the granularity of the areas meant to receive clicks
2140     * on touchscreens.
2141     *
2142     * Different profiles may have pre-set values for finger sizes.
2143     *
2144     * @ref general_functions_example_page "This" example contemplates
2145     * some of these functions.
2146     *
2147     * @{
2148     */
2149
2150    /**
2151     * Get the configured "finger size"
2152     *
2153     * @return The finger size
2154     *
2155     * This gets the globally configured finger size, <b>in pixels</b>
2156     *
2157     * @ingroup Fingers
2158     */
2159    EAPI Evas_Coord       elm_finger_size_get(void);
2160
2161    /**
2162     * Set the configured finger size
2163     *
2164     * This sets the globally configured finger size in pixels
2165     *
2166     * @param size The finger size
2167     * @ingroup Fingers
2168     */
2169    EAPI void             elm_finger_size_set(Evas_Coord size);
2170
2171    /**
2172     * Set the configured finger size for all applications on the display
2173     *
2174     * This sets the globally configured finger size in pixels for all
2175     * applications on the display
2176     *
2177     * @param size The finger size
2178     * @ingroup Fingers
2179     */
2180    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2181
2182    /**
2183     * @}
2184     */
2185
2186    /**
2187     * @defgroup Focus Focus
2188     *
2189     * An Elementary application has, at all times, one (and only one)
2190     * @b focused object. This is what determines where the input
2191     * events go to within the application's window. Also, focused
2192     * objects can be decorated differently, in order to signal to the
2193     * user where the input is, at a given moment.
2194     *
2195     * Elementary applications also have the concept of <b>focus
2196     * chain</b>: one can cycle through all the windows' focusable
2197     * objects by input (tab key) or programmatically. The default
2198     * focus chain for an application is the one define by the order in
2199     * which the widgets where added in code. One will cycle through
2200     * top level widgets, and, for each one containg sub-objects, cycle
2201     * through them all, before returning to the level
2202     * above. Elementary also allows one to set @b custom focus chains
2203     * for their applications.
2204     *
2205     * Besides the focused decoration a widget may exhibit, when it
2206     * gets focus, Elementary has a @b global focus highlight object
2207     * that can be enabled for a window. If one chooses to do so, this
2208     * extra highlight effect will surround the current focused object,
2209     * too.
2210     *
2211     * @note Some Elementary widgets are @b unfocusable, after
2212     * creation, by their very nature: they are not meant to be
2213     * interacted with input events, but are there just for visual
2214     * purposes.
2215     *
2216     * @ref general_functions_example_page "This" example contemplates
2217     * some of these functions.
2218     */
2219
2220    /**
2221     * Get the enable status of the focus highlight
2222     *
2223     * This gets whether the highlight on focused objects is enabled or not
2224     * @ingroup Focus
2225     */
2226    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2227
2228    /**
2229     * Set the enable status of the focus highlight
2230     *
2231     * Set whether to show or not the highlight on focused objects
2232     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2233     * @ingroup Focus
2234     */
2235    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2236
2237    /**
2238     * Get the enable status of the highlight animation
2239     *
2240     * Get whether the focus highlight, if enabled, will animate its switch from
2241     * one object to the next
2242     * @ingroup Focus
2243     */
2244    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2245
2246    /**
2247     * Set the enable status of the highlight animation
2248     *
2249     * Set whether the focus highlight, if enabled, will animate its switch from
2250     * one object to the next
2251     * @param animate Enable animation if EINA_TRUE, disable otherwise
2252     * @ingroup Focus
2253     */
2254    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2255
2256    /**
2257     * Get the whether an Elementary object has the focus or not.
2258     *
2259     * @param obj The Elementary object to get the information from
2260     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2261     *            not (and on errors).
2262     *
2263     * @see elm_object_focus_set()
2264     *
2265     * @ingroup Focus
2266     */
2267    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2268
2269    /**
2270     * Set/unset focus to a given Elementary object.
2271     *
2272     * @param obj The Elementary object to operate on.
2273     * @param enable @c EINA_TRUE Set focus to a given object,
2274     *               @c EINA_FALSE Unset focus to a given object.
2275     *
2276     * @note When you set focus to this object, if it can handle focus, will
2277     * take the focus away from the one who had it previously and will, for
2278     * now on, be the one receiving input events. Unsetting focus will remove
2279     * the focus from @p obj, passing it back to the previous element in the
2280     * focus chain list.
2281     *
2282     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2283     *
2284     * @ingroup Focus
2285     */
2286    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2287
2288    /**
2289     * Make a given Elementary object the focused one.
2290     *
2291     * @param obj The Elementary object to make focused.
2292     *
2293     * @note This object, if it can handle focus, will take the focus
2294     * away from the one who had it previously and will, for now on, be
2295     * the one receiving input events.
2296     *
2297     * @see elm_object_focus_get()
2298     * @deprecated use elm_object_focus_set() instead.
2299     *
2300     * @ingroup Focus
2301     */
2302    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2303
2304    /**
2305     * Remove the focus from an Elementary object
2306     *
2307     * @param obj The Elementary to take focus from
2308     *
2309     * This removes the focus from @p obj, passing it back to the
2310     * previous element in the focus chain list.
2311     *
2312     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2313     * @deprecated use elm_object_focus_set() instead.
2314     *
2315     * @ingroup Focus
2316     */
2317    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2318
2319    /**
2320     * Set the ability for an Element object to be focused
2321     *
2322     * @param obj The Elementary object to operate on
2323     * @param enable @c EINA_TRUE if the object can be focused, @c
2324     *        EINA_FALSE if not (and on errors)
2325     *
2326     * This sets whether the object @p obj is able to take focus or
2327     * not. Unfocusable objects do nothing when programmatically
2328     * focused, being the nearest focusable parent object the one
2329     * really getting focus. Also, when they receive mouse input, they
2330     * will get the event, but not take away the focus from where it
2331     * was previously.
2332     *
2333     * @ingroup Focus
2334     */
2335    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2336
2337    /**
2338     * Get whether an Elementary object is focusable or not
2339     *
2340     * @param obj The Elementary object to operate on
2341     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2342     *             EINA_FALSE if not (and on errors)
2343     *
2344     * @note Objects which are meant to be interacted with by input
2345     * events are created able to be focused, by default. All the
2346     * others are not.
2347     *
2348     * @ingroup Focus
2349     */
2350    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2351
2352    /**
2353     * Set custom focus chain.
2354     *
2355     * This function overwrites any previous custom focus chain within
2356     * the list of objects. The previous list will be deleted and this list
2357     * will be managed by elementary. After it is set, don't modify it.
2358     *
2359     * @note On focus cycle, only will be evaluated children of this container.
2360     *
2361     * @param obj The container object
2362     * @param objs Chain of objects to pass focus
2363     * @ingroup Focus
2364     */
2365    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2366
2367    /**
2368     * Unset a custom focus chain on a given Elementary widget
2369     *
2370     * @param obj The container object to remove focus chain from
2371     *
2372     * Any focus chain previously set on @p obj (for its child objects)
2373     * is removed entirely after this call.
2374     *
2375     * @ingroup Focus
2376     */
2377    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2378
2379    /**
2380     * Get custom focus chain
2381     *
2382     * @param obj The container object
2383     * @ingroup Focus
2384     */
2385    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2386
2387    /**
2388     * Append object to custom focus chain.
2389     *
2390     * @note If relative_child equal to NULL or not in custom chain, the object
2391     * will be added in end.
2392     *
2393     * @note On focus cycle, only will be evaluated children of this container.
2394     *
2395     * @param obj The container object
2396     * @param child The child to be added in custom chain
2397     * @param relative_child The relative object to position the child
2398     * @ingroup Focus
2399     */
2400    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2401
2402    /**
2403     * Prepend object to custom focus chain.
2404     *
2405     * @note If relative_child equal to NULL or not in custom chain, the object
2406     * will be added in begin.
2407     *
2408     * @note On focus cycle, only will be evaluated children of this container.
2409     *
2410     * @param obj The container object
2411     * @param child The child to be added in custom chain
2412     * @param relative_child The relative object to position the child
2413     * @ingroup Focus
2414     */
2415    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2416
2417    /**
2418     * Give focus to next object in object tree.
2419     *
2420     * Give focus to next object in focus chain of one object sub-tree.
2421     * If the last object of chain already have focus, the focus will go to the
2422     * first object of chain.
2423     *
2424     * @param obj The object root of sub-tree
2425     * @param dir Direction to cycle the focus
2426     *
2427     * @ingroup Focus
2428     */
2429    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2430
2431    /**
2432     * Give focus to near object in one direction.
2433     *
2434     * Give focus to near object in direction of one object.
2435     * If none focusable object in given direction, the focus will not change.
2436     *
2437     * @param obj The reference object
2438     * @param x Horizontal component of direction to focus
2439     * @param y Vertical component of direction to focus
2440     *
2441     * @ingroup Focus
2442     */
2443    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2444
2445    /**
2446     * Make the elementary object and its children to be unfocusable
2447     * (or focusable).
2448     *
2449     * @param obj The Elementary object to operate on
2450     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2451     *        @c EINA_FALSE for focusable.
2452     *
2453     * This sets whether the object @p obj and its children objects
2454     * are able to take focus or not. If the tree is set as unfocusable,
2455     * newest focused object which is not in this tree will get focus.
2456     * This API can be helpful for an object to be deleted.
2457     * When an object will be deleted soon, it and its children may not
2458     * want to get focus (by focus reverting or by other focus controls).
2459     * Then, just use this API before deleting.
2460     *
2461     * @see elm_object_tree_unfocusable_get()
2462     *
2463     * @ingroup Focus
2464     */
2465    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2466
2467    /**
2468     * Get whether an Elementary object and its children are unfocusable or not.
2469     *
2470     * @param obj The Elementary object to get the information from
2471     * @return @c EINA_TRUE, if the tree is unfocussable,
2472     *         @c EINA_FALSE if not (and on errors).
2473     *
2474     * @see elm_object_tree_unfocusable_set()
2475     *
2476     * @ingroup Focus
2477     */
2478    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2479
2480    /**
2481     * @defgroup Scrolling Scrolling
2482     *
2483     * These are functions setting how scrollable views in Elementary
2484     * widgets should behave on user interaction.
2485     *
2486     * @{
2487     */
2488
2489    /**
2490     * Get whether scrollers should bounce when they reach their
2491     * viewport's edge during a scroll.
2492     *
2493     * @return the thumb scroll bouncing state
2494     *
2495     * This is the default behavior for touch screens, in general.
2496     * @ingroup Scrolling
2497     */
2498    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2499
2500    /**
2501     * Set whether scrollers should bounce when they reach their
2502     * viewport's edge during a scroll.
2503     *
2504     * @param enabled the thumb scroll bouncing state
2505     *
2506     * @see elm_thumbscroll_bounce_enabled_get()
2507     * @ingroup Scrolling
2508     */
2509    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2510
2511    /**
2512     * Set whether scrollers should bounce when they reach their
2513     * viewport's edge during a scroll, for all Elementary application
2514     * windows.
2515     *
2516     * @param enabled the thumb scroll bouncing state
2517     *
2518     * @see elm_thumbscroll_bounce_enabled_get()
2519     * @ingroup Scrolling
2520     */
2521    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2522
2523    /**
2524     * Get the amount of inertia a scroller will impose at bounce
2525     * animations.
2526     *
2527     * @return the thumb scroll bounce friction
2528     *
2529     * @ingroup Scrolling
2530     */
2531    EAPI double           elm_scroll_bounce_friction_get(void);
2532
2533    /**
2534     * Set the amount of inertia a scroller will impose at bounce
2535     * animations.
2536     *
2537     * @param friction the thumb scroll bounce friction
2538     *
2539     * @see elm_thumbscroll_bounce_friction_get()
2540     * @ingroup Scrolling
2541     */
2542    EAPI void             elm_scroll_bounce_friction_set(double friction);
2543
2544    /**
2545     * Set the amount of inertia a scroller will impose at bounce
2546     * animations, for all Elementary application windows.
2547     *
2548     * @param friction the thumb scroll bounce friction
2549     *
2550     * @see elm_thumbscroll_bounce_friction_get()
2551     * @ingroup Scrolling
2552     */
2553    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2554
2555    /**
2556     * Get the amount of inertia a <b>paged</b> scroller will impose at
2557     * page fitting animations.
2558     *
2559     * @return the page scroll friction
2560     *
2561     * @ingroup Scrolling
2562     */
2563    EAPI double           elm_scroll_page_scroll_friction_get(void);
2564
2565    /**
2566     * Set the amount of inertia a <b>paged</b> scroller will impose at
2567     * page fitting animations.
2568     *
2569     * @param friction the page scroll friction
2570     *
2571     * @see elm_thumbscroll_page_scroll_friction_get()
2572     * @ingroup Scrolling
2573     */
2574    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2575
2576    /**
2577     * Set the amount of inertia a <b>paged</b> scroller will impose at
2578     * page fitting animations, for all Elementary application windows.
2579     *
2580     * @param friction the page scroll friction
2581     *
2582     * @see elm_thumbscroll_page_scroll_friction_get()
2583     * @ingroup Scrolling
2584     */
2585    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2586
2587    /**
2588     * Get the amount of inertia a scroller will impose at region bring
2589     * animations.
2590     *
2591     * @return the bring in scroll friction
2592     *
2593     * @ingroup Scrolling
2594     */
2595    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2596
2597    /**
2598     * Set the amount of inertia a scroller will impose at region bring
2599     * animations.
2600     *
2601     * @param friction the bring in scroll friction
2602     *
2603     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2604     * @ingroup Scrolling
2605     */
2606    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2607
2608    /**
2609     * Set the amount of inertia a scroller will impose at region bring
2610     * animations, for all Elementary application windows.
2611     *
2612     * @param friction the bring in scroll friction
2613     *
2614     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2615     * @ingroup Scrolling
2616     */
2617    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2618
2619    /**
2620     * Get the amount of inertia scrollers will impose at animations
2621     * triggered by Elementary widgets' zooming API.
2622     *
2623     * @return the zoom friction
2624     *
2625     * @ingroup Scrolling
2626     */
2627    EAPI double           elm_scroll_zoom_friction_get(void);
2628
2629    /**
2630     * Set the amount of inertia scrollers will impose at animations
2631     * triggered by Elementary widgets' zooming API.
2632     *
2633     * @param friction the zoom friction
2634     *
2635     * @see elm_thumbscroll_zoom_friction_get()
2636     * @ingroup Scrolling
2637     */
2638    EAPI void             elm_scroll_zoom_friction_set(double friction);
2639
2640    /**
2641     * Set the amount of inertia scrollers will impose at animations
2642     * triggered by Elementary widgets' zooming API, for all Elementary
2643     * application windows.
2644     *
2645     * @param friction the zoom friction
2646     *
2647     * @see elm_thumbscroll_zoom_friction_get()
2648     * @ingroup Scrolling
2649     */
2650    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2651
2652    /**
2653     * Get whether scrollers should be draggable from any point in their
2654     * views.
2655     *
2656     * @return the thumb scroll state
2657     *
2658     * @note This is the default behavior for touch screens, in general.
2659     * @note All other functions namespaced with "thumbscroll" will only
2660     *       have effect if this mode is enabled.
2661     *
2662     * @ingroup Scrolling
2663     */
2664    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2665
2666    /**
2667     * Set whether scrollers should be draggable from any point in their
2668     * views.
2669     *
2670     * @param enabled the thumb scroll state
2671     *
2672     * @see elm_thumbscroll_enabled_get()
2673     * @ingroup Scrolling
2674     */
2675    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2676
2677    /**
2678     * Set whether scrollers should be draggable from any point in their
2679     * views, for all Elementary application windows.
2680     *
2681     * @param enabled the thumb scroll state
2682     *
2683     * @see elm_thumbscroll_enabled_get()
2684     * @ingroup Scrolling
2685     */
2686    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2687
2688    /**
2689     * Get the number of pixels one should travel while dragging a
2690     * scroller's view to actually trigger scrolling.
2691     *
2692     * @return the thumb scroll threshould
2693     *
2694     * One would use higher values for touch screens, in general, because
2695     * of their inherent imprecision.
2696     * @ingroup Scrolling
2697     */
2698    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2699
2700    /**
2701     * Set the number of pixels one should travel while dragging a
2702     * scroller's view to actually trigger scrolling.
2703     *
2704     * @param threshold the thumb scroll threshould
2705     *
2706     * @see elm_thumbscroll_threshould_get()
2707     * @ingroup Scrolling
2708     */
2709    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2710
2711    /**
2712     * Set the number of pixels one should travel while dragging a
2713     * scroller's view to actually trigger scrolling, for all Elementary
2714     * application windows.
2715     *
2716     * @param threshold the thumb scroll threshould
2717     *
2718     * @see elm_thumbscroll_threshould_get()
2719     * @ingroup Scrolling
2720     */
2721    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2722
2723    /**
2724     * Get the minimum speed of mouse cursor movement which will trigger
2725     * list self scrolling animation after a mouse up event
2726     * (pixels/second).
2727     *
2728     * @return the thumb scroll momentum threshould
2729     *
2730     * @ingroup Scrolling
2731     */
2732    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2733
2734    /**
2735     * Set the minimum speed of mouse cursor movement which will trigger
2736     * list self scrolling animation after a mouse up event
2737     * (pixels/second).
2738     *
2739     * @param threshold the thumb scroll momentum threshould
2740     *
2741     * @see elm_thumbscroll_momentum_threshould_get()
2742     * @ingroup Scrolling
2743     */
2744    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2745
2746    /**
2747     * Set the minimum speed of mouse cursor movement which will trigger
2748     * list self scrolling animation after a mouse up event
2749     * (pixels/second), for all Elementary application windows.
2750     *
2751     * @param threshold the thumb scroll momentum threshould
2752     *
2753     * @see elm_thumbscroll_momentum_threshould_get()
2754     * @ingroup Scrolling
2755     */
2756    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2757
2758    /**
2759     * Get the amount of inertia a scroller will impose at self scrolling
2760     * animations.
2761     *
2762     * @return the thumb scroll friction
2763     *
2764     * @ingroup Scrolling
2765     */
2766    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2767
2768    /**
2769     * Set the amount of inertia a scroller will impose at self scrolling
2770     * animations.
2771     *
2772     * @param friction the thumb scroll friction
2773     *
2774     * @see elm_thumbscroll_friction_get()
2775     * @ingroup Scrolling
2776     */
2777    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2778
2779    /**
2780     * Set the amount of inertia a scroller will impose at self scrolling
2781     * animations, for all Elementary application windows.
2782     *
2783     * @param friction the thumb scroll friction
2784     *
2785     * @see elm_thumbscroll_friction_get()
2786     * @ingroup Scrolling
2787     */
2788    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2789
2790    /**
2791     * Get the amount of lag between your actual mouse cursor dragging
2792     * movement and a scroller's view movement itself, while pushing it
2793     * into bounce state manually.
2794     *
2795     * @return the thumb scroll border friction
2796     *
2797     * @ingroup Scrolling
2798     */
2799    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2800
2801    /**
2802     * Set the amount of lag between your actual mouse cursor dragging
2803     * movement and a scroller's view movement itself, while pushing it
2804     * into bounce state manually.
2805     *
2806     * @param friction the thumb scroll border friction. @c 0.0 for
2807     *        perfect synchrony between two movements, @c 1.0 for maximum
2808     *        lag.
2809     *
2810     * @see elm_thumbscroll_border_friction_get()
2811     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2812     *
2813     * @ingroup Scrolling
2814     */
2815    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2816
2817    /**
2818     * Set the amount of lag between your actual mouse cursor dragging
2819     * movement and a scroller's view movement itself, while pushing it
2820     * into bounce state manually, for all Elementary application windows.
2821     *
2822     * @param friction the thumb scroll border friction. @c 0.0 for
2823     *        perfect synchrony between two movements, @c 1.0 for maximum
2824     *        lag.
2825     *
2826     * @see elm_thumbscroll_border_friction_get()
2827     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2828     *
2829     * @ingroup Scrolling
2830     */
2831    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2832
2833    /**
2834     * @}
2835     */
2836
2837    /**
2838     * @defgroup Scrollhints Scrollhints
2839     *
2840     * Objects when inside a scroller can scroll, but this may not always be
2841     * desirable in certain situations. This allows an object to hint to itself
2842     * and parents to "not scroll" in one of 2 ways. If any child object of a
2843     * scroller has pushed a scroll freeze or hold then it affects all parent
2844     * scrollers until all children have released them.
2845     *
2846     * 1. To hold on scrolling. This means just flicking and dragging may no
2847     * longer scroll, but pressing/dragging near an edge of the scroller will
2848     * still scroll. This is automatically used by the entry object when
2849     * selecting text.
2850     *
2851     * 2. To totally freeze scrolling. This means it stops. until
2852     * popped/released.
2853     *
2854     * @{
2855     */
2856
2857    /**
2858     * Push the scroll hold by 1
2859     *
2860     * This increments the scroll hold count by one. If it is more than 0 it will
2861     * take effect on the parents of the indicated object.
2862     *
2863     * @param obj The object
2864     * @ingroup Scrollhints
2865     */
2866    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2867
2868    /**
2869     * Pop the scroll hold by 1
2870     *
2871     * This decrements the scroll hold count by one. If it is more than 0 it will
2872     * take effect on the parents of the indicated object.
2873     *
2874     * @param obj The object
2875     * @ingroup Scrollhints
2876     */
2877    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2878
2879    /**
2880     * Push the scroll freeze by 1
2881     *
2882     * This increments the scroll freeze count by one. If it is more
2883     * than 0 it will take effect on the parents of the indicated
2884     * object.
2885     *
2886     * @param obj The object
2887     * @ingroup Scrollhints
2888     */
2889    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2890
2891    /**
2892     * Pop the scroll freeze by 1
2893     *
2894     * This decrements the scroll freeze count by one. If it is more
2895     * than 0 it will take effect on the parents of the indicated
2896     * object.
2897     *
2898     * @param obj The object
2899     * @ingroup Scrollhints
2900     */
2901    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2902
2903    /**
2904     * Lock the scrolling of the given widget (and thus all parents)
2905     *
2906     * This locks the given object from scrolling in the X axis (and implicitly
2907     * also locks all parent scrollers too from doing the same).
2908     *
2909     * @param obj The object
2910     * @param lock The lock state (1 == locked, 0 == unlocked)
2911     * @ingroup Scrollhints
2912     */
2913    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2914
2915    /**
2916     * Lock the scrolling of the given widget (and thus all parents)
2917     *
2918     * This locks the given object from scrolling in the Y axis (and implicitly
2919     * also locks all parent scrollers too from doing the same).
2920     *
2921     * @param obj The object
2922     * @param lock The lock state (1 == locked, 0 == unlocked)
2923     * @ingroup Scrollhints
2924     */
2925    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2926
2927    /**
2928     * Get the scrolling lock of the given widget
2929     *
2930     * This gets the lock for X axis scrolling.
2931     *
2932     * @param obj The object
2933     * @ingroup Scrollhints
2934     */
2935    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2936
2937    /**
2938     * Get the scrolling lock of the given widget
2939     *
2940     * This gets the lock for X axis scrolling.
2941     *
2942     * @param obj The object
2943     * @ingroup Scrollhints
2944     */
2945    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2946
2947    /**
2948     * @}
2949     */
2950
2951    /**
2952     * Send a signal to the widget edje object.
2953     *
2954     * This function sends a signal to the edje object of the obj. An
2955     * edje program can respond to a signal by specifying matching
2956     * 'signal' and 'source' fields.
2957     *
2958     * @param obj The object
2959     * @param emission The signal's name.
2960     * @param source The signal's source.
2961     * @ingroup General
2962     */
2963    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2964
2965    /**
2966     * Add a callback for a signal emitted by widget edje object.
2967     *
2968     * This function connects a callback function to a signal emitted by the
2969     * edje object of the obj.
2970     * Globs can occur in either the emission or source name.
2971     *
2972     * @param obj The object
2973     * @param emission The signal's name.
2974     * @param source The signal's source.
2975     * @param func The callback function to be executed when the signal is
2976     * emitted.
2977     * @param data A pointer to data to pass in to the callback function.
2978     * @ingroup General
2979     */
2980    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);
2981
2982    /**
2983     * Remove a signal-triggered callback from a widget edje object.
2984     *
2985     * This function removes a callback, previoulsy attached to a
2986     * signal emitted by the edje object of the obj.  The parameters
2987     * emission, source and func must match exactly those passed to a
2988     * previous call to elm_object_signal_callback_add(). The data
2989     * pointer that was passed to this call will be returned.
2990     *
2991     * @param obj The object
2992     * @param emission The signal's name.
2993     * @param source The signal's source.
2994     * @param func The callback function to be executed when the signal is
2995     * emitted.
2996     * @return The data pointer
2997     * @ingroup General
2998     */
2999    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);
3000
3001    /**
3002     * Add a callback for input events (key up, key down, mouse wheel)
3003     * on a given Elementary widget
3004     *
3005     * @param obj The widget to add an event callback on
3006     * @param func The callback function to be executed when the event
3007     * happens
3008     * @param data Data to pass in to @p func
3009     *
3010     * Every widget in an Elementary interface set to receive focus,
3011     * with elm_object_focus_allow_set(), will propagate @b all of its
3012     * key up, key down and mouse wheel input events up to its parent
3013     * object, and so on. All of the focusable ones in this chain which
3014     * had an event callback set, with this call, will be able to treat
3015     * those events. There are two ways of making the propagation of
3016     * these event upwards in the tree of widgets to @b cease:
3017     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3018     *   the event was @b not processed, so the propagation will go on.
3019     * - The @c event_info pointer passed to @p func will contain the
3020     *   event's structure and, if you OR its @c event_flags inner
3021     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3022     *   one has already handled it, thus killing the event's
3023     *   propagation, too.
3024     *
3025     * @note Your event callback will be issued on those events taking
3026     * place only if no other child widget of @obj has consumed the
3027     * event already.
3028     *
3029     * @note Not to be confused with @c
3030     * evas_object_event_callback_add(), which will add event callbacks
3031     * per type on general Evas objects (no event propagation
3032     * infrastructure taken in account).
3033     *
3034     * @note Not to be confused with @c
3035     * elm_object_signal_callback_add(), which will add callbacks to @b
3036     * signals coming from a widget's theme, not input events.
3037     *
3038     * @note Not to be confused with @c
3039     * edje_object_signal_callback_add(), which does the same as
3040     * elm_object_signal_callback_add(), but directly on an Edje
3041     * object.
3042     *
3043     * @note Not to be confused with @c
3044     * evas_object_smart_callback_add(), which adds callbacks to smart
3045     * objects' <b>smart events</b>, and not input events.
3046     *
3047     * @see elm_object_event_callback_del()
3048     *
3049     * @ingroup General
3050     */
3051    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3052
3053    /**
3054     * Remove an event callback from a widget.
3055     *
3056     * This function removes a callback, previoulsy attached to event emission
3057     * by the @p obj.
3058     * The parameters func and data must match exactly those passed to
3059     * a previous call to elm_object_event_callback_add(). The data pointer that
3060     * was passed to this call will be returned.
3061     *
3062     * @param obj The object
3063     * @param func The callback function to be executed when the event is
3064     * emitted.
3065     * @param data Data to pass in to the callback function.
3066     * @return The data pointer
3067     * @ingroup General
3068     */
3069    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3070
3071    /**
3072     * Adjust size of an element for finger usage.
3073     *
3074     * @param times_w How many fingers should fit horizontally
3075     * @param w Pointer to the width size to adjust
3076     * @param times_h How many fingers should fit vertically
3077     * @param h Pointer to the height size to adjust
3078     *
3079     * This takes width and height sizes (in pixels) as input and a
3080     * size multiple (which is how many fingers you want to place
3081     * within the area, being "finger" the size set by
3082     * elm_finger_size_set()), and adjusts the size to be large enough
3083     * to accommodate the resulting size -- if it doesn't already
3084     * accommodate it. On return the @p w and @p h sizes pointed to by
3085     * these parameters will be modified, on those conditions.
3086     *
3087     * @note This is kind of a low level Elementary call, most useful
3088     * on size evaluation times for widgets. An external user wouldn't
3089     * be calling, most of the time.
3090     *
3091     * @ingroup Fingers
3092     */
3093    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3094
3095    /**
3096     * Get the duration for occuring long press event.
3097     *
3098     * @return Timeout for long press event
3099     * @ingroup Longpress
3100     */
3101    EAPI double           elm_longpress_timeout_get(void);
3102
3103    /**
3104     * Set the duration for occuring long press event.
3105     *
3106     * @param lonpress_timeout Timeout for long press event
3107     * @ingroup Longpress
3108     */
3109    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3110
3111    /**
3112     * @defgroup Debug Debug
3113     * don't use it unless you are sure
3114     *
3115     * @{
3116     */
3117
3118    /**
3119     * Print Tree object hierarchy in stdout
3120     *
3121     * @param obj The root object
3122     * @ingroup Debug
3123     */
3124    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3125
3126    /**
3127     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3128     *
3129     * @param obj The root object
3130     * @param file The path of output file
3131     * @ingroup Debug
3132     */
3133    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3134
3135    /**
3136     * @}
3137     */
3138
3139    /**
3140     * @defgroup Theme Theme
3141     *
3142     * Elementary uses Edje to theme its widgets, naturally. But for the most
3143     * part this is hidden behind a simpler interface that lets the user set
3144     * extensions and choose the style of widgets in a much easier way.
3145     *
3146     * Instead of thinking in terms of paths to Edje files and their groups
3147     * each time you want to change the appearance of a widget, Elementary
3148     * works so you can add any theme file with extensions or replace the
3149     * main theme at one point in the application, and then just set the style
3150     * of widgets with elm_object_style_set() and related functions. Elementary
3151     * will then look in its list of themes for a matching group and apply it,
3152     * and when the theme changes midway through the application, all widgets
3153     * will be updated accordingly.
3154     *
3155     * There are three concepts you need to know to understand how Elementary
3156     * theming works: default theme, extensions and overlays.
3157     *
3158     * Default theme, obviously enough, is the one that provides the default
3159     * look of all widgets. End users can change the theme used by Elementary
3160     * by setting the @c ELM_THEME environment variable before running an
3161     * application, or globally for all programs using the @c elementary_config
3162     * utility. Applications can change the default theme using elm_theme_set(),
3163     * but this can go against the user wishes, so it's not an adviced practice.
3164     *
3165     * Ideally, applications should find everything they need in the already
3166     * provided theme, but there may be occasions when that's not enough and
3167     * custom styles are required to correctly express the idea. For this
3168     * cases, Elementary has extensions.
3169     *
3170     * Extensions allow the application developer to write styles of its own
3171     * to apply to some widgets. This requires knowledge of how each widget
3172     * is themed, as extensions will always replace the entire group used by
3173     * the widget, so important signals and parts need to be there for the
3174     * object to behave properly (see documentation of Edje for details).
3175     * Once the theme for the extension is done, the application needs to add
3176     * it to the list of themes Elementary will look into, using
3177     * elm_theme_extension_add(), and set the style of the desired widgets as
3178     * he would normally with elm_object_style_set().
3179     *
3180     * Overlays, on the other hand, can replace the look of all widgets by
3181     * overriding the default style. Like extensions, it's up to the application
3182     * developer to write the theme for the widgets it wants, the difference
3183     * being that when looking for the theme, Elementary will check first the
3184     * list of overlays, then the set theme and lastly the list of extensions,
3185     * so with overlays it's possible to replace the default view and every
3186     * widget will be affected. This is very much alike to setting the whole
3187     * theme for the application and will probably clash with the end user
3188     * options, not to mention the risk of ending up with not matching styles
3189     * across the program. Unless there's a very special reason to use them,
3190     * overlays should be avoided for the resons exposed before.
3191     *
3192     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3193     * keeps one default internally and every function that receives one of
3194     * these can be called with NULL to refer to this default (except for
3195     * elm_theme_free()). It's possible to create a new instance of a
3196     * ::Elm_Theme to set other theme for a specific widget (and all of its
3197     * children), but this is as discouraged, if not even more so, than using
3198     * overlays. Don't use this unless you really know what you are doing.
3199     *
3200     * But to be less negative about things, you can look at the following
3201     * examples:
3202     * @li @ref theme_example_01 "Using extensions"
3203     * @li @ref theme_example_02 "Using overlays"
3204     *
3205     * @{
3206     */
3207    /**
3208     * @typedef Elm_Theme
3209     *
3210     * Opaque handler for the list of themes Elementary looks for when
3211     * rendering widgets.
3212     *
3213     * Stay out of this unless you really know what you are doing. For most
3214     * cases, sticking to the default is all a developer needs.
3215     */
3216    typedef struct _Elm_Theme Elm_Theme;
3217
3218    /**
3219     * Create a new specific theme
3220     *
3221     * This creates an empty specific theme that only uses the default theme. A
3222     * specific theme has its own private set of extensions and overlays too
3223     * (which are empty by default). Specific themes do not fall back to themes
3224     * of parent objects. They are not intended for this use. Use styles, overlays
3225     * and extensions when needed, but avoid specific themes unless there is no
3226     * other way (example: you want to have a preview of a new theme you are
3227     * selecting in a "theme selector" window. The preview is inside a scroller
3228     * and should display what the theme you selected will look like, but not
3229     * actually apply it yet. The child of the scroller will have a specific
3230     * theme set to show this preview before the user decides to apply it to all
3231     * applications).
3232     */
3233    EAPI Elm_Theme       *elm_theme_new(void);
3234    /**
3235     * Free a specific theme
3236     *
3237     * @param th The theme to free
3238     *
3239     * This frees a theme created with elm_theme_new().
3240     */
3241    EAPI void             elm_theme_free(Elm_Theme *th);
3242    /**
3243     * Copy the theme fom the source to the destination theme
3244     *
3245     * @param th The source theme to copy from
3246     * @param thdst The destination theme to copy data to
3247     *
3248     * This makes a one-time static copy of all the theme config, extensions
3249     * and overlays from @p th to @p thdst. If @p th references a theme, then
3250     * @p thdst is also set to reference it, with all the theme settings,
3251     * overlays and extensions that @p th had.
3252     */
3253    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3254    /**
3255     * Tell the source theme to reference the ref theme
3256     *
3257     * @param th The theme that will do the referencing
3258     * @param thref The theme that is the reference source
3259     *
3260     * This clears @p th to be empty and then sets it to refer to @p thref
3261     * so @p th acts as an override to @p thref, but where its overrides
3262     * don't apply, it will fall through to @p thref for configuration.
3263     */
3264    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3265    /**
3266     * Return the theme referred to
3267     *
3268     * @param th The theme to get the reference from
3269     * @return The referenced theme handle
3270     *
3271     * This gets the theme set as the reference theme by elm_theme_ref_set().
3272     * If no theme is set as a reference, NULL is returned.
3273     */
3274    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3275    /**
3276     * Return the default theme
3277     *
3278     * @return The default theme handle
3279     *
3280     * This returns the internal default theme setup handle that all widgets
3281     * use implicitly unless a specific theme is set. This is also often use
3282     * as a shorthand of NULL.
3283     */
3284    EAPI Elm_Theme       *elm_theme_default_get(void);
3285    /**
3286     * Prepends a theme overlay to the list of overlays
3287     *
3288     * @param th The theme to add to, or if NULL, the default theme
3289     * @param item The Edje file path to be used
3290     *
3291     * Use this if your application needs to provide some custom overlay theme
3292     * (An Edje file that replaces some default styles of widgets) where adding
3293     * new styles, or changing system theme configuration is not possible. Do
3294     * NOT use this instead of a proper system theme configuration. Use proper
3295     * configuration files, profiles, environment variables etc. to set a theme
3296     * so that the theme can be altered by simple confiugration by a user. Using
3297     * this call to achieve that effect is abusing the API and will create lots
3298     * of trouble.
3299     *
3300     * @see elm_theme_extension_add()
3301     */
3302    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3303    /**
3304     * Delete a theme overlay from the list of overlays
3305     *
3306     * @param th The theme to delete from, or if NULL, the default theme
3307     * @param item The name of the theme overlay
3308     *
3309     * @see elm_theme_overlay_add()
3310     */
3311    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3312    /**
3313     * Appends a theme extension to the list of extensions.
3314     *
3315     * @param th The theme to add to, or if NULL, the default theme
3316     * @param item The Edje file path to be used
3317     *
3318     * This is intended when an application needs more styles of widgets or new
3319     * widget themes that the default does not provide (or may not provide). The
3320     * application has "extended" usage by coming up with new custom style names
3321     * for widgets for specific uses, but as these are not "standard", they are
3322     * not guaranteed to be provided by a default theme. This means the
3323     * application is required to provide these extra elements itself in specific
3324     * Edje files. This call adds one of those Edje files to the theme search
3325     * path to be search after the default theme. The use of this call is
3326     * encouraged when default styles do not meet the needs of the application.
3327     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3328     *
3329     * @see elm_object_style_set()
3330     */
3331    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3332    /**
3333     * Deletes a theme extension from the list of extensions.
3334     *
3335     * @param th The theme to delete from, or if NULL, the default theme
3336     * @param item The name of the theme extension
3337     *
3338     * @see elm_theme_extension_add()
3339     */
3340    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3341    /**
3342     * Set the theme search order for the given theme
3343     *
3344     * @param th The theme to set the search order, or if NULL, the default theme
3345     * @param theme Theme search string
3346     *
3347     * This sets the search string for the theme in path-notation from first
3348     * theme to search, to last, delimited by the : character. Example:
3349     *
3350     * "shiny:/path/to/file.edj:default"
3351     *
3352     * See the ELM_THEME environment variable for more information.
3353     *
3354     * @see elm_theme_get()
3355     * @see elm_theme_list_get()
3356     */
3357    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3358    /**
3359     * Return the theme search order
3360     *
3361     * @param th The theme to get the search order, or if NULL, the default theme
3362     * @return The internal search order path
3363     *
3364     * This function returns a colon separated string of theme elements as
3365     * returned by elm_theme_list_get().
3366     *
3367     * @see elm_theme_set()
3368     * @see elm_theme_list_get()
3369     */
3370    EAPI const char      *elm_theme_get(Elm_Theme *th);
3371    /**
3372     * Return a list of theme elements to be used in a theme.
3373     *
3374     * @param th Theme to get the list of theme elements from.
3375     * @return The internal list of theme elements
3376     *
3377     * This returns the internal list of theme elements (will only be valid as
3378     * long as the theme is not modified by elm_theme_set() or theme is not
3379     * freed by elm_theme_free(). This is a list of strings which must not be
3380     * altered as they are also internal. If @p th is NULL, then the default
3381     * theme element list is returned.
3382     *
3383     * A theme element can consist of a full or relative path to a .edj file,
3384     * or a name, without extension, for a theme to be searched in the known
3385     * theme paths for Elemementary.
3386     *
3387     * @see elm_theme_set()
3388     * @see elm_theme_get()
3389     */
3390    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3391    /**
3392     * Return the full patrh for a theme element
3393     *
3394     * @param f The theme element name
3395     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3396     * @return The full path to the file found.
3397     *
3398     * This returns a string you should free with free() on success, NULL on
3399     * failure. This will search for the given theme element, and if it is a
3400     * full or relative path element or a simple searchable name. The returned
3401     * path is the full path to the file, if searched, and the file exists, or it
3402     * is simply the full path given in the element or a resolved path if
3403     * relative to home. The @p in_search_path boolean pointed to is set to
3404     * EINA_TRUE if the file was a searchable file andis in the search path,
3405     * and EINA_FALSE otherwise.
3406     */
3407    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3408    /**
3409     * Flush the current theme.
3410     *
3411     * @param th Theme to flush
3412     *
3413     * This flushes caches that let elementary know where to find theme elements
3414     * in the given theme. If @p th is NULL, then the default theme is flushed.
3415     * Call this function if source theme data has changed in such a way as to
3416     * make any caches Elementary kept invalid.
3417     */
3418    EAPI void             elm_theme_flush(Elm_Theme *th);
3419    /**
3420     * This flushes all themes (default and specific ones).
3421     *
3422     * This will flush all themes in the current application context, by calling
3423     * elm_theme_flush() on each of them.
3424     */
3425    EAPI void             elm_theme_full_flush(void);
3426    /**
3427     * Set the theme for all elementary using applications on the current display
3428     *
3429     * @param theme The name of the theme to use. Format same as the ELM_THEME
3430     * environment variable.
3431     */
3432    EAPI void             elm_theme_all_set(const char *theme);
3433    /**
3434     * Return a list of theme elements in the theme search path
3435     *
3436     * @return A list of strings that are the theme element names.
3437     *
3438     * This lists all available theme files in the standard Elementary search path
3439     * for theme elements, and returns them in alphabetical order as theme
3440     * element names in a list of strings. Free this with
3441     * elm_theme_name_available_list_free() when you are done with the list.
3442     */
3443    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3444    /**
3445     * Free the list returned by elm_theme_name_available_list_new()
3446     *
3447     * This frees the list of themes returned by
3448     * elm_theme_name_available_list_new(). Once freed the list should no longer
3449     * be used. a new list mys be created.
3450     */
3451    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3452    /**
3453     * Set a specific theme to be used for this object and its children
3454     *
3455     * @param obj The object to set the theme on
3456     * @param th The theme to set
3457     *
3458     * This sets a specific theme that will be used for the given object and any
3459     * child objects it has. If @p th is NULL then the theme to be used is
3460     * cleared and the object will inherit its theme from its parent (which
3461     * ultimately will use the default theme if no specific themes are set).
3462     *
3463     * Use special themes with great care as this will annoy users and make
3464     * configuration difficult. Avoid any custom themes at all if it can be
3465     * helped.
3466     */
3467    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3468    /**
3469     * Get the specific theme to be used
3470     *
3471     * @param obj The object to get the specific theme from
3472     * @return The specifc theme set.
3473     *
3474     * This will return a specific theme set, or NULL if no specific theme is
3475     * set on that object. It will not return inherited themes from parents, only
3476     * the specific theme set for that specific object. See elm_object_theme_set()
3477     * for more information.
3478     */
3479    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3480
3481    /**
3482     * Get a data item from a theme
3483     *
3484     * @param th The theme, or NULL for default theme
3485     * @param key The data key to search with
3486     * @return The data value, or NULL on failure
3487     *
3488     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3489     * It works the same way as edje_file_data_get() except that the return is stringshared.
3490     */
3491    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3492    /**
3493     * @}
3494     */
3495
3496    /* win */
3497    /** @defgroup Win Win
3498     *
3499     * @image html img/widget/win/preview-00.png
3500     * @image latex img/widget/win/preview-00.eps
3501     *
3502     * The window class of Elementary.  Contains functions to manipulate
3503     * windows. The Evas engine used to render the window contents is specified
3504     * in the system or user elementary config files (whichever is found last),
3505     * and can be overridden with the ELM_ENGINE environment variable for
3506     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3507     * compilation setup and modules actually installed at runtime) are (listed
3508     * in order of best supported and most likely to be complete and work to
3509     * lowest quality).
3510     *
3511     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3512     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3513     * rendering in X11)
3514     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3515     * exits)
3516     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3517     * rendering)
3518     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3519     * buffer)
3520     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3521     * rendering using SDL as the buffer)
3522     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3523     * GDI with software)
3524     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3525     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3526     * grayscale using dedicated 8bit software engine in X11)
3527     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3528     * X11 using 16bit software engine)
3529     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3530     * (Windows CE rendering via GDI with 16bit software renderer)
3531     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3532     * buffer with 16bit software renderer)
3533     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3534     *
3535     * All engines use a simple string to select the engine to render, EXCEPT
3536     * the "shot" engine. This actually encodes the output of the virtual
3537     * screenshot and how long to delay in the engine string. The engine string
3538     * is encoded in the following way:
3539     *
3540     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3541     *
3542     * Where options are separated by a ":" char if more than one option is
3543     * given, with delay, if provided being the first option and file the last
3544     * (order is important). The delay specifies how long to wait after the
3545     * window is shown before doing the virtual "in memory" rendering and then
3546     * save the output to the file specified by the file option (and then exit).
3547     * If no delay is given, the default is 0.5 seconds. If no file is given the
3548     * default output file is "out.png". Repeat option is for continous
3549     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3550     * fixed to "out001.png" Some examples of using the shot engine:
3551     *
3552     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3553     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3554     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3555     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3556     *   ELM_ENGINE="shot:" elementary_test
3557     *
3558     * Signals that you can add callbacks for are:
3559     *
3560     * @li "delete,request": the user requested to close the window. See
3561     * elm_win_autodel_set().
3562     * @li "focus,in": window got focus
3563     * @li "focus,out": window lost focus
3564     * @li "moved": window that holds the canvas was moved
3565     *
3566     * Examples:
3567     * @li @ref win_example_01
3568     *
3569     * @{
3570     */
3571    /**
3572     * Defines the types of window that can be created
3573     *
3574     * These are hints set on the window so that a running Window Manager knows
3575     * how the window should be handled and/or what kind of decorations it
3576     * should have.
3577     *
3578     * Currently, only the X11 backed engines use them.
3579     */
3580    typedef enum _Elm_Win_Type
3581      {
3582         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3583                          window. Almost every window will be created with this
3584                          type. */
3585         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3586         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3587                            window holding desktop icons. */
3588         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3589                         be kept on top of any other window by the Window
3590                         Manager. */
3591         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3592                            similar. */
3593         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3594         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3595                            pallete. */
3596         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3597         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3598                                  entry in a menubar is clicked. Typically used
3599                                  with elm_win_override_set(). This hint exists
3600                                  for completion only, as the EFL way of
3601                                  implementing a menu would not normally use a
3602                                  separate window for its contents. */
3603         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3604                               triggered by right-clicking an object. */
3605         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3606                            explanatory text that typically appear after the
3607                            mouse cursor hovers over an object for a while.
3608                            Typically used with elm_win_override_set() and also
3609                            not very commonly used in the EFL. */
3610         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3611                                 battery life or a new E-Mail received. */
3612         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3613                          usually used in the EFL. */
3614         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3615                        object being dragged across different windows, or even
3616                        applications. Typically used with
3617                        elm_win_override_set(). */
3618         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3619                                  buffer. No actual window is created for this
3620                                  type, instead the window and all of its
3621                                  contents will be rendered to an image buffer.
3622                                  This allows to have children window inside a
3623                                  parent one just like any other object would
3624                                  be, and do other things like applying @c
3625                                  Evas_Map effects to it. This is the only type
3626                                  of window that requires the @c parent
3627                                  parameter of elm_win_add() to be a valid @c
3628                                  Evas_Object. */
3629      } Elm_Win_Type;
3630
3631    /**
3632     * The differents layouts that can be requested for the virtual keyboard.
3633     *
3634     * When the application window is being managed by Illume, it may request
3635     * any of the following layouts for the virtual keyboard.
3636     */
3637    typedef enum _Elm_Win_Keyboard_Mode
3638      {
3639         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3640         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3641         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3642         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3643         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3644         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3645         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3646         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3647         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3648         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3649         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3650         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3651         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3652         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3653         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3654         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3655      } Elm_Win_Keyboard_Mode;
3656
3657    /**
3658     * Available commands that can be sent to the Illume manager.
3659     *
3660     * When running under an Illume session, a window may send commands to the
3661     * Illume manager to perform different actions.
3662     */
3663    typedef enum _Elm_Illume_Command
3664      {
3665         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3666                                          window */
3667         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3668                                             in the list */
3669         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3670                                          screen */
3671         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3672      } Elm_Illume_Command;
3673
3674    /**
3675     * Adds a window object. If this is the first window created, pass NULL as
3676     * @p parent.
3677     *
3678     * @param parent Parent object to add the window to, or NULL
3679     * @param name The name of the window
3680     * @param type The window type, one of #Elm_Win_Type.
3681     *
3682     * The @p parent paramter can be @c NULL for every window @p type except
3683     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3684     * which the image object will be created.
3685     *
3686     * @return The created object, or NULL on failure
3687     */
3688    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3689    /**
3690     * Add @p subobj as a resize object of window @p obj.
3691     *
3692     *
3693     * Setting an object as a resize object of the window means that the
3694     * @p subobj child's size and position will be controlled by the window
3695     * directly. That is, the object will be resized to match the window size
3696     * and should never be moved or resized manually by the developer.
3697     *
3698     * In addition, resize objects of the window control what the minimum size
3699     * of it will be, as well as whether it can or not be resized by the user.
3700     *
3701     * For the end user to be able to resize a window by dragging the handles
3702     * or borders provided by the Window Manager, or using any other similar
3703     * mechanism, all of the resize objects in the window should have their
3704     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3705     *
3706     * @param obj The window object
3707     * @param subobj The resize object to add
3708     */
3709    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3710    /**
3711     * Delete @p subobj as a resize object of window @p obj.
3712     *
3713     * This function removes the object @p subobj from the resize objects of
3714     * the window @p obj. It will not delete the object itself, which will be
3715     * left unmanaged and should be deleted by the developer, manually handled
3716     * or set as child of some other container.
3717     *
3718     * @param obj The window object
3719     * @param subobj The resize object to add
3720     */
3721    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3722    /**
3723     * Set the title of the window
3724     *
3725     * @param obj The window object
3726     * @param title The title to set
3727     */
3728    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3729    /**
3730     * Get the title of the window
3731     *
3732     * The returned string is an internal one and should not be freed or
3733     * modified. It will also be rendered invalid if a new title is set or if
3734     * the window is destroyed.
3735     *
3736     * @param obj The window object
3737     * @return The title
3738     */
3739    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3740    /**
3741     * Set the window's autodel state.
3742     *
3743     * When closing the window in any way outside of the program control, like
3744     * pressing the X button in the titlebar or using a command from the
3745     * Window Manager, a "delete,request" signal is emitted to indicate that
3746     * this event occurred and the developer can take any action, which may
3747     * include, or not, destroying the window object.
3748     *
3749     * When the @p autodel parameter is set, the window will be automatically
3750     * destroyed when this event occurs, after the signal is emitted.
3751     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3752     * and is up to the program to do so when it's required.
3753     *
3754     * @param obj The window object
3755     * @param autodel If true, the window will automatically delete itself when
3756     * closed
3757     */
3758    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3759    /**
3760     * Get the window's autodel state.
3761     *
3762     * @param obj The window object
3763     * @return If the window will automatically delete itself when closed
3764     *
3765     * @see elm_win_autodel_set()
3766     */
3767    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3768    /**
3769     * Activate a window object.
3770     *
3771     * This function sends a request to the Window Manager to activate the
3772     * window pointed by @p obj. If honored by the WM, the window will receive
3773     * the keyboard focus.
3774     *
3775     * @note This is just a request that a Window Manager may ignore, so calling
3776     * this function does not ensure in any way that the window will be the
3777     * active one after it.
3778     *
3779     * @param obj The window object
3780     */
3781    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3782    /**
3783     * Lower a window object.
3784     *
3785     * Places the window pointed by @p obj at the bottom of the stack, so that
3786     * no other window is covered by it.
3787     *
3788     * If elm_win_override_set() is not set, the Window Manager may ignore this
3789     * request.
3790     *
3791     * @param obj The window object
3792     */
3793    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3794    /**
3795     * Raise a window object.
3796     *
3797     * Places the window pointed by @p obj at the top of the stack, so that it's
3798     * not covered by any other window.
3799     *
3800     * If elm_win_override_set() is not set, the Window Manager may ignore this
3801     * request.
3802     *
3803     * @param obj The window object
3804     */
3805    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3806    /**
3807     * Set the borderless state of a window.
3808     *
3809     * This function requests the Window Manager to not draw any decoration
3810     * around the window.
3811     *
3812     * @param obj The window object
3813     * @param borderless If true, the window is borderless
3814     */
3815    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3816    /**
3817     * Get the borderless state of a window.
3818     *
3819     * @param obj The window object
3820     * @return If true, the window is borderless
3821     */
3822    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3823    /**
3824     * Set the shaped state of a window.
3825     *
3826     * Shaped windows, when supported, will render the parts of the window that
3827     * has no content, transparent.
3828     *
3829     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3830     * background object or cover the entire window in any other way, or the
3831     * parts of the canvas that have no data will show framebuffer artifacts.
3832     *
3833     * @param obj The window object
3834     * @param shaped If true, the window is shaped
3835     *
3836     * @see elm_win_alpha_set()
3837     */
3838    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3839    /**
3840     * Get the shaped state of a window.
3841     *
3842     * @param obj The window object
3843     * @return If true, the window is shaped
3844     *
3845     * @see elm_win_shaped_set()
3846     */
3847    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3848    /**
3849     * Set the alpha channel state of a window.
3850     *
3851     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3852     * possibly making parts of the window completely or partially transparent.
3853     * This is also subject to the underlying system supporting it, like for
3854     * example, running under a compositing manager. If no compositing is
3855     * available, enabling this option will instead fallback to using shaped
3856     * windows, with elm_win_shaped_set().
3857     *
3858     * @param obj The window object
3859     * @param alpha If true, the window has an alpha channel
3860     *
3861     * @see elm_win_alpha_set()
3862     */
3863    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3864    /**
3865     * Get the transparency state of a window.
3866     *
3867     * @param obj The window object
3868     * @return If true, the window is transparent
3869     *
3870     * @see elm_win_transparent_set()
3871     */
3872    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3873    /**
3874     * Set the transparency state of a window.
3875     *
3876     * Use elm_win_alpha_set() instead.
3877     *
3878     * @param obj The window object
3879     * @param transparent If true, the window is transparent
3880     *
3881     * @see elm_win_alpha_set()
3882     */
3883    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3884    /**
3885     * Get the alpha channel state of a window.
3886     *
3887     * @param obj The window object
3888     * @return If true, the window has an alpha channel
3889     */
3890    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3891    /**
3892     * Set the override state of a window.
3893     *
3894     * A window with @p override set to EINA_TRUE will not be managed by the
3895     * Window Manager. This means that no decorations of any kind will be shown
3896     * for it, moving and resizing must be handled by the application, as well
3897     * as the window visibility.
3898     *
3899     * This should not be used for normal windows, and even for not so normal
3900     * ones, it should only be used when there's a good reason and with a lot
3901     * of care. Mishandling override windows may result situations that
3902     * disrupt the normal workflow of the end user.
3903     *
3904     * @param obj The window object
3905     * @param override If true, the window is overridden
3906     */
3907    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3908    /**
3909     * Get the override state of a window.
3910     *
3911     * @param obj The window object
3912     * @return If true, the window is overridden
3913     *
3914     * @see elm_win_override_set()
3915     */
3916    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3917    /**
3918     * Set the fullscreen state of a window.
3919     *
3920     * @param obj The window object
3921     * @param fullscreen If true, the window is fullscreen
3922     */
3923    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3924    /**
3925     * Get the fullscreen state of a window.
3926     *
3927     * @param obj The window object
3928     * @return If true, the window is fullscreen
3929     */
3930    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3931    /**
3932     * Set the maximized state of a window.
3933     *
3934     * @param obj The window object
3935     * @param maximized If true, the window is maximized
3936     */
3937    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3938    /**
3939     * Get the maximized state of a window.
3940     *
3941     * @param obj The window object
3942     * @return If true, the window is maximized
3943     */
3944    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3945    /**
3946     * Set the iconified state of a window.
3947     *
3948     * @param obj The window object
3949     * @param iconified If true, the window is iconified
3950     */
3951    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3952    /**
3953     * Get the iconified state of a window.
3954     *
3955     * @param obj The window object
3956     * @return If true, the window is iconified
3957     */
3958    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3959    /**
3960     * Set the layer of the window.
3961     *
3962     * What this means exactly will depend on the underlying engine used.
3963     *
3964     * In the case of X11 backed engines, the value in @p layer has the
3965     * following meanings:
3966     * @li < 3: The window will be placed below all others.
3967     * @li > 5: The window will be placed above all others.
3968     * @li other: The window will be placed in the default layer.
3969     *
3970     * @param obj The window object
3971     * @param layer The layer of the window
3972     */
3973    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3974    /**
3975     * Get the layer of the window.
3976     *
3977     * @param obj The window object
3978     * @return The layer of the window
3979     *
3980     * @see elm_win_layer_set()
3981     */
3982    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3983    /**
3984     * Set the rotation of the window.
3985     *
3986     * Most engines only work with multiples of 90.
3987     *
3988     * This function is used to set the orientation of the window @p obj to
3989     * match that of the screen. The window itself will be resized to adjust
3990     * to the new geometry of its contents. If you want to keep the window size,
3991     * see elm_win_rotation_with_resize_set().
3992     *
3993     * @param obj The window object
3994     * @param rotation The rotation of the window, in degrees (0-360),
3995     * counter-clockwise.
3996     */
3997    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3998    /**
3999     * Rotates the window and resizes it.
4000     *
4001     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4002     * that they fit inside the current window geometry.
4003     *
4004     * @param obj The window object
4005     * @param layer The rotation of the window in degrees (0-360),
4006     * counter-clockwise.
4007     */
4008    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4009    /**
4010     * Get the rotation of the window.
4011     *
4012     * @param obj The window object
4013     * @return The rotation of the window in degrees (0-360)
4014     *
4015     * @see elm_win_rotation_set()
4016     * @see elm_win_rotation_with_resize_set()
4017     */
4018    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4019    /**
4020     * Set the sticky state of the window.
4021     *
4022     * Hints the Window Manager that the window in @p obj should be left fixed
4023     * at its position even when the virtual desktop it's on moves or changes.
4024     *
4025     * @param obj The window object
4026     * @param sticky If true, the window's sticky state is enabled
4027     */
4028    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4029    /**
4030     * Get the sticky state of the window.
4031     *
4032     * @param obj The window object
4033     * @return If true, the window's sticky state is enabled
4034     *
4035     * @see elm_win_sticky_set()
4036     */
4037    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4038    /**
4039     * Set if this window is an illume conformant window
4040     *
4041     * @param obj The window object
4042     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4043     */
4044    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4045    /**
4046     * Get if this window is an illume conformant window
4047     *
4048     * @param obj The window object
4049     * @return A boolean if this window is illume conformant or not
4050     */
4051    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4052    /**
4053     * Set a window to be an illume quickpanel window
4054     *
4055     * By default window objects are not quickpanel windows.
4056     *
4057     * @param obj The window object
4058     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4059     */
4060    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4061    /**
4062     * Get if this window is a quickpanel or not
4063     *
4064     * @param obj The window object
4065     * @return A boolean if this window is a quickpanel or not
4066     */
4067    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4068    /**
4069     * Set the major priority of a quickpanel window
4070     *
4071     * @param obj The window object
4072     * @param priority The major priority for this quickpanel
4073     */
4074    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4075    /**
4076     * Get the major priority of a quickpanel window
4077     *
4078     * @param obj The window object
4079     * @return The major priority of this quickpanel
4080     */
4081    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4082    /**
4083     * Set the minor priority of a quickpanel window
4084     *
4085     * @param obj The window object
4086     * @param priority The minor priority for this quickpanel
4087     */
4088    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4089    /**
4090     * Get the minor priority of a quickpanel window
4091     *
4092     * @param obj The window object
4093     * @return The minor priority of this quickpanel
4094     */
4095    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4096    /**
4097     * Set which zone this quickpanel should appear in
4098     *
4099     * @param obj The window object
4100     * @param zone The requested zone for this quickpanel
4101     */
4102    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4103    /**
4104     * Get which zone this quickpanel should appear in
4105     *
4106     * @param obj The window object
4107     * @return The requested zone for this quickpanel
4108     */
4109    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4110    /**
4111     * Set the window to be skipped by keyboard focus
4112     *
4113     * This sets the window to be skipped by normal keyboard input. This means
4114     * a window manager will be asked to not focus this window as well as omit
4115     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4116     *
4117     * Call this and enable it on a window BEFORE you show it for the first time,
4118     * otherwise it may have no effect.
4119     *
4120     * Use this for windows that have only output information or might only be
4121     * interacted with by the mouse or fingers, and never for typing input.
4122     * Be careful that this may have side-effects like making the window
4123     * non-accessible in some cases unless the window is specially handled. Use
4124     * this with care.
4125     *
4126     * @param obj The window object
4127     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4128     */
4129    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4130    /**
4131     * Send a command to the windowing environment
4132     *
4133     * This is intended to work in touchscreen or small screen device
4134     * environments where there is a more simplistic window management policy in
4135     * place. This uses the window object indicated to select which part of the
4136     * environment to control (the part that this window lives in), and provides
4137     * a command and an optional parameter structure (use NULL for this if not
4138     * needed).
4139     *
4140     * @param obj The window object that lives in the environment to control
4141     * @param command The command to send
4142     * @param params Optional parameters for the command
4143     */
4144    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4145    /**
4146     * Get the inlined image object handle
4147     *
4148     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4149     * then the window is in fact an evas image object inlined in the parent
4150     * canvas. You can get this object (be careful to not manipulate it as it
4151     * is under control of elementary), and use it to do things like get pixel
4152     * data, save the image to a file, etc.
4153     *
4154     * @param obj The window object to get the inlined image from
4155     * @return The inlined image object, or NULL if none exists
4156     */
4157    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4158    /**
4159     * Set the enabled status for the focus highlight in a window
4160     *
4161     * This function will enable or disable the focus highlight only for the
4162     * given window, regardless of the global setting for it
4163     *
4164     * @param obj The window where to enable the highlight
4165     * @param enabled The enabled value for the highlight
4166     */
4167    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4168    /**
4169     * Get the enabled value of the focus highlight for this window
4170     *
4171     * @param obj The window in which to check if the focus highlight is enabled
4172     *
4173     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4174     */
4175    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4176    /**
4177     * Set the style for the focus highlight on this window
4178     *
4179     * Sets the style to use for theming the highlight of focused objects on
4180     * the given window. If @p style is NULL, the default will be used.
4181     *
4182     * @param obj The window where to set the style
4183     * @param style The style to set
4184     */
4185    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4186    /**
4187     * Get the style set for the focus highlight object
4188     *
4189     * Gets the style set for this windows highilght object, or NULL if none
4190     * is set.
4191     *
4192     * @param obj The window to retrieve the highlights style from
4193     *
4194     * @return The style set or NULL if none was. Default is used in that case.
4195     */
4196    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4197    /*...
4198     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4199     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4200     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4201     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4202     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4203     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4204     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4205     *
4206     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4207     * (blank mouse, private mouse obj, defaultmouse)
4208     *
4209     */
4210    /**
4211     * Sets the keyboard mode of the window.
4212     *
4213     * @param obj The window object
4214     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4215     */
4216    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4217    /**
4218     * Gets the keyboard mode of the window.
4219     *
4220     * @param obj The window object
4221     * @return The mode, one of #Elm_Win_Keyboard_Mode
4222     */
4223    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4224    /**
4225     * Sets whether the window is a keyboard.
4226     *
4227     * @param obj The window object
4228     * @param is_keyboard If true, the window is a virtual keyboard
4229     */
4230    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4231    /**
4232     * Gets whether the window is a keyboard.
4233     *
4234     * @param obj The window object
4235     * @return If the window is a virtual keyboard
4236     */
4237    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4238
4239    /**
4240     * Get the screen position of a window.
4241     *
4242     * @param obj The window object
4243     * @param x The int to store the x coordinate to
4244     * @param y The int to store the y coordinate to
4245     */
4246    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4247    /**
4248     * @}
4249     */
4250
4251    /**
4252     * @defgroup Inwin Inwin
4253     *
4254     * @image html img/widget/inwin/preview-00.png
4255     * @image latex img/widget/inwin/preview-00.eps
4256     * @image html img/widget/inwin/preview-01.png
4257     * @image latex img/widget/inwin/preview-01.eps
4258     * @image html img/widget/inwin/preview-02.png
4259     * @image latex img/widget/inwin/preview-02.eps
4260     *
4261     * An inwin is a window inside a window that is useful for a quick popup.
4262     * It does not hover.
4263     *
4264     * It works by creating an object that will occupy the entire window, so it
4265     * must be created using an @ref Win "elm_win" as parent only. The inwin
4266     * object can be hidden or restacked below every other object if it's
4267     * needed to show what's behind it without destroying it. If this is done,
4268     * the elm_win_inwin_activate() function can be used to bring it back to
4269     * full visibility again.
4270     *
4271     * There are three styles available in the default theme. These are:
4272     * @li default: The inwin is sized to take over most of the window it's
4273     * placed in.
4274     * @li minimal: The size of the inwin will be the minimum necessary to show
4275     * its contents.
4276     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4277     * possible, but it's sized vertically the most it needs to fit its\
4278     * contents.
4279     *
4280     * Some examples of Inwin can be found in the following:
4281     * @li @ref inwin_example_01
4282     *
4283     * @{
4284     */
4285    /**
4286     * Adds an inwin to the current window
4287     *
4288     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4289     * Never call this function with anything other than the top-most window
4290     * as its parameter, unless you are fond of undefined behavior.
4291     *
4292     * After creating the object, the widget will set itself as resize object
4293     * for the window with elm_win_resize_object_add(), so when shown it will
4294     * appear to cover almost the entire window (how much of it depends on its
4295     * content and the style used). It must not be added into other container
4296     * objects and it needs not be moved or resized manually.
4297     *
4298     * @param parent The parent object
4299     * @return The new object or NULL if it cannot be created
4300     */
4301    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4302    /**
4303     * Activates an inwin object, ensuring its visibility
4304     *
4305     * This function will make sure that the inwin @p obj is completely visible
4306     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4307     * to the front. It also sets the keyboard focus to it, which will be passed
4308     * onto its content.
4309     *
4310     * The object's theme will also receive the signal "elm,action,show" with
4311     * source "elm".
4312     *
4313     * @param obj The inwin to activate
4314     */
4315    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4316    /**
4317     * Set the content of an inwin object.
4318     *
4319     * Once the content object is set, a previously set one will be deleted.
4320     * If you want to keep that old content object, use the
4321     * elm_win_inwin_content_unset() function.
4322     *
4323     * @param obj The inwin object
4324     * @param content The object to set as content
4325     */
4326    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4327    /**
4328     * Get the content of an inwin object.
4329     *
4330     * Return the content object which is set for this widget.
4331     *
4332     * The returned object is valid as long as the inwin is still alive and no
4333     * other content is set on it. Deleting the object will notify the inwin
4334     * about it and this one will be left empty.
4335     *
4336     * If you need to remove an inwin's content to be reused somewhere else,
4337     * see elm_win_inwin_content_unset().
4338     *
4339     * @param obj The inwin object
4340     * @return The content that is being used
4341     */
4342    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4343    /**
4344     * Unset the content of an inwin object.
4345     *
4346     * Unparent and return the content object which was set for this widget.
4347     *
4348     * @param obj The inwin object
4349     * @return The content that was being used
4350     */
4351    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4352    /**
4353     * @}
4354     */
4355    /* X specific calls - won't work on non-x engines (return 0) */
4356
4357    /**
4358     * Get the Ecore_X_Window of an Evas_Object
4359     *
4360     * @param obj The object
4361     *
4362     * @return The Ecore_X_Window of @p obj
4363     *
4364     * @ingroup Win
4365     */
4366    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367
4368    /* smart callbacks called:
4369     * "delete,request" - the user requested to delete the window
4370     * "focus,in" - window got focus
4371     * "focus,out" - window lost focus
4372     * "moved" - window that holds the canvas was moved
4373     */
4374
4375    /**
4376     * @defgroup Bg Bg
4377     *
4378     * @image html img/widget/bg/preview-00.png
4379     * @image latex img/widget/bg/preview-00.eps
4380     *
4381     * @brief Background object, used for setting a solid color, image or Edje
4382     * group as background to a window or any container object.
4383     *
4384     * The bg object is used for setting a solid background to a window or
4385     * packing into any container object. It works just like an image, but has
4386     * some properties useful to a background, like setting it to tiled,
4387     * centered, scaled or stretched.
4388     *
4389     * Here is some sample code using it:
4390     * @li @ref bg_01_example_page
4391     * @li @ref bg_02_example_page
4392     * @li @ref bg_03_example_page
4393     */
4394
4395    /* bg */
4396    typedef enum _Elm_Bg_Option
4397      {
4398         ELM_BG_OPTION_CENTER,  /**< center the background */
4399         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4400         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4401         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4402      } Elm_Bg_Option;
4403
4404    /**
4405     * Add a new background to the parent
4406     *
4407     * @param parent The parent object
4408     * @return The new object or NULL if it cannot be created
4409     *
4410     * @ingroup Bg
4411     */
4412    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4413
4414    /**
4415     * Set the file (image or edje) used for the background
4416     *
4417     * @param obj The bg object
4418     * @param file The file path
4419     * @param group Optional key (group in Edje) within the file
4420     *
4421     * This sets the image file used in the background object. The image (or edje)
4422     * will be stretched (retaining aspect if its an image file) to completely fill
4423     * the bg object. This may mean some parts are not visible.
4424     *
4425     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4426     * even if @p file is NULL.
4427     *
4428     * @ingroup Bg
4429     */
4430    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4431
4432    /**
4433     * Get the file (image or edje) used for the background
4434     *
4435     * @param obj The bg object
4436     * @param file The file path
4437     * @param group Optional key (group in Edje) within the file
4438     *
4439     * @ingroup Bg
4440     */
4441    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4442
4443    /**
4444     * Set the option used for the background image
4445     *
4446     * @param obj The bg object
4447     * @param option The desired background option (TILE, SCALE)
4448     *
4449     * This sets the option used for manipulating the display of the background
4450     * image. The image can be tiled or scaled.
4451     *
4452     * @ingroup Bg
4453     */
4454    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4455
4456    /**
4457     * Get the option used for the background image
4458     *
4459     * @param obj The bg object
4460     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4461     *
4462     * @ingroup Bg
4463     */
4464    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4465    /**
4466     * Set the option used for the background color
4467     *
4468     * @param obj The bg object
4469     * @param r
4470     * @param g
4471     * @param b
4472     *
4473     * This sets the color used for the background rectangle. Its range goes
4474     * from 0 to 255.
4475     *
4476     * @ingroup Bg
4477     */
4478    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4479    /**
4480     * Get the option used for the background color
4481     *
4482     * @param obj The bg object
4483     * @param r
4484     * @param g
4485     * @param b
4486     *
4487     * @ingroup Bg
4488     */
4489    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4490
4491    /**
4492     * Set the overlay object used for the background object.
4493     *
4494     * @param obj The bg object
4495     * @param overlay The overlay object
4496     *
4497     * This provides a way for elm_bg to have an 'overlay' that will be on top
4498     * of the bg. Once the over object is set, a previously set one will be
4499     * deleted, even if you set the new one to NULL. If you want to keep that
4500     * old content object, use the elm_bg_overlay_unset() function.
4501     *
4502     * @ingroup Bg
4503     */
4504
4505    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4506
4507    /**
4508     * Get the overlay object used for the background object.
4509     *
4510     * @param obj The bg object
4511     * @return The content that is being used
4512     *
4513     * Return the content object which is set for this widget
4514     *
4515     * @ingroup Bg
4516     */
4517    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4518
4519    /**
4520     * Get the overlay object used for the background object.
4521     *
4522     * @param obj The bg object
4523     * @return The content that was being used
4524     *
4525     * Unparent and return the overlay object which was set for this widget
4526     *
4527     * @ingroup Bg
4528     */
4529    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4530
4531    /**
4532     * Set the size of the pixmap representation of the image.
4533     *
4534     * This option just makes sense if an image is going to be set in the bg.
4535     *
4536     * @param obj The bg object
4537     * @param w The new width of the image pixmap representation.
4538     * @param h The new height of the image pixmap representation.
4539     *
4540     * This function sets a new size for pixmap representation of the given bg
4541     * image. It allows the image to be loaded already in the specified size,
4542     * reducing the memory usage and load time when loading a big image with load
4543     * size set to a smaller size.
4544     *
4545     * NOTE: this is just a hint, the real size of the pixmap may differ
4546     * depending on the type of image being loaded, being bigger than requested.
4547     *
4548     * @ingroup Bg
4549     */
4550    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4551    /* smart callbacks called:
4552     */
4553
4554    /**
4555     * @defgroup Icon Icon
4556     *
4557     * @image html img/widget/icon/preview-00.png
4558     * @image latex img/widget/icon/preview-00.eps
4559     *
4560     * An object that provides standard icon images (delete, edit, arrows, etc.)
4561     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4562     *
4563     * The icon image requested can be in the elementary theme, or in the
4564     * freedesktop.org paths. It's possible to set the order of preference from
4565     * where the image will be used.
4566     *
4567     * This API is very similar to @ref Image, but with ready to use images.
4568     *
4569     * Default images provided by the theme are described below.
4570     *
4571     * The first list contains icons that were first intended to be used in
4572     * toolbars, but can be used in many other places too:
4573     * @li home
4574     * @li close
4575     * @li apps
4576     * @li arrow_up
4577     * @li arrow_down
4578     * @li arrow_left
4579     * @li arrow_right
4580     * @li chat
4581     * @li clock
4582     * @li delete
4583     * @li edit
4584     * @li refresh
4585     * @li folder
4586     * @li file
4587     *
4588     * Now some icons that were designed to be used in menus (but again, you can
4589     * use them anywhere else):
4590     * @li menu/home
4591     * @li menu/close
4592     * @li menu/apps
4593     * @li menu/arrow_up
4594     * @li menu/arrow_down
4595     * @li menu/arrow_left
4596     * @li menu/arrow_right
4597     * @li menu/chat
4598     * @li menu/clock
4599     * @li menu/delete
4600     * @li menu/edit
4601     * @li menu/refresh
4602     * @li menu/folder
4603     * @li menu/file
4604     *
4605     * And here we have some media player specific icons:
4606     * @li media_player/forward
4607     * @li media_player/info
4608     * @li media_player/next
4609     * @li media_player/pause
4610     * @li media_player/play
4611     * @li media_player/prev
4612     * @li media_player/rewind
4613     * @li media_player/stop
4614     *
4615     * Signals that you can add callbacks for are:
4616     *
4617     * "clicked" - This is called when a user has clicked the icon
4618     *
4619     * An example of usage for this API follows:
4620     * @li @ref tutorial_icon
4621     */
4622
4623    /**
4624     * @addtogroup Icon
4625     * @{
4626     */
4627
4628    typedef enum _Elm_Icon_Type
4629      {
4630         ELM_ICON_NONE,
4631         ELM_ICON_FILE,
4632         ELM_ICON_STANDARD
4633      } Elm_Icon_Type;
4634    /**
4635     * @enum _Elm_Icon_Lookup_Order
4636     * @typedef Elm_Icon_Lookup_Order
4637     *
4638     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4639     * theme, FDO paths, or both?
4640     *
4641     * @ingroup Icon
4642     */
4643    typedef enum _Elm_Icon_Lookup_Order
4644      {
4645         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4646         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4647         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4648         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4649      } Elm_Icon_Lookup_Order;
4650
4651    /**
4652     * Add a new icon object to the parent.
4653     *
4654     * @param parent The parent object
4655     * @return The new object or NULL if it cannot be created
4656     *
4657     * @see elm_icon_file_set()
4658     *
4659     * @ingroup Icon
4660     */
4661    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4662    /**
4663     * Set the file that will be used as icon.
4664     *
4665     * @param obj The icon object
4666     * @param file The path to file that will be used as icon image
4667     * @param group The group that the icon belongs to in edje file
4668     *
4669     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4670     *
4671     * @note The icon image set by this function can be changed by
4672     * elm_icon_standard_set().
4673     *
4674     * @see elm_icon_file_get()
4675     *
4676     * @ingroup Icon
4677     */
4678    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4679    /**
4680     * Set a location in memory to be used as an icon
4681     *
4682     * @param obj The icon object
4683     * @param img The binary data that will be used as an image
4684     * @param size The size of binary data @p img
4685     * @param format Optional format of @p img to pass to the image loader
4686     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4687     *
4688     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4689     *
4690     * @note The icon image set by this function can be changed by
4691     * elm_icon_standard_set().
4692     *
4693     * @ingroup Icon
4694     */
4695    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);
4696    /**
4697     * Get the file that will be used as icon.
4698     *
4699     * @param obj The icon object
4700     * @param file The path to file that will be used as icon icon image
4701     * @param group The group that the icon belongs to in edje file
4702     *
4703     * @see elm_icon_file_set()
4704     *
4705     * @ingroup Icon
4706     */
4707    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4708    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4709    /**
4710     * Set the icon by icon standards names.
4711     *
4712     * @param obj The icon object
4713     * @param name The icon name
4714     *
4715     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4716     *
4717     * For example, freedesktop.org defines standard icon names such as "home",
4718     * "network", etc. There can be different icon sets to match those icon
4719     * keys. The @p name given as parameter is one of these "keys", and will be
4720     * used to look in the freedesktop.org paths and elementary theme. One can
4721     * change the lookup order with elm_icon_order_lookup_set().
4722     *
4723     * If name is not found in any of the expected locations and it is the
4724     * absolute path of an image file, this image will be used.
4725     *
4726     * @note The icon image set by this function can be changed by
4727     * elm_icon_file_set().
4728     *
4729     * @see elm_icon_standard_get()
4730     * @see elm_icon_file_set()
4731     *
4732     * @ingroup Icon
4733     */
4734    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4735    /**
4736     * Get the icon name set by icon standard names.
4737     *
4738     * @param obj The icon object
4739     * @return The icon name
4740     *
4741     * If the icon image was set using elm_icon_file_set() instead of
4742     * elm_icon_standard_set(), then this function will return @c NULL.
4743     *
4744     * @see elm_icon_standard_set()
4745     *
4746     * @ingroup Icon
4747     */
4748    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4749    /**
4750     * Set the smooth effect for an icon object.
4751     *
4752     * @param obj The icon object
4753     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4754     * otherwise. Default is @c EINA_TRUE.
4755     *
4756     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4757     * scaling provides a better resulting image, but is slower.
4758     *
4759     * The smooth scaling should be disabled when making animations that change
4760     * the icon size, since they will be faster. Animations that don't require
4761     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4762     * is already scaled, since the scaled icon image will be cached).
4763     *
4764     * @see elm_icon_smooth_get()
4765     *
4766     * @ingroup Icon
4767     */
4768    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4769    /**
4770     * Get the smooth effect for an icon object.
4771     *
4772     * @param obj The icon object
4773     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4774     *
4775     * @see elm_icon_smooth_set()
4776     *
4777     * @ingroup Icon
4778     */
4779    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4780    /**
4781     * Disable scaling of this object.
4782     *
4783     * @param obj The icon object.
4784     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4785     * otherwise. Default is @c EINA_FALSE.
4786     *
4787     * This function disables scaling of the icon object through the function
4788     * elm_object_scale_set(). However, this does not affect the object
4789     * size/resize in any way. For that effect, take a look at
4790     * elm_icon_scale_set().
4791     *
4792     * @see elm_icon_no_scale_get()
4793     * @see elm_icon_scale_set()
4794     * @see elm_object_scale_set()
4795     *
4796     * @ingroup Icon
4797     */
4798    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4799    /**
4800     * Get whether scaling is disabled on the object.
4801     *
4802     * @param obj The icon object
4803     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4804     *
4805     * @see elm_icon_no_scale_set()
4806     *
4807     * @ingroup Icon
4808     */
4809    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4810    /**
4811     * Set if the object is (up/down) resizable.
4812     *
4813     * @param obj The icon object
4814     * @param scale_up A bool to set if the object is resizable up. Default is
4815     * @c EINA_TRUE.
4816     * @param scale_down A bool to set if the object is resizable down. Default
4817     * is @c EINA_TRUE.
4818     *
4819     * This function limits the icon object resize ability. If @p scale_up is set to
4820     * @c EINA_FALSE, the object can't have its height or width resized to a value
4821     * higher than the original icon size. Same is valid for @p scale_down.
4822     *
4823     * @see elm_icon_scale_get()
4824     *
4825     * @ingroup Icon
4826     */
4827    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4828    /**
4829     * Get if the object is (up/down) resizable.
4830     *
4831     * @param obj The icon object
4832     * @param scale_up A bool to set if the object is resizable up
4833     * @param scale_down A bool to set if the object is resizable down
4834     *
4835     * @see elm_icon_scale_set()
4836     *
4837     * @ingroup Icon
4838     */
4839    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4840    /**
4841     * Get the object's image size
4842     *
4843     * @param obj The icon object
4844     * @param w A pointer to store the width in
4845     * @param h A pointer to store the height in
4846     *
4847     * @ingroup Icon
4848     */
4849    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4850    /**
4851     * Set if the icon fill the entire object area.
4852     *
4853     * @param obj The icon object
4854     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4855     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4856     *
4857     * When the icon object is resized to a different aspect ratio from the
4858     * original icon image, the icon image will still keep its aspect. This flag
4859     * tells how the image should fill the object's area. They are: keep the
4860     * entire icon inside the limits of height and width of the object (@p
4861     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4862     * of the object, and the icon will fill the entire object (@p fill_outside
4863     * is @c EINA_TRUE).
4864     *
4865     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4866     * retain property to false. Thus, the icon image will always keep its
4867     * original aspect ratio.
4868     *
4869     * @see elm_icon_fill_outside_get()
4870     * @see elm_image_fill_outside_set()
4871     *
4872     * @ingroup Icon
4873     */
4874    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4875    /**
4876     * Get if the object is filled outside.
4877     *
4878     * @param obj The icon object
4879     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4880     *
4881     * @see elm_icon_fill_outside_set()
4882     *
4883     * @ingroup Icon
4884     */
4885    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4886    /**
4887     * Set the prescale size for the icon.
4888     *
4889     * @param obj The icon object
4890     * @param size The prescale size. This value is used for both width and
4891     * height.
4892     *
4893     * This function sets a new size for pixmap representation of the given
4894     * icon. It allows the icon to be loaded already in the specified size,
4895     * reducing the memory usage and load time when loading a big icon with load
4896     * size set to a smaller size.
4897     *
4898     * It's equivalent to the elm_bg_load_size_set() function for bg.
4899     *
4900     * @note this is just a hint, the real size of the pixmap may differ
4901     * depending on the type of icon being loaded, being bigger than requested.
4902     *
4903     * @see elm_icon_prescale_get()
4904     * @see elm_bg_load_size_set()
4905     *
4906     * @ingroup Icon
4907     */
4908    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4909    /**
4910     * Get the prescale size for the icon.
4911     *
4912     * @param obj The icon object
4913     * @return The prescale size
4914     *
4915     * @see elm_icon_prescale_set()
4916     *
4917     * @ingroup Icon
4918     */
4919    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4920    /**
4921     * Sets the icon lookup order used by elm_icon_standard_set().
4922     *
4923     * @param obj The icon object
4924     * @param order The icon lookup order (can be one of
4925     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4926     * or ELM_ICON_LOOKUP_THEME)
4927     *
4928     * @see elm_icon_order_lookup_get()
4929     * @see Elm_Icon_Lookup_Order
4930     *
4931     * @ingroup Icon
4932     */
4933    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4934    /**
4935     * Gets the icon lookup order.
4936     *
4937     * @param obj The icon object
4938     * @return The icon lookup order
4939     *
4940     * @see elm_icon_order_lookup_set()
4941     * @see Elm_Icon_Lookup_Order
4942     *
4943     * @ingroup Icon
4944     */
4945    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4946    /**
4947     * Get if the icon supports animation or not.
4948     *
4949     * @param obj The icon object
4950     * @return @c EINA_TRUE if the icon supports animation,
4951     *         @c EINA_FALSE otherwise.
4952     *
4953     * Return if this elm icon's image can be animated. Currently Evas only
4954     * supports gif animation. If the return value is EINA_FALSE, other
4955     * elm_icon_animated_XXX APIs won't work.
4956     * @ingroup Icon
4957     */
4958    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4959    /**
4960     * Set animation mode of the icon.
4961     *
4962     * @param obj The icon object
4963     * @param anim @c EINA_TRUE if the object do animation job,
4964     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4965     *
4966     * Even though elm icon's file can be animated,
4967     * sometimes appication developer want to just first page of image.
4968     * In that time, don't call this function, because default value is EINA_FALSE
4969     * Only when you want icon support anition,
4970     * use this function and set animated to EINA_TURE
4971     * @ingroup Icon
4972     */
4973    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4974    /**
4975     * Get animation mode of the icon.
4976     *
4977     * @param obj The icon object
4978     * @return The animation mode of the icon object
4979     * @see elm_icon_animated_set
4980     * @ingroup Icon
4981     */
4982    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4983    /**
4984     * Set animation play mode of the icon.
4985     *
4986     * @param obj The icon object
4987     * @param play @c EINA_TRUE the object play animation images,
4988     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4989     *
4990     * If you want to play elm icon's animation, you set play to EINA_TURE.
4991     * For example, you make gif player using this set/get API and click event.
4992     *
4993     * 1. Click event occurs
4994     * 2. Check play flag using elm_icon_animaged_play_get
4995     * 3. If elm icon was playing, set play to EINA_FALSE.
4996     *    Then animation will be stopped and vice versa
4997     * @ingroup Icon
4998     */
4999    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5000    /**
5001     * Get animation play mode of the icon.
5002     *
5003     * @param obj The icon object
5004     * @return The play mode of the icon object
5005     *
5006     * @see elm_icon_animated_lay_get
5007     * @ingroup Icon
5008     */
5009    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5010
5011    /**
5012     * @}
5013     */
5014
5015    /**
5016     * @defgroup Image Image
5017     *
5018     * @image html img/widget/image/preview-00.png
5019     * @image latex img/widget/image/preview-00.eps
5020
5021     *
5022     * An object that allows one to load an image file to it. It can be used
5023     * anywhere like any other elementary widget.
5024     *
5025     * This widget provides most of the functionality provided from @ref Bg or @ref
5026     * Icon, but with a slightly different API (use the one that fits better your
5027     * needs).
5028     *
5029     * The features not provided by those two other image widgets are:
5030     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5031     * @li change the object orientation with elm_image_orient_set();
5032     * @li and turning the image editable with elm_image_editable_set().
5033     *
5034     * Signals that you can add callbacks for are:
5035     *
5036     * @li @c "clicked" - This is called when a user has clicked the image
5037     *
5038     * An example of usage for this API follows:
5039     * @li @ref tutorial_image
5040     */
5041
5042    /**
5043     * @addtogroup Image
5044     * @{
5045     */
5046
5047    /**
5048     * @enum _Elm_Image_Orient
5049     * @typedef Elm_Image_Orient
5050     *
5051     * Possible orientation options for elm_image_orient_set().
5052     *
5053     * @image html elm_image_orient_set.png
5054     * @image latex elm_image_orient_set.eps width=\textwidth
5055     *
5056     * @ingroup Image
5057     */
5058    typedef enum _Elm_Image_Orient
5059      {
5060         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5061         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5062         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5063         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5064         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5065         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5066         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5067         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5068      } Elm_Image_Orient;
5069
5070    /**
5071     * Add a new image to the parent.
5072     *
5073     * @param parent The parent object
5074     * @return The new object or NULL if it cannot be created
5075     *
5076     * @see elm_image_file_set()
5077     *
5078     * @ingroup Image
5079     */
5080    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5081    /**
5082     * Set the file that will be used as image.
5083     *
5084     * @param obj The image object
5085     * @param file The path to file that will be used as image
5086     * @param group The group that the image belongs in edje file (if it's an
5087     * edje image)
5088     *
5089     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5090     *
5091     * @see elm_image_file_get()
5092     *
5093     * @ingroup Image
5094     */
5095    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5096    /**
5097     * Get the file that will be used as image.
5098     *
5099     * @param obj The image object
5100     * @param file The path to file
5101     * @param group The group that the image belongs in edje file
5102     *
5103     * @see elm_image_file_set()
5104     *
5105     * @ingroup Image
5106     */
5107    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5108    /**
5109     * Set the smooth effect for an image.
5110     *
5111     * @param obj The image object
5112     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5113     * otherwise. Default is @c EINA_TRUE.
5114     *
5115     * Set the scaling algorithm to be used when scaling the image. Smooth
5116     * scaling provides a better resulting image, but is slower.
5117     *
5118     * The smooth scaling should be disabled when making animations that change
5119     * the image size, since it will be faster. Animations that don't require
5120     * resizing of the image can keep the smooth scaling enabled (even if the
5121     * image is already scaled, since the scaled image will be cached).
5122     *
5123     * @see elm_image_smooth_get()
5124     *
5125     * @ingroup Image
5126     */
5127    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5128    /**
5129     * Get the smooth effect for an image.
5130     *
5131     * @param obj The image object
5132     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5133     *
5134     * @see elm_image_smooth_get()
5135     *
5136     * @ingroup Image
5137     */
5138    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5139    /**
5140     * Gets the current size of the image.
5141     *
5142     * @param obj The image object.
5143     * @param w Pointer to store width, or NULL.
5144     * @param h Pointer to store height, or NULL.
5145     *
5146     * This is the real size of the image, not the size of the object.
5147     *
5148     * On error, neither w or h will be written.
5149     *
5150     * @ingroup Image
5151     */
5152    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5153    /**
5154     * Disable scaling of this object.
5155     *
5156     * @param obj The image object.
5157     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5158     * otherwise. Default is @c EINA_FALSE.
5159     *
5160     * This function disables scaling of the elm_image widget through the
5161     * function elm_object_scale_set(). However, this does not affect the widget
5162     * size/resize in any way. For that effect, take a look at
5163     * elm_image_scale_set().
5164     *
5165     * @see elm_image_no_scale_get()
5166     * @see elm_image_scale_set()
5167     * @see elm_object_scale_set()
5168     *
5169     * @ingroup Image
5170     */
5171    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5172    /**
5173     * Get whether scaling is disabled on the object.
5174     *
5175     * @param obj The image object
5176     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5177     *
5178     * @see elm_image_no_scale_set()
5179     *
5180     * @ingroup Image
5181     */
5182    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5183    /**
5184     * Set if the object is (up/down) resizable.
5185     *
5186     * @param obj The image object
5187     * @param scale_up A bool to set if the object is resizable up. Default is
5188     * @c EINA_TRUE.
5189     * @param scale_down A bool to set if the object is resizable down. Default
5190     * is @c EINA_TRUE.
5191     *
5192     * This function limits the image resize ability. If @p scale_up is set to
5193     * @c EINA_FALSE, the object can't have its height or width resized to a value
5194     * higher than the original image size. Same is valid for @p scale_down.
5195     *
5196     * @see elm_image_scale_get()
5197     *
5198     * @ingroup Image
5199     */
5200    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5201    /**
5202     * Get if the object is (up/down) resizable.
5203     *
5204     * @param obj The image object
5205     * @param scale_up A bool to set if the object is resizable up
5206     * @param scale_down A bool to set if the object is resizable down
5207     *
5208     * @see elm_image_scale_set()
5209     *
5210     * @ingroup Image
5211     */
5212    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5213    /**
5214     * Set if the image fill the entire object area when keeping the aspect ratio.
5215     *
5216     * @param obj The image object
5217     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5218     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5219     *
5220     * When the image should keep its aspect ratio even if resized to another
5221     * aspect ratio, there are two possibilities to resize it: keep the entire
5222     * image inside the limits of height and width of the object (@p fill_outside
5223     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5224     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5225     *
5226     * @note This option will have no effect if
5227     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5228     *
5229     * @see elm_image_fill_outside_get()
5230     * @see elm_image_aspect_ratio_retained_set()
5231     *
5232     * @ingroup Image
5233     */
5234    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5235    /**
5236     * Get if the object is filled outside
5237     *
5238     * @param obj The image object
5239     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5240     *
5241     * @see elm_image_fill_outside_set()
5242     *
5243     * @ingroup Image
5244     */
5245    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5246    /**
5247     * Set the prescale size for the image
5248     *
5249     * @param obj The image object
5250     * @param size The prescale size. This value is used for both width and
5251     * height.
5252     *
5253     * This function sets a new size for pixmap representation of the given
5254     * image. It allows the image to be loaded already in the specified size,
5255     * reducing the memory usage and load time when loading a big image with load
5256     * size set to a smaller size.
5257     *
5258     * It's equivalent to the elm_bg_load_size_set() function for bg.
5259     *
5260     * @note this is just a hint, the real size of the pixmap may differ
5261     * depending on the type of image being loaded, being bigger than requested.
5262     *
5263     * @see elm_image_prescale_get()
5264     * @see elm_bg_load_size_set()
5265     *
5266     * @ingroup Image
5267     */
5268    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5269    /**
5270     * Get the prescale size for the image
5271     *
5272     * @param obj The image object
5273     * @return The prescale size
5274     *
5275     * @see elm_image_prescale_set()
5276     *
5277     * @ingroup Image
5278     */
5279    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5280    /**
5281     * Set the image orientation.
5282     *
5283     * @param obj The image object
5284     * @param orient The image orientation
5285     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5286     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5287     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5288     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5289     *  Default is #ELM_IMAGE_ORIENT_NONE.
5290     *
5291     * This function allows to rotate or flip the given image.
5292     *
5293     * @see elm_image_orient_get()
5294     * @see @ref Elm_Image_Orient
5295     *
5296     * @ingroup Image
5297     */
5298    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5299    /**
5300     * Get the image orientation.
5301     *
5302     * @param obj The image object
5303     * @return The image orientation
5304     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5305     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5306     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5307     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5308     *
5309     * @see elm_image_orient_set()
5310     * @see @ref Elm_Image_Orient
5311     *
5312     * @ingroup Image
5313     */
5314    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5315    /**
5316     * Make the image 'editable'.
5317     *
5318     * @param obj Image object.
5319     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5320     *
5321     * This means the image is a valid drag target for drag and drop, and can be
5322     * cut or pasted too.
5323     *
5324     * @ingroup Image
5325     */
5326    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5327    /**
5328     * Make the image 'editable'.
5329     *
5330     * @param obj Image object.
5331     * @return Editability.
5332     *
5333     * This means the image is a valid drag target for drag and drop, and can be
5334     * cut or pasted too.
5335     *
5336     * @ingroup Image
5337     */
5338    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5339    /**
5340     * Get the basic Evas_Image object from this object (widget).
5341     *
5342     * @param obj The image object to get the inlined image from
5343     * @return The inlined image object, or NULL if none exists
5344     *
5345     * This function allows one to get the underlying @c Evas_Object of type
5346     * Image from this elementary widget. It can be useful to do things like get
5347     * the pixel data, save the image to a file, etc.
5348     *
5349     * @note Be careful to not manipulate it, as it is under control of
5350     * elementary.
5351     *
5352     * @ingroup Image
5353     */
5354    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5355    /**
5356     * Set whether the original aspect ratio of the image should be kept on resize.
5357     *
5358     * @param obj The image object.
5359     * @param retained @c EINA_TRUE if the image should retain the aspect,
5360     * @c EINA_FALSE otherwise.
5361     *
5362     * The original aspect ratio (width / height) of the image is usually
5363     * distorted to match the object's size. Enabling this option will retain
5364     * this original aspect, and the way that the image is fit into the object's
5365     * area depends on the option set by elm_image_fill_outside_set().
5366     *
5367     * @see elm_image_aspect_ratio_retained_get()
5368     * @see elm_image_fill_outside_set()
5369     *
5370     * @ingroup Image
5371     */
5372    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5373    /**
5374     * Get if the object retains the original aspect ratio.
5375     *
5376     * @param obj The image object.
5377     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5378     * otherwise.
5379     *
5380     * @ingroup Image
5381     */
5382    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5383
5384    /**
5385     * @}
5386     */
5387
5388    /* glview */
5389    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5390
5391    typedef enum _Elm_GLView_Mode
5392      {
5393         ELM_GLVIEW_ALPHA   = 1,
5394         ELM_GLVIEW_DEPTH   = 2,
5395         ELM_GLVIEW_STENCIL = 4
5396      } Elm_GLView_Mode;
5397
5398    /**
5399     * Defines a policy for the glview resizing.
5400     *
5401     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5402     */
5403    typedef enum _Elm_GLView_Resize_Policy
5404      {
5405         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5406         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5407      } Elm_GLView_Resize_Policy;
5408
5409    typedef enum _Elm_GLView_Render_Policy
5410      {
5411         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5412         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5413      } Elm_GLView_Render_Policy;
5414
5415    /**
5416     * @defgroup GLView
5417     *
5418     * A simple GLView widget that allows GL rendering.
5419     *
5420     * Signals that you can add callbacks for are:
5421     *
5422     * @{
5423     */
5424
5425    /**
5426     * Add a new glview to the parent
5427     *
5428     * @param parent The parent object
5429     * @return The new object or NULL if it cannot be created
5430     *
5431     * @ingroup GLView
5432     */
5433    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5434
5435    /**
5436     * Sets the size of the glview
5437     *
5438     * @param obj The glview object
5439     * @param width width of the glview object
5440     * @param height height of the glview object
5441     *
5442     * @ingroup GLView
5443     */
5444    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5445
5446    /**
5447     * Gets the size of the glview.
5448     *
5449     * @param obj The glview object
5450     * @param width width of the glview object
5451     * @param height height of the glview object
5452     *
5453     * Note that this function returns the actual image size of the
5454     * glview.  This means that when the scale policy is set to
5455     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5456     * size.
5457     *
5458     * @ingroup GLView
5459     */
5460    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5461
5462    /**
5463     * Gets the gl api struct for gl rendering
5464     *
5465     * @param obj The glview object
5466     * @return The api object or NULL if it cannot be created
5467     *
5468     * @ingroup GLView
5469     */
5470    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5471
5472    /**
5473     * Set the mode of the GLView. Supports Three simple modes.
5474     *
5475     * @param obj The glview object
5476     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5477     * @return True if set properly.
5478     *
5479     * @ingroup GLView
5480     */
5481    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5482
5483    /**
5484     * Set the resize policy for the glview object.
5485     *
5486     * @param obj The glview object.
5487     * @param policy The scaling policy.
5488     *
5489     * By default, the resize policy is set to
5490     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5491     * destroys the previous surface and recreates the newly specified
5492     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5493     * however, glview only scales the image object and not the underlying
5494     * GL Surface.
5495     *
5496     * @ingroup GLView
5497     */
5498    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5499
5500    /**
5501     * Set the render policy for the glview object.
5502     *
5503     * @param obj The glview object.
5504     * @param policy The render policy.
5505     *
5506     * By default, the render policy is set to
5507     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5508     * that during the render loop, glview is only redrawn if it needs
5509     * to be redrawn. (i.e. When it is visible) If the policy is set to
5510     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5511     * whether it is visible/need redrawing or not.
5512     *
5513     * @ingroup GLView
5514     */
5515    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5516
5517    /**
5518     * Set the init function that runs once in the main loop.
5519     *
5520     * @param obj The glview object.
5521     * @param func The init function to be registered.
5522     *
5523     * The registered init function gets called once during the render loop.
5524     *
5525     * @ingroup GLView
5526     */
5527    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5528
5529    /**
5530     * Set the render function that runs in the main loop.
5531     *
5532     * @param obj The glview object.
5533     * @param func The delete function to be registered.
5534     *
5535     * The registered del function gets called when GLView object is deleted.
5536     *
5537     * @ingroup GLView
5538     */
5539    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5540
5541    /**
5542     * Set the resize function that gets called when resize happens.
5543     *
5544     * @param obj The glview object.
5545     * @param func The resize function to be registered.
5546     *
5547     * @ingroup GLView
5548     */
5549    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5550
5551    /**
5552     * Set the render function that runs in the main loop.
5553     *
5554     * @param obj The glview object.
5555     * @param func The render function to be registered.
5556     *
5557     * @ingroup GLView
5558     */
5559    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5560
5561    /**
5562     * Notifies that there has been changes in the GLView.
5563     *
5564     * @param obj The glview object.
5565     *
5566     * @ingroup GLView
5567     */
5568    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5569
5570    /**
5571     * @}
5572     */
5573
5574    /* box */
5575    /**
5576     * @defgroup Box Box
5577     *
5578     * @image html img/widget/box/preview-00.png
5579     * @image latex img/widget/box/preview-00.eps width=\textwidth
5580     *
5581     * @image html img/box.png
5582     * @image latex img/box.eps width=\textwidth
5583     *
5584     * A box arranges objects in a linear fashion, governed by a layout function
5585     * that defines the details of this arrangement.
5586     *
5587     * By default, the box will use an internal function to set the layout to
5588     * a single row, either vertical or horizontal. This layout is affected
5589     * by a number of parameters, such as the homogeneous flag set by
5590     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5591     * elm_box_align_set() and the hints set to each object in the box.
5592     *
5593     * For this default layout, it's possible to change the orientation with
5594     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5595     * placing its elements ordered from top to bottom. When horizontal is set,
5596     * the order will go from left to right. If the box is set to be
5597     * homogeneous, every object in it will be assigned the same space, that
5598     * of the largest object. Padding can be used to set some spacing between
5599     * the cell given to each object. The alignment of the box, set with
5600     * elm_box_align_set(), determines how the bounding box of all the elements
5601     * will be placed within the space given to the box widget itself.
5602     *
5603     * The size hints of each object also affect how they are placed and sized
5604     * within the box. evas_object_size_hint_min_set() will give the minimum
5605     * size the object can have, and the box will use it as the basis for all
5606     * latter calculations. Elementary widgets set their own minimum size as
5607     * needed, so there's rarely any need to use it manually.
5608     *
5609     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5610     * used to tell whether the object will be allocated the minimum size it
5611     * needs or if the space given to it should be expanded. It's important
5612     * to realize that expanding the size given to the object is not the same
5613     * thing as resizing the object. It could very well end being a small
5614     * widget floating in a much larger empty space. If not set, the weight
5615     * for objects will normally be 0.0 for both axis, meaning the widget will
5616     * not be expanded. To take as much space possible, set the weight to
5617     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5618     *
5619     * Besides how much space each object is allocated, it's possible to control
5620     * how the widget will be placed within that space using
5621     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5622     * for both axis, meaning the object will be centered, but any value from
5623     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5624     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5625     * is -1.0, means the object will be resized to fill the entire space it
5626     * was allocated.
5627     *
5628     * In addition, customized functions to define the layout can be set, which
5629     * allow the application developer to organize the objects within the box
5630     * in any number of ways.
5631     *
5632     * The special elm_box_layout_transition() function can be used
5633     * to switch from one layout to another, animating the motion of the
5634     * children of the box.
5635     *
5636     * @note Objects should not be added to box objects using _add() calls.
5637     *
5638     * Some examples on how to use boxes follow:
5639     * @li @ref box_example_01
5640     * @li @ref box_example_02
5641     *
5642     * @{
5643     */
5644    /**
5645     * @typedef Elm_Box_Transition
5646     *
5647     * Opaque handler containing the parameters to perform an animated
5648     * transition of the layout the box uses.
5649     *
5650     * @see elm_box_transition_new()
5651     * @see elm_box_layout_set()
5652     * @see elm_box_layout_transition()
5653     */
5654    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5655
5656    /**
5657     * Add a new box to the parent
5658     *
5659     * By default, the box will be in vertical mode and non-homogeneous.
5660     *
5661     * @param parent The parent object
5662     * @return The new object or NULL if it cannot be created
5663     */
5664    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5665    /**
5666     * Set the horizontal orientation
5667     *
5668     * By default, box object arranges their contents vertically from top to
5669     * bottom.
5670     * By calling this function with @p horizontal as EINA_TRUE, the box will
5671     * become horizontal, arranging contents from left to right.
5672     *
5673     * @note This flag is ignored if a custom layout function is set.
5674     *
5675     * @param obj The box object
5676     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5677     * EINA_FALSE = vertical)
5678     */
5679    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5680    /**
5681     * Get the horizontal orientation
5682     *
5683     * @param obj The box object
5684     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5685     */
5686    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5687    /**
5688     * Set the box to arrange its children homogeneously
5689     *
5690     * If enabled, homogeneous layout makes all items the same size, according
5691     * to the size of the largest of its children.
5692     *
5693     * @note This flag is ignored if a custom layout function is set.
5694     *
5695     * @param obj The box object
5696     * @param homogeneous The homogeneous flag
5697     */
5698    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5699    /**
5700     * Get whether the box is using homogeneous mode or not
5701     *
5702     * @param obj The box object
5703     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5704     */
5705    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5706    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5707    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5708    /**
5709     * Add an object to the beginning of the pack list
5710     *
5711     * Pack @p subobj into the box @p obj, placing it first in the list of
5712     * children objects. The actual position the object will get on screen
5713     * depends on the layout used. If no custom layout is set, it will be at
5714     * the top or left, depending if the box is vertical or horizontal,
5715     * respectively.
5716     *
5717     * @param obj The box object
5718     * @param subobj The object to add to the box
5719     *
5720     * @see elm_box_pack_end()
5721     * @see elm_box_pack_before()
5722     * @see elm_box_pack_after()
5723     * @see elm_box_unpack()
5724     * @see elm_box_unpack_all()
5725     * @see elm_box_clear()
5726     */
5727    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5728    /**
5729     * Add an object at the end of the pack list
5730     *
5731     * Pack @p subobj into the box @p obj, placing it last in the list of
5732     * children objects. The actual position the object will get on screen
5733     * depends on the layout used. If no custom layout is set, it will be at
5734     * the bottom or right, depending if the box is vertical or horizontal,
5735     * respectively.
5736     *
5737     * @param obj The box object
5738     * @param subobj The object to add to the box
5739     *
5740     * @see elm_box_pack_start()
5741     * @see elm_box_pack_before()
5742     * @see elm_box_pack_after()
5743     * @see elm_box_unpack()
5744     * @see elm_box_unpack_all()
5745     * @see elm_box_clear()
5746     */
5747    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5748    /**
5749     * Adds an object to the box before the indicated object
5750     *
5751     * This will add the @p subobj to the box indicated before the object
5752     * indicated with @p before. If @p before is not already in the box, results
5753     * are undefined. Before means either to the left of the indicated object or
5754     * above it depending on orientation.
5755     *
5756     * @param obj The box object
5757     * @param subobj The object to add to the box
5758     * @param before The object before which to add it
5759     *
5760     * @see elm_box_pack_start()
5761     * @see elm_box_pack_end()
5762     * @see elm_box_pack_after()
5763     * @see elm_box_unpack()
5764     * @see elm_box_unpack_all()
5765     * @see elm_box_clear()
5766     */
5767    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5768    /**
5769     * Adds an object to the box after the indicated object
5770     *
5771     * This will add the @p subobj to the box indicated after the object
5772     * indicated with @p after. If @p after is not already in the box, results
5773     * are undefined. After means either to the right of the indicated object or
5774     * below it depending on orientation.
5775     *
5776     * @param obj The box object
5777     * @param subobj The object to add to the box
5778     * @param after The object after which to add it
5779     *
5780     * @see elm_box_pack_start()
5781     * @see elm_box_pack_end()
5782     * @see elm_box_pack_before()
5783     * @see elm_box_unpack()
5784     * @see elm_box_unpack_all()
5785     * @see elm_box_clear()
5786     */
5787    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5788    /**
5789     * Clear the box of all children
5790     *
5791     * Remove all the elements contained by the box, deleting the respective
5792     * objects.
5793     *
5794     * @param obj The box object
5795     *
5796     * @see elm_box_unpack()
5797     * @see elm_box_unpack_all()
5798     */
5799    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5800    /**
5801     * Unpack a box item
5802     *
5803     * Remove the object given by @p subobj from the box @p obj without
5804     * deleting it.
5805     *
5806     * @param obj The box object
5807     *
5808     * @see elm_box_unpack_all()
5809     * @see elm_box_clear()
5810     */
5811    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5812    /**
5813     * Remove all items from the box, without deleting them
5814     *
5815     * Clear the box from all children, but don't delete the respective objects.
5816     * If no other references of the box children exist, the objects will never
5817     * be deleted, and thus the application will leak the memory. Make sure
5818     * when using this function that you hold a reference to all the objects
5819     * in the box @p obj.
5820     *
5821     * @param obj The box object
5822     *
5823     * @see elm_box_clear()
5824     * @see elm_box_unpack()
5825     */
5826    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5827    /**
5828     * Retrieve a list of the objects packed into the box
5829     *
5830     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5831     * The order of the list corresponds to the packing order the box uses.
5832     *
5833     * You must free this list with eina_list_free() once you are done with it.
5834     *
5835     * @param obj The box object
5836     */
5837    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5838    /**
5839     * Set the space (padding) between the box's elements.
5840     *
5841     * Extra space in pixels that will be added between a box child and its
5842     * neighbors after its containing cell has been calculated. This padding
5843     * is set for all elements in the box, besides any possible padding that
5844     * individual elements may have through their size hints.
5845     *
5846     * @param obj The box object
5847     * @param horizontal The horizontal space between elements
5848     * @param vertical The vertical space between elements
5849     */
5850    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5851    /**
5852     * Get the space (padding) between the box's elements.
5853     *
5854     * @param obj The box object
5855     * @param horizontal The horizontal space between elements
5856     * @param vertical The vertical space between elements
5857     *
5858     * @see elm_box_padding_set()
5859     */
5860    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5861    /**
5862     * Set the alignment of the whole bouding box of contents.
5863     *
5864     * Sets how the bounding box containing all the elements of the box, after
5865     * their sizes and position has been calculated, will be aligned within
5866     * the space given for the whole box widget.
5867     *
5868     * @param obj The box object
5869     * @param horizontal The horizontal alignment of elements
5870     * @param vertical The vertical alignment of elements
5871     */
5872    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5873    /**
5874     * Get the alignment of the whole bouding box of contents.
5875     *
5876     * @param obj The box object
5877     * @param horizontal The horizontal alignment of elements
5878     * @param vertical The vertical alignment of elements
5879     *
5880     * @see elm_box_align_set()
5881     */
5882    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5883
5884    /**
5885     * Force the box to recalculate its children packing.
5886     *
5887     * If any children was added or removed, box will not calculate the
5888     * values immediately rather leaving it to the next main loop
5889     * iteration. While this is great as it would save lots of
5890     * recalculation, whenever you need to get the position of a just
5891     * added item you must force recalculate before doing so.
5892     *
5893     * @param obj The box object.
5894     */
5895    EAPI void                 elm_box_recalculate(Evas_Object *obj);
5896
5897    /**
5898     * Set the layout defining function to be used by the box
5899     *
5900     * Whenever anything changes that requires the box in @p obj to recalculate
5901     * the size and position of its elements, the function @p cb will be called
5902     * to determine what the layout of the children will be.
5903     *
5904     * Once a custom function is set, everything about the children layout
5905     * is defined by it. The flags set by elm_box_horizontal_set() and
5906     * elm_box_homogeneous_set() no longer have any meaning, and the values
5907     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5908     * layout function to decide if they are used and how. These last two
5909     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5910     * passed to @p cb. The @c Evas_Object the function receives is not the
5911     * Elementary widget, but the internal Evas Box it uses, so none of the
5912     * functions described here can be used on it.
5913     *
5914     * Any of the layout functions in @c Evas can be used here, as well as the
5915     * special elm_box_layout_transition().
5916     *
5917     * The final @p data argument received by @p cb is the same @p data passed
5918     * here, and the @p free_data function will be called to free it
5919     * whenever the box is destroyed or another layout function is set.
5920     *
5921     * Setting @p cb to NULL will revert back to the default layout function.
5922     *
5923     * @param obj The box object
5924     * @param cb The callback function used for layout
5925     * @param data Data that will be passed to layout function
5926     * @param free_data Function called to free @p data
5927     *
5928     * @see elm_box_layout_transition()
5929     */
5930    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);
5931    /**
5932     * Special layout function that animates the transition from one layout to another
5933     *
5934     * Normally, when switching the layout function for a box, this will be
5935     * reflected immediately on screen on the next render, but it's also
5936     * possible to do this through an animated transition.
5937     *
5938     * This is done by creating an ::Elm_Box_Transition and setting the box
5939     * layout to this function.
5940     *
5941     * For example:
5942     * @code
5943     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5944     *                            evas_object_box_layout_vertical, // start
5945     *                            NULL, // data for initial layout
5946     *                            NULL, // free function for initial data
5947     *                            evas_object_box_layout_horizontal, // end
5948     *                            NULL, // data for final layout
5949     *                            NULL, // free function for final data
5950     *                            anim_end, // will be called when animation ends
5951     *                            NULL); // data for anim_end function\
5952     * elm_box_layout_set(box, elm_box_layout_transition, t,
5953     *                    elm_box_transition_free);
5954     * @endcode
5955     *
5956     * @note This function can only be used with elm_box_layout_set(). Calling
5957     * it directly will not have the expected results.
5958     *
5959     * @see elm_box_transition_new
5960     * @see elm_box_transition_free
5961     * @see elm_box_layout_set
5962     */
5963    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5964    /**
5965     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5966     *
5967     * If you want to animate the change from one layout to another, you need
5968     * to set the layout function of the box to elm_box_layout_transition(),
5969     * passing as user data to it an instance of ::Elm_Box_Transition with the
5970     * necessary information to perform this animation. The free function to
5971     * set for the layout is elm_box_transition_free().
5972     *
5973     * The parameters to create an ::Elm_Box_Transition sum up to how long
5974     * will it be, in seconds, a layout function to describe the initial point,
5975     * another for the final position of the children and one function to be
5976     * called when the whole animation ends. This last function is useful to
5977     * set the definitive layout for the box, usually the same as the end
5978     * layout for the animation, but could be used to start another transition.
5979     *
5980     * @param start_layout The layout function that will be used to start the animation
5981     * @param start_layout_data The data to be passed the @p start_layout function
5982     * @param start_layout_free_data Function to free @p start_layout_data
5983     * @param end_layout The layout function that will be used to end the animation
5984     * @param end_layout_free_data The data to be passed the @p end_layout function
5985     * @param end_layout_free_data Function to free @p end_layout_data
5986     * @param transition_end_cb Callback function called when animation ends
5987     * @param transition_end_data Data to be passed to @p transition_end_cb
5988     * @return An instance of ::Elm_Box_Transition
5989     *
5990     * @see elm_box_transition_new
5991     * @see elm_box_layout_transition
5992     */
5993    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);
5994    /**
5995     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5996     *
5997     * This function is mostly useful as the @c free_data parameter in
5998     * elm_box_layout_set() when elm_box_layout_transition().
5999     *
6000     * @param data The Elm_Box_Transition instance to be freed.
6001     *
6002     * @see elm_box_transition_new
6003     * @see elm_box_layout_transition
6004     */
6005    EAPI void                elm_box_transition_free(void *data);
6006    /**
6007     * @}
6008     */
6009
6010    /* button */
6011    /**
6012     * @defgroup Button Button
6013     *
6014     * @image html img/widget/button/preview-00.png
6015     * @image latex img/widget/button/preview-00.eps
6016     * @image html img/widget/button/preview-01.png
6017     * @image latex img/widget/button/preview-01.eps
6018     * @image html img/widget/button/preview-02.png
6019     * @image latex img/widget/button/preview-02.eps
6020     *
6021     * This is a push-button. Press it and run some function. It can contain
6022     * a simple label and icon object and it also has an autorepeat feature.
6023     *
6024     * This widgets emits the following signals:
6025     * @li "clicked": the user clicked the button (press/release).
6026     * @li "repeated": the user pressed the button without releasing it.
6027     * @li "pressed": button was pressed.
6028     * @li "unpressed": button was released after being pressed.
6029     * In all three cases, the @c event parameter of the callback will be
6030     * @c NULL.
6031     *
6032     * Also, defined in the default theme, the button has the following styles
6033     * available:
6034     * @li default: a normal button.
6035     * @li anchor: Like default, but the button fades away when the mouse is not
6036     * over it, leaving only the text or icon.
6037     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6038     * continuous look across its options.
6039     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6040     *
6041     * Follow through a complete example @ref button_example_01 "here".
6042     * @{
6043     */
6044    /**
6045     * Add a new button to the parent's canvas
6046     *
6047     * @param parent The parent object
6048     * @return The new object or NULL if it cannot be created
6049     */
6050    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6051    /**
6052     * Set the label used in the button
6053     *
6054     * The passed @p label can be NULL to clean any existing text in it and
6055     * leave the button as an icon only object.
6056     *
6057     * @param obj The button object
6058     * @param label The text will be written on the button
6059     * @deprecated use elm_object_text_set() instead.
6060     */
6061    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6062    /**
6063     * Get the label set for the button
6064     *
6065     * The string returned is an internal pointer and should not be freed or
6066     * altered. It will also become invalid when the button is destroyed.
6067     * The string returned, if not NULL, is a stringshare, so if you need to
6068     * keep it around even after the button is destroyed, you can use
6069     * eina_stringshare_ref().
6070     *
6071     * @param obj The button object
6072     * @return The text set to the label, or NULL if nothing is set
6073     * @deprecated use elm_object_text_set() instead.
6074     */
6075    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6076    /**
6077     * Set the icon used for the button
6078     *
6079     * Setting a new icon will delete any other that was previously set, making
6080     * any reference to them invalid. If you need to maintain the previous
6081     * object alive, unset it first with elm_button_icon_unset().
6082     *
6083     * @param obj The button object
6084     * @param icon The icon object for the button
6085     */
6086    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6087    /**
6088     * Get the icon used for the button
6089     *
6090     * Return the icon object which is set for this widget. If the button is
6091     * destroyed or another icon is set, the returned object will be deleted
6092     * and any reference to it will be invalid.
6093     *
6094     * @param obj The button object
6095     * @return The icon object that is being used
6096     *
6097     * @see elm_button_icon_unset()
6098     */
6099    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6100    /**
6101     * Remove the icon set without deleting it and return the object
6102     *
6103     * This function drops the reference the button holds of the icon object
6104     * and returns this last object. It is used in case you want to remove any
6105     * icon, or set another one, without deleting the actual object. The button
6106     * will be left without an icon set.
6107     *
6108     * @param obj The button object
6109     * @return The icon object that was being used
6110     */
6111    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6112    /**
6113     * Turn on/off the autorepeat event generated when the button is kept pressed
6114     *
6115     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6116     * signal when they are clicked.
6117     *
6118     * When on, keeping a button pressed will continuously emit a @c repeated
6119     * signal until the button is released. The time it takes until it starts
6120     * emitting the signal is given by
6121     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6122     * new emission by elm_button_autorepeat_gap_timeout_set().
6123     *
6124     * @param obj The button object
6125     * @param on  A bool to turn on/off the event
6126     */
6127    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6128    /**
6129     * Get whether the autorepeat feature is enabled
6130     *
6131     * @param obj The button object
6132     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6133     *
6134     * @see elm_button_autorepeat_set()
6135     */
6136    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6137    /**
6138     * Set the initial timeout before the autorepeat event is generated
6139     *
6140     * Sets the timeout, in seconds, since the button is pressed until the
6141     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6142     * won't be any delay and the even will be fired the moment the button is
6143     * pressed.
6144     *
6145     * @param obj The button object
6146     * @param t   Timeout in seconds
6147     *
6148     * @see elm_button_autorepeat_set()
6149     * @see elm_button_autorepeat_gap_timeout_set()
6150     */
6151    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6152    /**
6153     * Get the initial timeout before the autorepeat event is generated
6154     *
6155     * @param obj The button object
6156     * @return Timeout in seconds
6157     *
6158     * @see elm_button_autorepeat_initial_timeout_set()
6159     */
6160    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6161    /**
6162     * Set the interval between each generated autorepeat event
6163     *
6164     * After the first @c repeated event is fired, all subsequent ones will
6165     * follow after a delay of @p t seconds for each.
6166     *
6167     * @param obj The button object
6168     * @param t   Interval in seconds
6169     *
6170     * @see elm_button_autorepeat_initial_timeout_set()
6171     */
6172    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6173    /**
6174     * Get the interval between each generated autorepeat event
6175     *
6176     * @param obj The button object
6177     * @return Interval in seconds
6178     */
6179    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6180    /**
6181     * @}
6182     */
6183
6184    /**
6185     * @defgroup File_Selector_Button File Selector Button
6186     *
6187     * @image html img/widget/fileselector_button/preview-00.png
6188     * @image latex img/widget/fileselector_button/preview-00.eps
6189     * @image html img/widget/fileselector_button/preview-01.png
6190     * @image latex img/widget/fileselector_button/preview-01.eps
6191     * @image html img/widget/fileselector_button/preview-02.png
6192     * @image latex img/widget/fileselector_button/preview-02.eps
6193     *
6194     * This is a button that, when clicked, creates an Elementary
6195     * window (or inner window) <b> with a @ref Fileselector "file
6196     * selector widget" within</b>. When a file is chosen, the (inner)
6197     * window is closed and the button emits a signal having the
6198     * selected file as it's @c event_info.
6199     *
6200     * This widget encapsulates operations on its internal file
6201     * selector on its own API. There is less control over its file
6202     * selector than that one would have instatiating one directly.
6203     *
6204     * The following styles are available for this button:
6205     * @li @c "default"
6206     * @li @c "anchor"
6207     * @li @c "hoversel_vertical"
6208     * @li @c "hoversel_vertical_entry"
6209     *
6210     * Smart callbacks one can register to:
6211     * - @c "file,chosen" - the user has selected a path, whose string
6212     *   pointer comes as the @c event_info data (a stringshared
6213     *   string)
6214     *
6215     * Here is an example on its usage:
6216     * @li @ref fileselector_button_example
6217     *
6218     * @see @ref File_Selector_Entry for a similar widget.
6219     * @{
6220     */
6221
6222    /**
6223     * Add a new file selector button widget to the given parent
6224     * Elementary (container) object
6225     *
6226     * @param parent The parent object
6227     * @return a new file selector button widget handle or @c NULL, on
6228     * errors
6229     */
6230    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6231
6232    /**
6233     * Set the label for a given file selector button widget
6234     *
6235     * @param obj The file selector button widget
6236     * @param label The text label to be displayed on @p obj
6237     *
6238     * @deprecated use elm_object_text_set() instead.
6239     */
6240    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6241
6242    /**
6243     * Get the label set for a given file selector button widget
6244     *
6245     * @param obj The file selector button widget
6246     * @return The button label
6247     *
6248     * @deprecated use elm_object_text_set() instead.
6249     */
6250    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6251
6252    /**
6253     * Set the icon on a given file selector button widget
6254     *
6255     * @param obj The file selector button widget
6256     * @param icon The icon object for the button
6257     *
6258     * Once the icon object is set, a previously set one will be
6259     * deleted. If you want to keep the latter, use the
6260     * elm_fileselector_button_icon_unset() function.
6261     *
6262     * @see elm_fileselector_button_icon_get()
6263     */
6264    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6265
6266    /**
6267     * Get the icon set for a given file selector button widget
6268     *
6269     * @param obj The file selector button widget
6270     * @return The icon object currently set on @p obj or @c NULL, if
6271     * none is
6272     *
6273     * @see elm_fileselector_button_icon_set()
6274     */
6275    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6276
6277    /**
6278     * Unset the icon used in a given file selector button widget
6279     *
6280     * @param obj The file selector button widget
6281     * @return The icon object that was being used on @p obj or @c
6282     * NULL, on errors
6283     *
6284     * Unparent and return the icon object which was set for this
6285     * widget.
6286     *
6287     * @see elm_fileselector_button_icon_set()
6288     */
6289    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6290
6291    /**
6292     * Set the title for a given file selector button widget's window
6293     *
6294     * @param obj The file selector button widget
6295     * @param title The title string
6296     *
6297     * This will change the window's title, when the file selector pops
6298     * out after a click on the button. Those windows have the default
6299     * (unlocalized) value of @c "Select a file" as titles.
6300     *
6301     * @note It will only take any effect if the file selector
6302     * button widget is @b not under "inwin mode".
6303     *
6304     * @see elm_fileselector_button_window_title_get()
6305     */
6306    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6307
6308    /**
6309     * Get the title set for a given file selector button widget's
6310     * window
6311     *
6312     * @param obj The file selector button widget
6313     * @return Title of the file selector button's window
6314     *
6315     * @see elm_fileselector_button_window_title_get() for more details
6316     */
6317    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6318
6319    /**
6320     * Set the size of a given file selector button widget's window,
6321     * holding the file selector itself.
6322     *
6323     * @param obj The file selector button widget
6324     * @param width The window's width
6325     * @param height The window's height
6326     *
6327     * @note it will only take any effect if the file selector button
6328     * widget is @b not under "inwin mode". The default size for the
6329     * window (when applicable) is 400x400 pixels.
6330     *
6331     * @see elm_fileselector_button_window_size_get()
6332     */
6333    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6334
6335    /**
6336     * Get the size of a given file selector button widget's window,
6337     * holding the file selector itself.
6338     *
6339     * @param obj The file selector button widget
6340     * @param width Pointer into which to store the width value
6341     * @param height Pointer into which to store the height value
6342     *
6343     * @note Use @c NULL pointers on the size values you're not
6344     * interested in: they'll be ignored by the function.
6345     *
6346     * @see elm_fileselector_button_window_size_set(), for more details
6347     */
6348    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6349
6350    /**
6351     * Set the initial file system path for a given file selector
6352     * button widget
6353     *
6354     * @param obj The file selector button widget
6355     * @param path The path string
6356     *
6357     * It must be a <b>directory</b> path, which will have the contents
6358     * displayed initially in the file selector's view, when invoked
6359     * from @p obj. The default initial path is the @c "HOME"
6360     * environment variable's value.
6361     *
6362     * @see elm_fileselector_button_path_get()
6363     */
6364    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6365
6366    /**
6367     * Get the initial file system path set for a given file selector
6368     * button widget
6369     *
6370     * @param obj The file selector button widget
6371     * @return path The path string
6372     *
6373     * @see elm_fileselector_button_path_set() for more details
6374     */
6375    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6376
6377    /**
6378     * Enable/disable a tree view in the given file selector button
6379     * widget's internal file selector
6380     *
6381     * @param obj The file selector button widget
6382     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6383     * disable
6384     *
6385     * This has the same effect as elm_fileselector_expandable_set(),
6386     * but now applied to a file selector button's internal file
6387     * selector.
6388     *
6389     * @note There's no way to put a file selector button's internal
6390     * file selector in "grid mode", as one may do with "pure" file
6391     * selectors.
6392     *
6393     * @see elm_fileselector_expandable_get()
6394     */
6395    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6396
6397    /**
6398     * Get whether tree view is enabled for the given file selector
6399     * button widget's internal file selector
6400     *
6401     * @param obj The file selector button widget
6402     * @return @c EINA_TRUE if @p obj widget's internal file selector
6403     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6404     *
6405     * @see elm_fileselector_expandable_set() for more details
6406     */
6407    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6408
6409    /**
6410     * Set whether a given file selector button widget's internal file
6411     * selector is to display folders only or the directory contents,
6412     * as well.
6413     *
6414     * @param obj The file selector button widget
6415     * @param only @c EINA_TRUE to make @p obj widget's internal file
6416     * selector only display directories, @c EINA_FALSE to make files
6417     * to be displayed in it too
6418     *
6419     * This has the same effect as elm_fileselector_folder_only_set(),
6420     * but now applied to a file selector button's internal file
6421     * selector.
6422     *
6423     * @see elm_fileselector_folder_only_get()
6424     */
6425    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6426
6427    /**
6428     * Get whether a given file selector button widget's internal file
6429     * selector is displaying folders only or the directory contents,
6430     * as well.
6431     *
6432     * @param obj The file selector button widget
6433     * @return @c EINA_TRUE if @p obj widget's internal file
6434     * selector is only displaying directories, @c EINA_FALSE if files
6435     * are being displayed in it too (and on errors)
6436     *
6437     * @see elm_fileselector_button_folder_only_set() for more details
6438     */
6439    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6440
6441    /**
6442     * Enable/disable the file name entry box where the user can type
6443     * in a name for a file, in a given file selector button widget's
6444     * internal file selector.
6445     *
6446     * @param obj The file selector button widget
6447     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6448     * file selector a "saving dialog", @c EINA_FALSE otherwise
6449     *
6450     * This has the same effect as elm_fileselector_is_save_set(),
6451     * but now applied to a file selector button's internal file
6452     * selector.
6453     *
6454     * @see elm_fileselector_is_save_get()
6455     */
6456    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6457
6458    /**
6459     * Get whether the given file selector button widget's internal
6460     * file selector is in "saving dialog" mode
6461     *
6462     * @param obj The file selector button widget
6463     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6464     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6465     * errors)
6466     *
6467     * @see elm_fileselector_button_is_save_set() for more details
6468     */
6469    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6470
6471    /**
6472     * Set whether a given file selector button widget's internal file
6473     * selector will raise an Elementary "inner window", instead of a
6474     * dedicated Elementary window. By default, it won't.
6475     *
6476     * @param obj The file selector button widget
6477     * @param value @c EINA_TRUE to make it use an inner window, @c
6478     * EINA_TRUE to make it use a dedicated window
6479     *
6480     * @see elm_win_inwin_add() for more information on inner windows
6481     * @see elm_fileselector_button_inwin_mode_get()
6482     */
6483    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6484
6485    /**
6486     * Get whether a given file selector button widget's internal file
6487     * selector will raise an Elementary "inner window", instead of a
6488     * dedicated Elementary window.
6489     *
6490     * @param obj The file selector button widget
6491     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6492     * if it will use a dedicated window
6493     *
6494     * @see elm_fileselector_button_inwin_mode_set() for more details
6495     */
6496    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6497
6498    /**
6499     * @}
6500     */
6501
6502     /**
6503     * @defgroup File_Selector_Entry File Selector Entry
6504     *
6505     * @image html img/widget/fileselector_entry/preview-00.png
6506     * @image latex img/widget/fileselector_entry/preview-00.eps
6507     *
6508     * This is an entry made to be filled with or display a <b>file
6509     * system path string</b>. Besides the entry itself, the widget has
6510     * a @ref File_Selector_Button "file selector button" on its side,
6511     * which will raise an internal @ref Fileselector "file selector widget",
6512     * when clicked, for path selection aided by file system
6513     * navigation.
6514     *
6515     * This file selector may appear in an Elementary window or in an
6516     * inner window. When a file is chosen from it, the (inner) window
6517     * is closed and the selected file's path string is exposed both as
6518     * an smart event and as the new text on the entry.
6519     *
6520     * This widget encapsulates operations on its internal file
6521     * selector on its own API. There is less control over its file
6522     * selector than that one would have instatiating one directly.
6523     *
6524     * Smart callbacks one can register to:
6525     * - @c "changed" - The text within the entry was changed
6526     * - @c "activated" - The entry has had editing finished and
6527     *   changes are to be "committed"
6528     * - @c "press" - The entry has been clicked
6529     * - @c "longpressed" - The entry has been clicked (and held) for a
6530     *   couple seconds
6531     * - @c "clicked" - The entry has been clicked
6532     * - @c "clicked,double" - The entry has been double clicked
6533     * - @c "focused" - The entry has received focus
6534     * - @c "unfocused" - The entry has lost focus
6535     * - @c "selection,paste" - A paste action has occurred on the
6536     *   entry
6537     * - @c "selection,copy" - A copy action has occurred on the entry
6538     * - @c "selection,cut" - A cut action has occurred on the entry
6539     * - @c "unpressed" - The file selector entry's button was released
6540     *   after being pressed.
6541     * - @c "file,chosen" - The user has selected a path via the file
6542     *   selector entry's internal file selector, whose string pointer
6543     *   comes as the @c event_info data (a stringshared string)
6544     *
6545     * Here is an example on its usage:
6546     * @li @ref fileselector_entry_example
6547     *
6548     * @see @ref File_Selector_Button for a similar widget.
6549     * @{
6550     */
6551
6552    /**
6553     * Add a new file selector entry widget to the given parent
6554     * Elementary (container) object
6555     *
6556     * @param parent The parent object
6557     * @return a new file selector entry widget handle or @c NULL, on
6558     * errors
6559     */
6560    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6561
6562    /**
6563     * Set the label for a given file selector entry widget's button
6564     *
6565     * @param obj The file selector entry widget
6566     * @param label The text label to be displayed on @p obj widget's
6567     * button
6568     *
6569     * @deprecated use elm_object_text_set() instead.
6570     */
6571    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6572
6573    /**
6574     * Get the label set for a given file selector entry widget's button
6575     *
6576     * @param obj The file selector entry widget
6577     * @return The widget button's label
6578     *
6579     * @deprecated use elm_object_text_set() instead.
6580     */
6581    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6582
6583    /**
6584     * Set the icon on a given file selector entry widget's button
6585     *
6586     * @param obj The file selector entry widget
6587     * @param icon The icon object for the entry's button
6588     *
6589     * Once the icon object is set, a previously set one will be
6590     * deleted. If you want to keep the latter, use the
6591     * elm_fileselector_entry_button_icon_unset() function.
6592     *
6593     * @see elm_fileselector_entry_button_icon_get()
6594     */
6595    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6596
6597    /**
6598     * Get the icon set for a given file selector entry widget's button
6599     *
6600     * @param obj The file selector entry widget
6601     * @return The icon object currently set on @p obj widget's button
6602     * or @c NULL, if none is
6603     *
6604     * @see elm_fileselector_entry_button_icon_set()
6605     */
6606    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6607
6608    /**
6609     * Unset the icon used in a given file selector entry widget's
6610     * button
6611     *
6612     * @param obj The file selector entry widget
6613     * @return The icon object that was being used on @p obj widget's
6614     * button or @c NULL, on errors
6615     *
6616     * Unparent and return the icon object which was set for this
6617     * widget's button.
6618     *
6619     * @see elm_fileselector_entry_button_icon_set()
6620     */
6621    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6622
6623    /**
6624     * Set the title for a given file selector entry widget's window
6625     *
6626     * @param obj The file selector entry widget
6627     * @param title The title string
6628     *
6629     * This will change the window's title, when the file selector pops
6630     * out after a click on the entry's button. Those windows have the
6631     * default (unlocalized) value of @c "Select a file" as titles.
6632     *
6633     * @note It will only take any effect if the file selector
6634     * entry widget is @b not under "inwin mode".
6635     *
6636     * @see elm_fileselector_entry_window_title_get()
6637     */
6638    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6639
6640    /**
6641     * Get the title set for a given file selector entry widget's
6642     * window
6643     *
6644     * @param obj The file selector entry widget
6645     * @return Title of the file selector entry's window
6646     *
6647     * @see elm_fileselector_entry_window_title_get() for more details
6648     */
6649    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6650
6651    /**
6652     * Set the size of a given file selector entry widget's window,
6653     * holding the file selector itself.
6654     *
6655     * @param obj The file selector entry widget
6656     * @param width The window's width
6657     * @param height The window's height
6658     *
6659     * @note it will only take any effect if the file selector entry
6660     * widget is @b not under "inwin mode". The default size for the
6661     * window (when applicable) is 400x400 pixels.
6662     *
6663     * @see elm_fileselector_entry_window_size_get()
6664     */
6665    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6666
6667    /**
6668     * Get the size of a given file selector entry widget's window,
6669     * holding the file selector itself.
6670     *
6671     * @param obj The file selector entry widget
6672     * @param width Pointer into which to store the width value
6673     * @param height Pointer into which to store the height value
6674     *
6675     * @note Use @c NULL pointers on the size values you're not
6676     * interested in: they'll be ignored by the function.
6677     *
6678     * @see elm_fileselector_entry_window_size_set(), for more details
6679     */
6680    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6681
6682    /**
6683     * Set the initial file system path and the entry's path string for
6684     * a given file selector entry widget
6685     *
6686     * @param obj The file selector entry widget
6687     * @param path The path string
6688     *
6689     * It must be a <b>directory</b> path, which will have the contents
6690     * displayed initially in the file selector's view, when invoked
6691     * from @p obj. The default initial path is the @c "HOME"
6692     * environment variable's value.
6693     *
6694     * @see elm_fileselector_entry_path_get()
6695     */
6696    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6697
6698    /**
6699     * Get the entry's path string for a given file selector entry
6700     * widget
6701     *
6702     * @param obj The file selector entry widget
6703     * @return path The path string
6704     *
6705     * @see elm_fileselector_entry_path_set() for more details
6706     */
6707    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6708
6709    /**
6710     * Enable/disable a tree view in the given file selector entry
6711     * widget's internal file selector
6712     *
6713     * @param obj The file selector entry widget
6714     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6715     * disable
6716     *
6717     * This has the same effect as elm_fileselector_expandable_set(),
6718     * but now applied to a file selector entry's internal file
6719     * selector.
6720     *
6721     * @note There's no way to put a file selector entry's internal
6722     * file selector in "grid mode", as one may do with "pure" file
6723     * selectors.
6724     *
6725     * @see elm_fileselector_expandable_get()
6726     */
6727    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6728
6729    /**
6730     * Get whether tree view is enabled for the given file selector
6731     * entry widget's internal file selector
6732     *
6733     * @param obj The file selector entry widget
6734     * @return @c EINA_TRUE if @p obj widget's internal file selector
6735     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6736     *
6737     * @see elm_fileselector_expandable_set() for more details
6738     */
6739    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6740
6741    /**
6742     * Set whether a given file selector entry widget's internal file
6743     * selector is to display folders only or the directory contents,
6744     * as well.
6745     *
6746     * @param obj The file selector entry widget
6747     * @param only @c EINA_TRUE to make @p obj widget's internal file
6748     * selector only display directories, @c EINA_FALSE to make files
6749     * to be displayed in it too
6750     *
6751     * This has the same effect as elm_fileselector_folder_only_set(),
6752     * but now applied to a file selector entry's internal file
6753     * selector.
6754     *
6755     * @see elm_fileselector_folder_only_get()
6756     */
6757    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6758
6759    /**
6760     * Get whether a given file selector entry widget's internal file
6761     * selector is displaying folders only or the directory contents,
6762     * as well.
6763     *
6764     * @param obj The file selector entry widget
6765     * @return @c EINA_TRUE if @p obj widget's internal file
6766     * selector is only displaying directories, @c EINA_FALSE if files
6767     * are being displayed in it too (and on errors)
6768     *
6769     * @see elm_fileselector_entry_folder_only_set() for more details
6770     */
6771    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6772
6773    /**
6774     * Enable/disable the file name entry box where the user can type
6775     * in a name for a file, in a given file selector entry widget's
6776     * internal file selector.
6777     *
6778     * @param obj The file selector entry widget
6779     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6780     * file selector a "saving dialog", @c EINA_FALSE otherwise
6781     *
6782     * This has the same effect as elm_fileselector_is_save_set(),
6783     * but now applied to a file selector entry's internal file
6784     * selector.
6785     *
6786     * @see elm_fileselector_is_save_get()
6787     */
6788    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6789
6790    /**
6791     * Get whether the given file selector entry widget's internal
6792     * file selector is in "saving dialog" mode
6793     *
6794     * @param obj The file selector entry widget
6795     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6796     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6797     * errors)
6798     *
6799     * @see elm_fileselector_entry_is_save_set() for more details
6800     */
6801    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6802
6803    /**
6804     * Set whether a given file selector entry widget's internal file
6805     * selector will raise an Elementary "inner window", instead of a
6806     * dedicated Elementary window. By default, it won't.
6807     *
6808     * @param obj The file selector entry widget
6809     * @param value @c EINA_TRUE to make it use an inner window, @c
6810     * EINA_TRUE to make it use a dedicated window
6811     *
6812     * @see elm_win_inwin_add() for more information on inner windows
6813     * @see elm_fileselector_entry_inwin_mode_get()
6814     */
6815    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6816
6817    /**
6818     * Get whether a given file selector entry widget's internal file
6819     * selector will raise an Elementary "inner window", instead of a
6820     * dedicated Elementary window.
6821     *
6822     * @param obj The file selector entry widget
6823     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6824     * if it will use a dedicated window
6825     *
6826     * @see elm_fileselector_entry_inwin_mode_set() for more details
6827     */
6828    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6829
6830    /**
6831     * Set the initial file system path for a given file selector entry
6832     * widget
6833     *
6834     * @param obj The file selector entry widget
6835     * @param path The path string
6836     *
6837     * It must be a <b>directory</b> path, which will have the contents
6838     * displayed initially in the file selector's view, when invoked
6839     * from @p obj. The default initial path is the @c "HOME"
6840     * environment variable's value.
6841     *
6842     * @see elm_fileselector_entry_path_get()
6843     */
6844    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6845
6846    /**
6847     * Get the parent directory's path to the latest file selection on
6848     * a given filer selector entry widget
6849     *
6850     * @param obj The file selector object
6851     * @return The (full) path of the directory of the last selection
6852     * on @p obj widget, a @b stringshared string
6853     *
6854     * @see elm_fileselector_entry_path_set()
6855     */
6856    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6857
6858    /**
6859     * @}
6860     */
6861
6862    /**
6863     * @defgroup Scroller Scroller
6864     *
6865     * A scroller holds a single object and "scrolls it around". This means that
6866     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6867     * region around, allowing to move through a much larger object that is
6868     * contained in the scroller. The scroiller will always have a small minimum
6869     * size by default as it won't be limited by the contents of the scroller.
6870     *
6871     * Signals that you can add callbacks for are:
6872     * @li "edge,left" - the left edge of the content has been reached
6873     * @li "edge,right" - the right edge of the content has been reached
6874     * @li "edge,top" - the top edge of the content has been reached
6875     * @li "edge,bottom" - the bottom edge of the content has been reached
6876     * @li "scroll" - the content has been scrolled (moved)
6877     * @li "scroll,anim,start" - scrolling animation has started
6878     * @li "scroll,anim,stop" - scrolling animation has stopped
6879     * @li "scroll,drag,start" - dragging the contents around has started
6880     * @li "scroll,drag,stop" - dragging the contents around has stopped
6881     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6882     * user intervetion.
6883     *
6884     * @note When Elemementary is in embedded mode the scrollbars will not be
6885     * dragable, they appear merely as indicators of how much has been scrolled.
6886     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6887     * fingerscroll) won't work.
6888     *
6889     * In @ref tutorial_scroller you'll find an example of how to use most of
6890     * this API.
6891     * @{
6892     */
6893    /**
6894     * @brief Type that controls when scrollbars should appear.
6895     *
6896     * @see elm_scroller_policy_set()
6897     */
6898    typedef enum _Elm_Scroller_Policy
6899      {
6900         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6901         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6902         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6903         ELM_SCROLLER_POLICY_LAST
6904      } Elm_Scroller_Policy;
6905    /**
6906     * @brief Add a new scroller to the parent
6907     *
6908     * @param parent The parent object
6909     * @return The new object or NULL if it cannot be created
6910     */
6911    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6912    /**
6913     * @brief Set the content of the scroller widget (the object to be scrolled around).
6914     *
6915     * @param obj The scroller object
6916     * @param content The new content object
6917     *
6918     * Once the content object is set, a previously set one will be deleted.
6919     * If you want to keep that old content object, use the
6920     * elm_scroller_content_unset() function.
6921     */
6922    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6923    /**
6924     * @brief Get the content of the scroller widget
6925     *
6926     * @param obj The slider object
6927     * @return The content that is being used
6928     *
6929     * Return the content object which is set for this widget
6930     *
6931     * @see elm_scroller_content_set()
6932     */
6933    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6934    /**
6935     * @brief Unset the content of the scroller widget
6936     *
6937     * @param obj The slider object
6938     * @return The content that was being used
6939     *
6940     * Unparent and return the content object which was set for this widget
6941     *
6942     * @see elm_scroller_content_set()
6943     */
6944    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6945    /**
6946     * @brief Set custom theme elements for the scroller
6947     *
6948     * @param obj The scroller object
6949     * @param widget The widget name to use (default is "scroller")
6950     * @param base The base name to use (default is "base")
6951     */
6952    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6953    /**
6954     * @brief Make the scroller minimum size limited to the minimum size of the content
6955     *
6956     * @param obj The scroller object
6957     * @param w Enable limiting minimum size horizontally
6958     * @param h Enable limiting minimum size vertically
6959     *
6960     * By default the scroller will be as small as its design allows,
6961     * irrespective of its content. This will make the scroller minimum size the
6962     * right size horizontally and/or vertically to perfectly fit its content in
6963     * that direction.
6964     */
6965    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6966    /**
6967     * @brief Show a specific virtual region within the scroller content object
6968     *
6969     * @param obj The scroller object
6970     * @param x X coordinate of the region
6971     * @param y Y coordinate of the region
6972     * @param w Width of the region
6973     * @param h Height of the region
6974     *
6975     * This will ensure all (or part if it does not fit) of the designated
6976     * region in the virtual content object (0, 0 starting at the top-left of the
6977     * virtual content object) is shown within the scroller.
6978     */
6979    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);
6980    /**
6981     * @brief Set the scrollbar visibility policy
6982     *
6983     * @param obj The scroller object
6984     * @param policy_h Horizontal scrollbar policy
6985     * @param policy_v Vertical scrollbar policy
6986     *
6987     * This sets the scrollbar visibility policy for the given scroller.
6988     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6989     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6990     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6991     * respectively for the horizontal and vertical scrollbars.
6992     */
6993    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6994    /**
6995     * @brief Gets scrollbar visibility policy
6996     *
6997     * @param obj The scroller object
6998     * @param policy_h Horizontal scrollbar policy
6999     * @param policy_v Vertical scrollbar policy
7000     *
7001     * @see elm_scroller_policy_set()
7002     */
7003    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7004    /**
7005     * @brief Get the currently visible content region
7006     *
7007     * @param obj The scroller object
7008     * @param x X coordinate of the region
7009     * @param y Y coordinate of the region
7010     * @param w Width of the region
7011     * @param h Height of the region
7012     *
7013     * This gets the current region in the content object that is visible through
7014     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7015     * w, @p h values pointed to.
7016     *
7017     * @note All coordinates are relative to the content.
7018     *
7019     * @see elm_scroller_region_show()
7020     */
7021    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);
7022    /**
7023     * @brief Get the size of the content object
7024     *
7025     * @param obj The scroller object
7026     * @param w Width return
7027     * @param h Height return
7028     *
7029     * This gets the size of the content object of the scroller.
7030     */
7031    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7032    /**
7033     * @brief Set bouncing behavior
7034     *
7035     * @param obj The scroller object
7036     * @param h_bounce Will the scroller bounce horizontally or not
7037     * @param v_bounce Will the scroller bounce vertically or not
7038     *
7039     * When scrolling, the scroller may "bounce" when reaching an edge of the
7040     * content object. This is a visual way to indicate the end has been reached.
7041     * This is enabled by default for both axis. This will set if it is enabled
7042     * for that axis with the boolean parameters for each axis.
7043     */
7044    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7045    /**
7046     * @brief Get the bounce mode
7047     *
7048     * @param obj The Scroller object
7049     * @param h_bounce Allow bounce horizontally
7050     * @param v_bounce Allow bounce vertically
7051     *
7052     * @see elm_scroller_bounce_set()
7053     */
7054    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7055    /**
7056     * @brief Set scroll page size relative to viewport size.
7057     *
7058     * @param obj The scroller object
7059     * @param h_pagerel The horizontal page relative size
7060     * @param v_pagerel The vertical page relative size
7061     *
7062     * The scroller is capable of limiting scrolling by the user to "pages". That
7063     * is to jump by and only show a "whole page" at a time as if the continuous
7064     * area of the scroller content is split into page sized pieces. This sets
7065     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7066     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7067     * axis. This is mutually exclusive with page size
7068     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7069     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7070     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7071     * the other axis.
7072     */
7073    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7074    /**
7075     * @brief Set scroll page size.
7076     *
7077     * @param obj The scroller object
7078     * @param h_pagesize The horizontal page size
7079     * @param v_pagesize The vertical page size
7080     *
7081     * This sets the page size to an absolute fixed value, with 0 turning it off
7082     * for that axis.
7083     *
7084     * @see elm_scroller_page_relative_set()
7085     */
7086    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7087    /**
7088     * @brief Get scroll current page number.
7089     *
7090     * @param obj The scroller object
7091     * @param h_pagenumber The horizontal page number
7092     * @param v_pagenumber The vertical page number
7093     *
7094     * The page number starts from 0. 0 is the first page.
7095     * Current page means the page which meet the top-left of the viewport.
7096     * If there are two or more pages in the viewport, it returns the number of page
7097     * which meet the top-left of the viewport.
7098     *
7099     * @see elm_scroller_last_page_get()
7100     * @see elm_scroller_page_show()
7101     * @see elm_scroller_page_brint_in()
7102     */
7103    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7104    /**
7105     * @brief Get scroll last page number.
7106     *
7107     * @param obj The scroller object
7108     * @param h_pagenumber The horizontal page number
7109     * @param v_pagenumber The vertical page number
7110     *
7111     * The page number starts from 0. 0 is the first page.
7112     * This returns the last page number among the pages.
7113     *
7114     * @see elm_scroller_current_page_get()
7115     * @see elm_scroller_page_show()
7116     * @see elm_scroller_page_brint_in()
7117     */
7118    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7119    /**
7120     * Show a specific virtual region within the scroller content object by page number.
7121     *
7122     * @param obj The scroller object
7123     * @param h_pagenumber The horizontal page number
7124     * @param v_pagenumber The vertical page number
7125     *
7126     * 0, 0 of the indicated page is located at the top-left of the viewport.
7127     * This will jump to the page directly without animation.
7128     *
7129     * Example of usage:
7130     *
7131     * @code
7132     * sc = elm_scroller_add(win);
7133     * elm_scroller_content_set(sc, content);
7134     * elm_scroller_page_relative_set(sc, 1, 0);
7135     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7136     * elm_scroller_page_show(sc, h_page + 1, v_page);
7137     * @endcode
7138     *
7139     * @see elm_scroller_page_bring_in()
7140     */
7141    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7142    /**
7143     * Show a specific virtual region within the scroller content object by page number.
7144     *
7145     * @param obj The scroller object
7146     * @param h_pagenumber The horizontal page number
7147     * @param v_pagenumber The vertical page number
7148     *
7149     * 0, 0 of the indicated page is located at the top-left of the viewport.
7150     * This will slide to the page with animation.
7151     *
7152     * Example of usage:
7153     *
7154     * @code
7155     * sc = elm_scroller_add(win);
7156     * elm_scroller_content_set(sc, content);
7157     * elm_scroller_page_relative_set(sc, 1, 0);
7158     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7159     * elm_scroller_page_bring_in(sc, h_page, v_page);
7160     * @endcode
7161     *
7162     * @see elm_scroller_page_show()
7163     */
7164    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7165    /**
7166     * @brief Show a specific virtual region within the scroller content object.
7167     *
7168     * @param obj The scroller object
7169     * @param x X coordinate of the region
7170     * @param y Y coordinate of the region
7171     * @param w Width of the region
7172     * @param h Height of the region
7173     *
7174     * This will ensure all (or part if it does not fit) of the designated
7175     * region in the virtual content object (0, 0 starting at the top-left of the
7176     * virtual content object) is shown within the scroller. Unlike
7177     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7178     * to this location (if configuration in general calls for transitions). It
7179     * may not jump immediately to the new location and make take a while and
7180     * show other content along the way.
7181     *
7182     * @see elm_scroller_region_show()
7183     */
7184    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);
7185    /**
7186     * @brief Set event propagation on a scroller
7187     *
7188     * @param obj The scroller object
7189     * @param propagation If propagation is enabled or not
7190     *
7191     * This enables or disabled event propagation from the scroller content to
7192     * the scroller and its parent. By default event propagation is disabled.
7193     */
7194    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7195    /**
7196     * @brief Get event propagation for a scroller
7197     *
7198     * @param obj The scroller object
7199     * @return The propagation state
7200     *
7201     * This gets the event propagation for a scroller.
7202     *
7203     * @see elm_scroller_propagate_events_set()
7204     */
7205    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7206    /**
7207     * @}
7208     */
7209
7210    /**
7211     * @defgroup Label Label
7212     *
7213     * @image html img/widget/label/preview-00.png
7214     * @image latex img/widget/label/preview-00.eps
7215     *
7216     * @brief Widget to display text, with simple html-like markup.
7217     *
7218     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7219     * text doesn't fit the geometry of the label it will be ellipsized or be
7220     * cut. Elementary provides several themes for this widget:
7221     * @li default - No animation
7222     * @li marker - Centers the text in the label and make it bold by default
7223     * @li slide_long - The entire text appears from the right of the screen and
7224     * slides until it disappears in the left of the screen(reappering on the
7225     * right again).
7226     * @li slide_short - The text appears in the left of the label and slides to
7227     * the right to show the overflow. When all of the text has been shown the
7228     * position is reset.
7229     * @li slide_bounce - The text appears in the left of the label and slides to
7230     * the right to show the overflow. When all of the text has been shown the
7231     * animation reverses, moving the text to the left.
7232     *
7233     * Custom themes can of course invent new markup tags and style them any way
7234     * they like.
7235     *
7236     * See @ref tutorial_label for a demonstration of how to use a label widget.
7237     * @{
7238     */
7239    /**
7240     * @brief Add a new label to the parent
7241     *
7242     * @param parent The parent object
7243     * @return The new object or NULL if it cannot be created
7244     */
7245    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7246    /**
7247     * @brief Set the label on the label object
7248     *
7249     * @param obj The label object
7250     * @param label The label will be used on the label object
7251     * @deprecated See elm_object_text_set()
7252     */
7253    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 */
7254    /**
7255     * @brief Get the label used on the label object
7256     *
7257     * @param obj The label object
7258     * @return The string inside the label
7259     * @deprecated See elm_object_text_get()
7260     */
7261    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7262    /**
7263     * @brief Set the wrapping behavior of the label
7264     *
7265     * @param obj The label object
7266     * @param wrap To wrap text or not
7267     *
7268     * By default no wrapping is done. Possible values for @p wrap are:
7269     * @li ELM_WRAP_NONE - No wrapping
7270     * @li ELM_WRAP_CHAR - wrap between characters
7271     * @li ELM_WRAP_WORD - wrap between words
7272     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7273     */
7274    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7275    /**
7276     * @brief Get the wrapping behavior of the label
7277     *
7278     * @param obj The label object
7279     * @return Wrap type
7280     *
7281     * @see elm_label_line_wrap_set()
7282     */
7283    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7284    /**
7285     * @brief Set wrap width of the label
7286     *
7287     * @param obj The label object
7288     * @param w The wrap width in pixels at a minimum where words need to wrap
7289     *
7290     * This function sets the maximum width size hint of the label.
7291     *
7292     * @warning This is only relevant if the label is inside a container.
7293     */
7294    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7295    /**
7296     * @brief Get wrap width of the label
7297     *
7298     * @param obj The label object
7299     * @return The wrap width in pixels at a minimum where words need to wrap
7300     *
7301     * @see elm_label_wrap_width_set()
7302     */
7303    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7304    /**
7305     * @brief Set wrap height of the label
7306     *
7307     * @param obj The label object
7308     * @param h The wrap height in pixels at a minimum where words need to wrap
7309     *
7310     * This function sets the maximum height size hint of the label.
7311     *
7312     * @warning This is only relevant if the label is inside a container.
7313     */
7314    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7315    /**
7316     * @brief get wrap width of the label
7317     *
7318     * @param obj The label object
7319     * @return The wrap height in pixels at a minimum where words need to wrap
7320     */
7321    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7322    /**
7323     * @brief Set the font size on the label object.
7324     *
7325     * @param obj The label object
7326     * @param size font size
7327     *
7328     * @warning NEVER use this. It is for hyper-special cases only. use styles
7329     * instead. e.g. "big", "medium", "small" - or better name them by use:
7330     * "title", "footnote", "quote" etc.
7331     */
7332    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7333    /**
7334     * @brief Set the text color on the label object
7335     *
7336     * @param obj The label object
7337     * @param r Red property background color of The label object
7338     * @param g Green property background color of The label object
7339     * @param b Blue property background color of The label object
7340     * @param a Alpha property background color of The label object
7341     *
7342     * @warning NEVER use this. It is for hyper-special cases only. use styles
7343     * instead. e.g. "big", "medium", "small" - or better name them by use:
7344     * "title", "footnote", "quote" etc.
7345     */
7346    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);
7347    /**
7348     * @brief Set the text align on the label object
7349     *
7350     * @param obj The label object
7351     * @param align align mode ("left", "center", "right")
7352     *
7353     * @warning NEVER use this. It is for hyper-special cases only. use styles
7354     * instead. e.g. "big", "medium", "small" - or better name them by use:
7355     * "title", "footnote", "quote" etc.
7356     */
7357    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7358    /**
7359     * @brief Set background color of the label
7360     *
7361     * @param obj The label object
7362     * @param r Red property background color of The label object
7363     * @param g Green property background color of The label object
7364     * @param b Blue property background color of The label object
7365     * @param a Alpha property background alpha of The label object
7366     *
7367     * @warning NEVER use this. It is for hyper-special cases only. use styles
7368     * instead. e.g. "big", "medium", "small" - or better name them by use:
7369     * "title", "footnote", "quote" etc.
7370     */
7371    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);
7372    /**
7373     * @brief Set the ellipsis behavior of the label
7374     *
7375     * @param obj The label object
7376     * @param ellipsis To ellipsis text or not
7377     *
7378     * If set to true and the text doesn't fit in the label an ellipsis("...")
7379     * will be shown at the end of the widget.
7380     *
7381     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7382     * choosen wrap method was ELM_WRAP_WORD.
7383     */
7384    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7385    /**
7386     * @brief Set the text slide of the label
7387     *
7388     * @param obj The label object
7389     * @param slide To start slide or stop
7390     *
7391     * If set to true the text of the label will slide throught the length of
7392     * label.
7393     *
7394     * @warning This only work with the themes "slide_short", "slide_long" and
7395     * "slide_bounce".
7396     */
7397    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7398    /**
7399     * @brief Get the text slide mode of the label
7400     *
7401     * @param obj The label object
7402     * @return slide slide mode value
7403     *
7404     * @see elm_label_slide_set()
7405     */
7406    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7407    /**
7408     * @brief Set the slide duration(speed) of the label
7409     *
7410     * @param obj The label object
7411     * @return The duration in seconds in moving text from slide begin position
7412     * to slide end position
7413     */
7414    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7415    /**
7416     * @brief Get the slide duration(speed) of the label
7417     *
7418     * @param obj The label object
7419     * @return The duration time in moving text from slide begin position to slide end position
7420     *
7421     * @see elm_label_slide_duration_set()
7422     */
7423    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7424    /**
7425     * @}
7426     */
7427
7428    /**
7429     * @defgroup Toggle Toggle
7430     *
7431     * @image html img/widget/toggle/preview-00.png
7432     * @image latex img/widget/toggle/preview-00.eps
7433     *
7434     * @brief A toggle is a slider which can be used to toggle between
7435     * two values.  It has two states: on and off.
7436     *
7437     * Signals that you can add callbacks for are:
7438     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7439     *                 until the toggle is released by the cursor (assuming it
7440     *                 has been triggered by the cursor in the first place).
7441     *
7442     * @ref tutorial_toggle show how to use a toggle.
7443     * @{
7444     */
7445    /**
7446     * @brief Add a toggle to @p parent.
7447     *
7448     * @param parent The parent object
7449     *
7450     * @return The toggle object
7451     */
7452    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7453    /**
7454     * @brief Sets the label to be displayed with the toggle.
7455     *
7456     * @param obj The toggle object
7457     * @param label The label to be displayed
7458     *
7459     * @deprecated use elm_object_text_set() instead.
7460     */
7461    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7462    /**
7463     * @brief Gets the label of the toggle
7464     *
7465     * @param obj  toggle object
7466     * @return The label of the toggle
7467     *
7468     * @deprecated use elm_object_text_get() instead.
7469     */
7470    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7471    /**
7472     * @brief Set the icon used for the toggle
7473     *
7474     * @param obj The toggle object
7475     * @param icon The icon object for the button
7476     *
7477     * Once the icon object is set, a previously set one will be deleted
7478     * If you want to keep that old content object, use the
7479     * elm_toggle_icon_unset() function.
7480     */
7481    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7482    /**
7483     * @brief Get the icon used for the toggle
7484     *
7485     * @param obj The toggle object
7486     * @return The icon object that is being used
7487     *
7488     * Return the icon object which is set for this widget.
7489     *
7490     * @see elm_toggle_icon_set()
7491     */
7492    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7493    /**
7494     * @brief Unset the icon used for the toggle
7495     *
7496     * @param obj The toggle object
7497     * @return The icon object that was being used
7498     *
7499     * Unparent and return the icon object which was set for this widget.
7500     *
7501     * @see elm_toggle_icon_set()
7502     */
7503    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7504    /**
7505     * @brief Sets the labels to be associated with the on and off states of the toggle.
7506     *
7507     * @param obj The toggle object
7508     * @param onlabel The label displayed when the toggle is in the "on" state
7509     * @param offlabel The label displayed when the toggle is in the "off" state
7510     */
7511    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7512    /**
7513     * @brief Gets the labels associated with the on and off states of the toggle.
7514     *
7515     * @param obj The toggle object
7516     * @param onlabel A char** to place the onlabel of @p obj into
7517     * @param offlabel A char** to place the offlabel of @p obj into
7518     */
7519    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7520    /**
7521     * @brief Sets the state of the toggle to @p state.
7522     *
7523     * @param obj The toggle object
7524     * @param state The state of @p obj
7525     */
7526    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7527    /**
7528     * @brief Gets the state of the toggle to @p state.
7529     *
7530     * @param obj The toggle object
7531     * @return The state of @p obj
7532     */
7533    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7534    /**
7535     * @brief Sets the state pointer of the toggle to @p statep.
7536     *
7537     * @param obj The toggle object
7538     * @param statep The state pointer of @p obj
7539     */
7540    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7541    /**
7542     * @}
7543     */
7544
7545    /**
7546     * @defgroup Frame Frame
7547     *
7548     * @image html img/widget/frame/preview-00.png
7549     * @image latex img/widget/frame/preview-00.eps
7550     *
7551     * @brief Frame is a widget that holds some content and has a title.
7552     *
7553     * The default look is a frame with a title, but Frame supports multple
7554     * styles:
7555     * @li default
7556     * @li pad_small
7557     * @li pad_medium
7558     * @li pad_large
7559     * @li pad_huge
7560     * @li outdent_top
7561     * @li outdent_bottom
7562     *
7563     * Of all this styles only default shows the title. Frame emits no signals.
7564     *
7565     * For a detailed example see the @ref tutorial_frame.
7566     *
7567     * @{
7568     */
7569    /**
7570     * @brief Add a new frame to the parent
7571     *
7572     * @param parent The parent object
7573     * @return The new object or NULL if it cannot be created
7574     */
7575    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7576    /**
7577     * @brief Set the frame label
7578     *
7579     * @param obj The frame object
7580     * @param label The label of this frame object
7581     *
7582     * @deprecated use elm_object_text_set() instead.
7583     */
7584    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7585    /**
7586     * @brief Get the frame label
7587     *
7588     * @param obj The frame object
7589     *
7590     * @return The label of this frame objet or NULL if unable to get frame
7591     *
7592     * @deprecated use elm_object_text_get() instead.
7593     */
7594    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7595    /**
7596     * @brief Set the content of the frame widget
7597     *
7598     * Once the content object is set, a previously set one will be deleted.
7599     * If you want to keep that old content object, use the
7600     * elm_frame_content_unset() function.
7601     *
7602     * @param obj The frame object
7603     * @param content The content will be filled in this frame object
7604     */
7605    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7606    /**
7607     * @brief Get the content of the frame widget
7608     *
7609     * Return the content object which is set for this widget
7610     *
7611     * @param obj The frame object
7612     * @return The content that is being used
7613     */
7614    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7615    /**
7616     * @brief Unset the content of the frame widget
7617     *
7618     * Unparent and return the content object which was set for this widget
7619     *
7620     * @param obj The frame object
7621     * @return The content that was being used
7622     */
7623    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7624    /**
7625     * @}
7626     */
7627
7628    /**
7629     * @defgroup Table Table
7630     *
7631     * A container widget to arrange other widgets in a table where items can
7632     * also span multiple columns or rows - even overlap (and then be raised or
7633     * lowered accordingly to adjust stacking if they do overlap).
7634     *
7635     * The followin are examples of how to use a table:
7636     * @li @ref tutorial_table_01
7637     * @li @ref tutorial_table_02
7638     *
7639     * @{
7640     */
7641    /**
7642     * @brief Add a new table to the parent
7643     *
7644     * @param parent The parent object
7645     * @return The new object or NULL if it cannot be created
7646     */
7647    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7648    /**
7649     * @brief Set the homogeneous layout in the table
7650     *
7651     * @param obj The layout object
7652     * @param homogeneous A boolean to set if the layout is homogeneous in the
7653     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7654     */
7655    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7656    /**
7657     * @brief Get the current table homogeneous mode.
7658     *
7659     * @param obj The table object
7660     * @return A boolean to indicating if the layout is homogeneous in the table
7661     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7662     */
7663    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7664    /**
7665     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7666     */
7667    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7668    /**
7669     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7670     */
7671    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7672    /**
7673     * @brief Set padding between cells.
7674     *
7675     * @param obj The layout object.
7676     * @param horizontal set the horizontal padding.
7677     * @param vertical set the vertical padding.
7678     *
7679     * Default value is 0.
7680     */
7681    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7682    /**
7683     * @brief Get padding between cells.
7684     *
7685     * @param obj The layout object.
7686     * @param horizontal set the horizontal padding.
7687     * @param vertical set the vertical padding.
7688     */
7689    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7690    /**
7691     * @brief Add a subobject on the table with the coordinates passed
7692     *
7693     * @param obj The table object
7694     * @param subobj The subobject to be added to the table
7695     * @param x Row number
7696     * @param y Column number
7697     * @param w rowspan
7698     * @param h colspan
7699     *
7700     * @note All positioning inside the table is relative to rows and columns, so
7701     * a value of 0 for x and y, means the top left cell of the table, and a
7702     * value of 1 for w and h means @p subobj only takes that 1 cell.
7703     */
7704    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7705    /**
7706     * @brief Remove child from table.
7707     *
7708     * @param obj The table object
7709     * @param subobj The subobject
7710     */
7711    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7712    /**
7713     * @brief Faster way to remove all child objects from a table object.
7714     *
7715     * @param obj The table object
7716     * @param clear If true, will delete children, else just remove from table.
7717     */
7718    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7719    /**
7720     * @brief Set the packing location of an existing child of the table
7721     *
7722     * @param subobj The subobject to be modified in the table
7723     * @param x Row number
7724     * @param y Column number
7725     * @param w rowspan
7726     * @param h colspan
7727     *
7728     * Modifies the position of an object already in the table.
7729     *
7730     * @note All positioning inside the table is relative to rows and columns, so
7731     * a value of 0 for x and y, means the top left cell of the table, and a
7732     * value of 1 for w and h means @p subobj only takes that 1 cell.
7733     */
7734    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7735    /**
7736     * @brief Get the packing location of an existing child of the table
7737     *
7738     * @param subobj The subobject to be modified in the table
7739     * @param x Row number
7740     * @param y Column number
7741     * @param w rowspan
7742     * @param h colspan
7743     *
7744     * @see elm_table_pack_set()
7745     */
7746    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7747    /**
7748     * @}
7749     */
7750
7751    /**
7752     * @defgroup Gengrid Gengrid (Generic grid)
7753     *
7754     * This widget aims to position objects in a grid layout while
7755     * actually creating and rendering only the visible ones, using the
7756     * same idea as the @ref Genlist "genlist": the user defines a @b
7757     * class for each item, specifying functions that will be called at
7758     * object creation, deletion, etc. When those items are selected by
7759     * the user, a callback function is issued. Users may interact with
7760     * a gengrid via the mouse (by clicking on items to select them and
7761     * clicking on the grid's viewport and swiping to pan the whole
7762     * view) or via the keyboard, navigating through item with the
7763     * arrow keys.
7764     *
7765     * @section Gengrid_Layouts Gengrid layouts
7766     *
7767     * Gengrids may layout its items in one of two possible layouts:
7768     * - horizontal or
7769     * - vertical.
7770     *
7771     * When in "horizontal mode", items will be placed in @b columns,
7772     * from top to bottom and, when the space for a column is filled,
7773     * another one is started on the right, thus expanding the grid
7774     * horizontally, making for horizontal scrolling. When in "vertical
7775     * mode" , though, items will be placed in @b rows, from left to
7776     * right and, when the space for a row is filled, another one is
7777     * started below, thus expanding the grid vertically (and making
7778     * for vertical scrolling).
7779     *
7780     * @section Gengrid_Items Gengrid items
7781     *
7782     * An item in a gengrid can have 0 or more text labels (they can be
7783     * regular text or textblock Evas objects - that's up to the style
7784     * to determine), 0 or more icons (which are simply objects
7785     * swallowed into the gengrid item's theming Edje object) and 0 or
7786     * more <b>boolean states</b>, which have the behavior left to the
7787     * user to define. The Edje part names for each of these properties
7788     * will be looked up, in the theme file for the gengrid, under the
7789     * Edje (string) data items named @c "labels", @c "icons" and @c
7790     * "states", respectively. For each of those properties, if more
7791     * than one part is provided, they must have names listed separated
7792     * by spaces in the data fields. For the default gengrid item
7793     * theme, we have @b one label part (@c "elm.text"), @b two icon
7794     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7795     * no state parts.
7796     *
7797     * A gengrid item may be at one of several styles. Elementary
7798     * provides one by default - "default", but this can be extended by
7799     * system or application custom themes/overlays/extensions (see
7800     * @ref Theme "themes" for more details).
7801     *
7802     * @section Gengrid_Item_Class Gengrid item classes
7803     *
7804     * In order to have the ability to add and delete items on the fly,
7805     * gengrid implements a class (callback) system where the
7806     * application provides a structure with information about that
7807     * type of item (gengrid may contain multiple different items with
7808     * different classes, states and styles). Gengrid will call the
7809     * functions in this struct (methods) when an item is "realized"
7810     * (i.e., created dynamically, while the user is scrolling the
7811     * grid). All objects will simply be deleted when no longer needed
7812     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7813     * contains the following members:
7814     * - @c item_style - This is a constant string and simply defines
7815     * the name of the item style. It @b must be specified and the
7816     * default should be @c "default".
7817     * - @c func.label_get - This function is called when an item
7818     * object is actually created. The @c data parameter will point to
7819     * the same data passed to elm_gengrid_item_append() and related
7820     * item creation functions. The @c obj parameter is the gengrid
7821     * object itself, while the @c part one is the name string of one
7822     * of the existing text parts in the Edje group implementing the
7823     * item's theme. This function @b must return a strdup'()ed string,
7824     * as the caller will free() it when done. See
7825     * #Elm_Gengrid_Item_Label_Get_Cb.
7826     * - @c func.icon_get - This function is called when an item object
7827     * is actually created. The @c data parameter will point to the
7828     * same data passed to elm_gengrid_item_append() and related item
7829     * creation functions. The @c obj parameter is the gengrid object
7830     * itself, while the @c part one is the name string of one of the
7831     * existing (icon) swallow parts in the Edje group implementing the
7832     * item's theme. It must return @c NULL, when no icon is desired,
7833     * or a valid object handle, otherwise. The object will be deleted
7834     * by the gengrid on its deletion or when the item is "unrealized".
7835     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7836     * - @c func.state_get - This function is called when an item
7837     * object is actually created. The @c data parameter will point to
7838     * the same data passed to elm_gengrid_item_append() and related
7839     * item creation functions. The @c obj parameter is the gengrid
7840     * object itself, while the @c part one is the name string of one
7841     * of the state parts in the Edje group implementing the item's
7842     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7843     * true/on. Gengrids will emit a signal to its theming Edje object
7844     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7845     * "source" arguments, respectively, when the state is true (the
7846     * default is false), where @c XXX is the name of the (state) part.
7847     * See #Elm_Gengrid_Item_State_Get_Cb.
7848     * - @c func.del - This is called when elm_gengrid_item_del() is
7849     * called on an item or elm_gengrid_clear() is called on the
7850     * gengrid. This is intended for use when gengrid items are
7851     * deleted, so any data attached to the item (e.g. its data
7852     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7853     *
7854     * @section Gengrid_Usage_Hints Usage hints
7855     *
7856     * If the user wants to have multiple items selected at the same
7857     * time, elm_gengrid_multi_select_set() will permit it. If the
7858     * gengrid is single-selection only (the default), then
7859     * elm_gengrid_select_item_get() will return the selected item or
7860     * @c NULL, if none is selected. If the gengrid is under
7861     * multi-selection, then elm_gengrid_selected_items_get() will
7862     * return a list (that is only valid as long as no items are
7863     * modified (added, deleted, selected or unselected) of child items
7864     * on a gengrid.
7865     *
7866     * If an item changes (internal (boolean) state, label or icon
7867     * changes), then use elm_gengrid_item_update() to have gengrid
7868     * update the item with the new state. A gengrid will re-"realize"
7869     * the item, thus calling the functions in the
7870     * #Elm_Gengrid_Item_Class set for that item.
7871     *
7872     * To programmatically (un)select an item, use
7873     * elm_gengrid_item_selected_set(). To get its selected state use
7874     * elm_gengrid_item_selected_get(). To make an item disabled
7875     * (unable to be selected and appear differently) use
7876     * elm_gengrid_item_disabled_set() to set this and
7877     * elm_gengrid_item_disabled_get() to get the disabled state.
7878     *
7879     * Grid cells will only have their selection smart callbacks called
7880     * when firstly getting selected. Any further clicks will do
7881     * nothing, unless you enable the "always select mode", with
7882     * elm_gengrid_always_select_mode_set(), thus making every click to
7883     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7884     * turn off the ability to select items entirely in the widget and
7885     * they will neither appear selected nor call the selection smart
7886     * callbacks.
7887     *
7888     * Remember that you can create new styles and add your own theme
7889     * augmentation per application with elm_theme_extension_add(). If
7890     * you absolutely must have a specific style that overrides any
7891     * theme the user or system sets up you can use
7892     * elm_theme_overlay_add() to add such a file.
7893     *
7894     * @section Gengrid_Smart_Events Gengrid smart events
7895     *
7896     * Smart events that you can add callbacks for are:
7897     * - @c "activated" - The user has double-clicked or pressed
7898     *   (enter|return|spacebar) on an item. The @c event_info parameter
7899     *   is the gengrid item that was activated.
7900     * - @c "clicked,double" - The user has double-clicked an item.
7901     *   The @c event_info parameter is the gengrid item that was double-clicked.
7902     * - @c "longpressed" - This is called when the item is pressed for a certain
7903     *   amount of time. By default it's 1 second.
7904     * - @c "selected" - The user has made an item selected. The
7905     *   @c event_info parameter is the gengrid item that was selected.
7906     * - @c "unselected" - The user has made an item unselected. The
7907     *   @c event_info parameter is the gengrid item that was unselected.
7908     * - @c "realized" - This is called when the item in the gengrid
7909     *   has its implementing Evas object instantiated, de facto. @c
7910     *   event_info is the gengrid item that was created. The object
7911     *   may be deleted at any time, so it is highly advised to the
7912     *   caller @b not to use the object pointer returned from
7913     *   elm_gengrid_item_object_get(), because it may point to freed
7914     *   objects.
7915     * - @c "unrealized" - This is called when the implementing Evas
7916     *   object for this item is deleted. @c event_info is the gengrid
7917     *   item that was deleted.
7918     * - @c "changed" - Called when an item is added, removed, resized
7919     *   or moved and when the gengrid is resized or gets "horizontal"
7920     *   property changes.
7921     * - @c "scroll,anim,start" - This is called when scrolling animation has
7922     *   started.
7923     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7924     *   stopped.
7925     * - @c "drag,start,up" - Called when the item in the gengrid has
7926     *   been dragged (not scrolled) up.
7927     * - @c "drag,start,down" - Called when the item in the gengrid has
7928     *   been dragged (not scrolled) down.
7929     * - @c "drag,start,left" - Called when the item in the gengrid has
7930     *   been dragged (not scrolled) left.
7931     * - @c "drag,start,right" - Called when the item in the gengrid has
7932     *   been dragged (not scrolled) right.
7933     * - @c "drag,stop" - Called when the item in the gengrid has
7934     *   stopped being dragged.
7935     * - @c "drag" - Called when the item in the gengrid is being
7936     *   dragged.
7937     * - @c "scroll" - called when the content has been scrolled
7938     *   (moved).
7939     * - @c "scroll,drag,start" - called when dragging the content has
7940     *   started.
7941     * - @c "scroll,drag,stop" - called when dragging the content has
7942     *   stopped.
7943     * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
7944     *   the top edge.
7945     * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
7946     *   until the bottom edge.
7947     * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
7948     *   until the left edge.
7949     * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
7950     *   until the right edge.
7951     *
7952     * List of gengrid examples:
7953     * @li @ref gengrid_example
7954     */
7955
7956    /**
7957     * @addtogroup Gengrid
7958     * @{
7959     */
7960
7961    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7962    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7963    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7964    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7965    typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7966    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. */
7967    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7968
7969    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7970    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7971    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7972    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7973
7974    /**
7975     * @struct _Elm_Gengrid_Item_Class
7976     *
7977     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7978     * field details.
7979     */
7980    struct _Elm_Gengrid_Item_Class
7981      {
7982         const char             *item_style;
7983         struct _Elm_Gengrid_Item_Class_Func
7984           {
7985              Elm_Gengrid_Item_Label_Get_Cb label_get;
7986              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7987              Elm_Gengrid_Item_State_Get_Cb state_get;
7988              Elm_Gengrid_Item_Del_Cb       del;
7989           } func;
7990      }; /**< #Elm_Gengrid_Item_Class member definitions */
7991
7992    /**
7993     * Add a new gengrid widget to the given parent Elementary
7994     * (container) object
7995     *
7996     * @param parent The parent object
7997     * @return a new gengrid widget handle or @c NULL, on errors
7998     *
7999     * This function inserts a new gengrid widget on the canvas.
8000     *
8001     * @see elm_gengrid_item_size_set()
8002     * @see elm_gengrid_group_item_size_set()
8003     * @see elm_gengrid_horizontal_set()
8004     * @see elm_gengrid_item_append()
8005     * @see elm_gengrid_item_del()
8006     * @see elm_gengrid_clear()
8007     *
8008     * @ingroup Gengrid
8009     */
8010    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8011
8012    /**
8013     * Set the size for the items of a given gengrid widget
8014     *
8015     * @param obj The gengrid object.
8016     * @param w The items' width.
8017     * @param h The items' height;
8018     *
8019     * A gengrid, after creation, has still no information on the size
8020     * to give to each of its cells. So, you most probably will end up
8021     * with squares one @ref Fingers "finger" wide, the default
8022     * size. Use this function to force a custom size for you items,
8023     * making them as big as you wish.
8024     *
8025     * @see elm_gengrid_item_size_get()
8026     *
8027     * @ingroup Gengrid
8028     */
8029    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8030
8031    /**
8032     * Get the size set for the items of a given gengrid widget
8033     *
8034     * @param obj The gengrid object.
8035     * @param w Pointer to a variable where to store the items' width.
8036     * @param h Pointer to a variable where to store the items' height.
8037     *
8038     * @note Use @c NULL pointers on the size values you're not
8039     * interested in: they'll be ignored by the function.
8040     *
8041     * @see elm_gengrid_item_size_get() for more details
8042     *
8043     * @ingroup Gengrid
8044     */
8045    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8046
8047    /**
8048     * Set the size for the group items of a given gengrid widget
8049     *
8050     * @param obj The gengrid object.
8051     * @param w The group items' width.
8052     * @param h The group items' height;
8053     *
8054     * A gengrid, after creation, has still no information on the size
8055     * to give to each of its cells. So, you most probably will end up
8056     * with squares one @ref Fingers "finger" wide, the default
8057     * size. Use this function to force a custom size for you group items,
8058     * making them as big as you wish.
8059     *
8060     * @see elm_gengrid_group_item_size_get()
8061     *
8062     * @ingroup Gengrid
8063     */
8064    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8065
8066    /**
8067     * Get the size set for the group items of a given gengrid widget
8068     *
8069     * @param obj The gengrid object.
8070     * @param w Pointer to a variable where to store the group items' width.
8071     * @param h Pointer to a variable where to store the group items' height.
8072     *
8073     * @note Use @c NULL pointers on the size values you're not
8074     * interested in: they'll be ignored by the function.
8075     *
8076     * @see elm_gengrid_group_item_size_get() for more details
8077     *
8078     * @ingroup Gengrid
8079     */
8080    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8081
8082    /**
8083     * Set the items grid's alignment within a given gengrid widget
8084     *
8085     * @param obj The gengrid object.
8086     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8087     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8088     *
8089     * This sets the alignment of the whole grid of items of a gengrid
8090     * within its given viewport. By default, those values are both
8091     * 0.5, meaning that the gengrid will have its items grid placed
8092     * exactly in the middle of its viewport.
8093     *
8094     * @note If given alignment values are out of the cited ranges,
8095     * they'll be changed to the nearest boundary values on the valid
8096     * ranges.
8097     *
8098     * @see elm_gengrid_align_get()
8099     *
8100     * @ingroup Gengrid
8101     */
8102    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8103
8104    /**
8105     * Get the items grid's alignment values within a given gengrid
8106     * widget
8107     *
8108     * @param obj The gengrid object.
8109     * @param align_x Pointer to a variable where to store the
8110     * horizontal alignment.
8111     * @param align_y Pointer to a variable where to store the vertical
8112     * alignment.
8113     *
8114     * @note Use @c NULL pointers on the alignment values you're not
8115     * interested in: they'll be ignored by the function.
8116     *
8117     * @see elm_gengrid_align_set() for more details
8118     *
8119     * @ingroup Gengrid
8120     */
8121    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8122
8123    /**
8124     * Set whether a given gengrid widget is or not able have items
8125     * @b reordered
8126     *
8127     * @param obj The gengrid object
8128     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8129     * @c EINA_FALSE to turn it off
8130     *
8131     * If a gengrid is set to allow reordering, a click held for more
8132     * than 0.5 over a given item will highlight it specially,
8133     * signalling the gengrid has entered the reordering state. From
8134     * that time on, the user will be able to, while still holding the
8135     * mouse button down, move the item freely in the gengrid's
8136     * viewport, replacing to said item to the locations it goes to.
8137     * The replacements will be animated and, whenever the user
8138     * releases the mouse button, the item being replaced gets a new
8139     * definitive place in the grid.
8140     *
8141     * @see elm_gengrid_reorder_mode_get()
8142     *
8143     * @ingroup Gengrid
8144     */
8145    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8146
8147    /**
8148     * Get whether a given gengrid widget is or not able have items
8149     * @b reordered
8150     *
8151     * @param obj The gengrid object
8152     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8153     * off
8154     *
8155     * @see elm_gengrid_reorder_mode_set() for more details
8156     *
8157     * @ingroup Gengrid
8158     */
8159    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8160
8161    /**
8162     * Append a new item in a given gengrid widget.
8163     *
8164     * @param obj The gengrid object.
8165     * @param gic The item class for the item.
8166     * @param data The item data.
8167     * @param func Convenience function called when the item is
8168     * selected.
8169     * @param func_data Data to be passed to @p func.
8170     * @return A handle to the item added or @c NULL, on errors.
8171     *
8172     * This adds an item to the beginning of the gengrid.
8173     *
8174     * @see elm_gengrid_item_prepend()
8175     * @see elm_gengrid_item_insert_before()
8176     * @see elm_gengrid_item_insert_after()
8177     * @see elm_gengrid_item_del()
8178     *
8179     * @ingroup Gengrid
8180     */
8181    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);
8182
8183    /**
8184     * Prepend a new item in a given gengrid widget.
8185     *
8186     * @param obj The gengrid object.
8187     * @param gic The item class for the item.
8188     * @param data The item data.
8189     * @param func Convenience function called when the item is
8190     * selected.
8191     * @param func_data Data to be passed to @p func.
8192     * @return A handle to the item added or @c NULL, on errors.
8193     *
8194     * This adds an item to the end of the gengrid.
8195     *
8196     * @see elm_gengrid_item_append()
8197     * @see elm_gengrid_item_insert_before()
8198     * @see elm_gengrid_item_insert_after()
8199     * @see elm_gengrid_item_del()
8200     *
8201     * @ingroup Gengrid
8202     */
8203    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);
8204
8205    /**
8206     * Insert an item before another in a gengrid widget
8207     *
8208     * @param obj The gengrid object.
8209     * @param gic The item class for the item.
8210     * @param data The item data.
8211     * @param relative The item to place this new one before.
8212     * @param func Convenience function called when the item is
8213     * selected.
8214     * @param func_data Data to be passed to @p func.
8215     * @return A handle to the item added or @c NULL, on errors.
8216     *
8217     * This inserts an item before another in the gengrid.
8218     *
8219     * @see elm_gengrid_item_append()
8220     * @see elm_gengrid_item_prepend()
8221     * @see elm_gengrid_item_insert_after()
8222     * @see elm_gengrid_item_del()
8223     *
8224     * @ingroup Gengrid
8225     */
8226    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);
8227
8228    /**
8229     * Insert an item after another in a gengrid widget
8230     *
8231     * @param obj The gengrid object.
8232     * @param gic The item class for the item.
8233     * @param data The item data.
8234     * @param relative The item to place this new one after.
8235     * @param func Convenience function called when the item is
8236     * selected.
8237     * @param func_data Data to be passed to @p func.
8238     * @return A handle to the item added or @c NULL, on errors.
8239     *
8240     * This inserts an item after another in the gengrid.
8241     *
8242     * @see elm_gengrid_item_append()
8243     * @see elm_gengrid_item_prepend()
8244     * @see elm_gengrid_item_insert_after()
8245     * @see elm_gengrid_item_del()
8246     *
8247     * @ingroup Gengrid
8248     */
8249    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);
8250
8251    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);
8252
8253    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);
8254
8255    /**
8256     * Set whether items on a given gengrid widget are to get their
8257     * selection callbacks issued for @b every subsequent selection
8258     * click on them or just for the first click.
8259     *
8260     * @param obj The gengrid object
8261     * @param always_select @c EINA_TRUE to make items "always
8262     * selected", @c EINA_FALSE, otherwise
8263     *
8264     * By default, grid items will only call their selection callback
8265     * function when firstly getting selected, any subsequent further
8266     * clicks will do nothing. With this call, you make those
8267     * subsequent clicks also to issue the selection callbacks.
8268     *
8269     * @note <b>Double clicks</b> will @b always be reported on items.
8270     *
8271     * @see elm_gengrid_always_select_mode_get()
8272     *
8273     * @ingroup Gengrid
8274     */
8275    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8276
8277    /**
8278     * Get whether items on a given gengrid widget have their selection
8279     * callbacks issued for @b every subsequent selection click on them
8280     * or just for the first click.
8281     *
8282     * @param obj The gengrid object.
8283     * @return @c EINA_TRUE if the gengrid items are "always selected",
8284     * @c EINA_FALSE, otherwise
8285     *
8286     * @see elm_gengrid_always_select_mode_set() for more details
8287     *
8288     * @ingroup Gengrid
8289     */
8290    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8291
8292    /**
8293     * Set whether items on a given gengrid widget can be selected or not.
8294     *
8295     * @param obj The gengrid object
8296     * @param no_select @c EINA_TRUE to make items selectable,
8297     * @c EINA_FALSE otherwise
8298     *
8299     * This will make items in @p obj selectable or not. In the latter
8300     * case, any user interaction on the gengrid items will neither make
8301     * them appear selected nor them call their selection callback
8302     * functions.
8303     *
8304     * @see elm_gengrid_no_select_mode_get()
8305     *
8306     * @ingroup Gengrid
8307     */
8308    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8309
8310    /**
8311     * Get whether items on a given gengrid widget can be selected or
8312     * not.
8313     *
8314     * @param obj The gengrid object
8315     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8316     * otherwise
8317     *
8318     * @see elm_gengrid_no_select_mode_set() for more details
8319     *
8320     * @ingroup Gengrid
8321     */
8322    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8323
8324    /**
8325     * Enable or disable multi-selection in a given gengrid widget
8326     *
8327     * @param obj The gengrid object.
8328     * @param multi @c EINA_TRUE, to enable multi-selection,
8329     * @c EINA_FALSE to disable it.
8330     *
8331     * Multi-selection is the ability for one to have @b more than one
8332     * item selected, on a given gengrid, simultaneously. When it is
8333     * enabled, a sequence of clicks on different items will make them
8334     * all selected, progressively. A click on an already selected item
8335     * will unselect it. If interecting via the keyboard,
8336     * multi-selection is enabled while holding the "Shift" key.
8337     *
8338     * @note By default, multi-selection is @b disabled on gengrids
8339     *
8340     * @see elm_gengrid_multi_select_get()
8341     *
8342     * @ingroup Gengrid
8343     */
8344    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8345
8346    /**
8347     * Get whether multi-selection is enabled or disabled for a given
8348     * gengrid widget
8349     *
8350     * @param obj The gengrid object.
8351     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8352     * EINA_FALSE otherwise
8353     *
8354     * @see elm_gengrid_multi_select_set() for more details
8355     *
8356     * @ingroup Gengrid
8357     */
8358    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8359
8360    /**
8361     * Enable or disable bouncing effect for a given gengrid widget
8362     *
8363     * @param obj The gengrid object
8364     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8365     * @c EINA_FALSE to disable it
8366     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8367     * @c EINA_FALSE to disable it
8368     *
8369     * The bouncing effect occurs whenever one reaches the gengrid's
8370     * edge's while panning it -- it will scroll past its limits a
8371     * little bit and return to the edge again, in a animated for,
8372     * automatically.
8373     *
8374     * @note By default, gengrids have bouncing enabled on both axis
8375     *
8376     * @see elm_gengrid_bounce_get()
8377     *
8378     * @ingroup Gengrid
8379     */
8380    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8381
8382    /**
8383     * Get whether bouncing effects are enabled or disabled, for a
8384     * given gengrid widget, on each axis
8385     *
8386     * @param obj The gengrid object
8387     * @param h_bounce Pointer to a variable where to store the
8388     * horizontal bouncing flag.
8389     * @param v_bounce Pointer to a variable where to store the
8390     * vertical bouncing flag.
8391     *
8392     * @see elm_gengrid_bounce_set() for more details
8393     *
8394     * @ingroup Gengrid
8395     */
8396    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8397
8398    /**
8399     * Set a given gengrid widget's scrolling page size, relative to
8400     * its viewport size.
8401     *
8402     * @param obj The gengrid object
8403     * @param h_pagerel The horizontal page (relative) size
8404     * @param v_pagerel The vertical page (relative) size
8405     *
8406     * The gengrid's scroller is capable of binding scrolling by the
8407     * user to "pages". It means that, while scrolling and, specially
8408     * after releasing the mouse button, the grid will @b snap to the
8409     * nearest displaying page's area. When page sizes are set, the
8410     * grid's continuous content area is split into (equal) page sized
8411     * pieces.
8412     *
8413     * This function sets the size of a page <b>relatively to the
8414     * viewport dimensions</b> of the gengrid, for each axis. A value
8415     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8416     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8417     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8418     * 1.0. Values beyond those will make it behave behave
8419     * inconsistently. If you only want one axis to snap to pages, use
8420     * the value @c 0.0 for the other one.
8421     *
8422     * There is a function setting page size values in @b absolute
8423     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8424     * is mutually exclusive to this one.
8425     *
8426     * @see elm_gengrid_page_relative_get()
8427     *
8428     * @ingroup Gengrid
8429     */
8430    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8431
8432    /**
8433     * Get a given gengrid widget's scrolling page size, relative to
8434     * its viewport size.
8435     *
8436     * @param obj The gengrid object
8437     * @param h_pagerel Pointer to a variable where to store the
8438     * horizontal page (relative) size
8439     * @param v_pagerel Pointer to a variable where to store the
8440     * vertical page (relative) size
8441     *
8442     * @see elm_gengrid_page_relative_set() for more details
8443     *
8444     * @ingroup Gengrid
8445     */
8446    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8447
8448    /**
8449     * Set a given gengrid widget's scrolling page size
8450     *
8451     * @param obj The gengrid object
8452     * @param h_pagerel The horizontal page size, in pixels
8453     * @param v_pagerel The vertical page size, in pixels
8454     *
8455     * The gengrid's scroller is capable of binding scrolling by the
8456     * user to "pages". It means that, while scrolling and, specially
8457     * after releasing the mouse button, the grid will @b snap to the
8458     * nearest displaying page's area. When page sizes are set, the
8459     * grid's continuous content area is split into (equal) page sized
8460     * pieces.
8461     *
8462     * This function sets the size of a page of the gengrid, in pixels,
8463     * for each axis. Sane usable values are, between @c 0 and the
8464     * dimensions of @p obj, for each axis. Values beyond those will
8465     * make it behave behave inconsistently. If you only want one axis
8466     * to snap to pages, use the value @c 0 for the other one.
8467     *
8468     * There is a function setting page size values in @b relative
8469     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8470     * use is mutually exclusive to this one.
8471     *
8472     * @ingroup Gengrid
8473     */
8474    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8475
8476    /**
8477     * @brief Get gengrid current page number.
8478     *
8479     * @param obj The gengrid object
8480     * @param h_pagenumber The horizontal page number
8481     * @param v_pagenumber The vertical page number
8482     *
8483     * The page number starts from 0. 0 is the first page.
8484     * Current page means the page which meet the top-left of the viewport.
8485     * If there are two or more pages in the viewport, it returns the number of page
8486     * which meet the top-left of the viewport.
8487     *
8488     * @see elm_gengrid_last_page_get()
8489     * @see elm_gengrid_page_show()
8490     * @see elm_gengrid_page_brint_in()
8491     */
8492    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8493
8494    /**
8495     * @brief Get scroll last page number.
8496     *
8497     * @param obj The gengrid object
8498     * @param h_pagenumber The horizontal page number
8499     * @param v_pagenumber The vertical page number
8500     *
8501     * The page number starts from 0. 0 is the first page.
8502     * This returns the last page number among the pages.
8503     *
8504     * @see elm_gengrid_current_page_get()
8505     * @see elm_gengrid_page_show()
8506     * @see elm_gengrid_page_brint_in()
8507     */
8508    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8509
8510    /**
8511     * Show a specific virtual region within the gengrid content object by page number.
8512     *
8513     * @param obj The gengrid object
8514     * @param h_pagenumber The horizontal page number
8515     * @param v_pagenumber The vertical page number
8516     *
8517     * 0, 0 of the indicated page is located at the top-left of the viewport.
8518     * This will jump to the page directly without animation.
8519     *
8520     * Example of usage:
8521     *
8522     * @code
8523     * sc = elm_gengrid_add(win);
8524     * elm_gengrid_content_set(sc, content);
8525     * elm_gengrid_page_relative_set(sc, 1, 0);
8526     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8527     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8528     * @endcode
8529     *
8530     * @see elm_gengrid_page_bring_in()
8531     */
8532    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8533
8534    /**
8535     * Show a specific virtual region within the gengrid content object by page number.
8536     *
8537     * @param obj The gengrid object
8538     * @param h_pagenumber The horizontal page number
8539     * @param v_pagenumber The vertical page number
8540     *
8541     * 0, 0 of the indicated page is located at the top-left of the viewport.
8542     * This will slide to the page with animation.
8543     *
8544     * Example of usage:
8545     *
8546     * @code
8547     * sc = elm_gengrid_add(win);
8548     * elm_gengrid_content_set(sc, content);
8549     * elm_gengrid_page_relative_set(sc, 1, 0);
8550     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8551     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8552     * @endcode
8553     *
8554     * @see elm_gengrid_page_show()
8555     */
8556     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8557
8558    /**
8559     * Set for what direction a given gengrid widget will expand while
8560     * placing its items.
8561     *
8562     * @param obj The gengrid object.
8563     * @param setting @c EINA_TRUE to make the gengrid expand
8564     * horizontally, @c EINA_FALSE to expand vertically.
8565     *
8566     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8567     * in @b columns, from top to bottom and, when the space for a
8568     * column is filled, another one is started on the right, thus
8569     * expanding the grid horizontally. When in "vertical mode"
8570     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8571     * to right and, when the space for a row is filled, another one is
8572     * started below, thus expanding the grid vertically.
8573     *
8574     * @see elm_gengrid_horizontal_get()
8575     *
8576     * @ingroup Gengrid
8577     */
8578    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8579
8580    /**
8581     * Get for what direction a given gengrid widget will expand while
8582     * placing its items.
8583     *
8584     * @param obj The gengrid object.
8585     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8586     * @c EINA_FALSE if it's set to expand vertically.
8587     *
8588     * @see elm_gengrid_horizontal_set() for more detais
8589     *
8590     * @ingroup Gengrid
8591     */
8592    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8593
8594    /**
8595     * Get the first item in a given gengrid widget
8596     *
8597     * @param obj The gengrid object
8598     * @return The first item's handle or @c NULL, if there are no
8599     * items in @p obj (and on errors)
8600     *
8601     * This returns the first item in the @p obj's internal list of
8602     * items.
8603     *
8604     * @see elm_gengrid_last_item_get()
8605     *
8606     * @ingroup Gengrid
8607     */
8608    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8609
8610    /**
8611     * Get the last item in a given gengrid widget
8612     *
8613     * @param obj The gengrid object
8614     * @return The last item's handle or @c NULL, if there are no
8615     * items in @p obj (and on errors)
8616     *
8617     * This returns the last item in the @p obj's internal list of
8618     * items.
8619     *
8620     * @see elm_gengrid_first_item_get()
8621     *
8622     * @ingroup Gengrid
8623     */
8624    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8625
8626    /**
8627     * Get the @b next item in a gengrid widget's internal list of items,
8628     * given a handle to one of those items.
8629     *
8630     * @param item The gengrid item to fetch next from
8631     * @return The item after @p item, or @c NULL if there's none (and
8632     * on errors)
8633     *
8634     * This returns the item placed after the @p item, on the container
8635     * gengrid.
8636     *
8637     * @see elm_gengrid_item_prev_get()
8638     *
8639     * @ingroup Gengrid
8640     */
8641    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8642
8643    /**
8644     * Get the @b previous item in a gengrid widget's internal list of items,
8645     * given a handle to one of those items.
8646     *
8647     * @param item The gengrid item to fetch previous from
8648     * @return The item before @p item, or @c NULL if there's none (and
8649     * on errors)
8650     *
8651     * This returns the item placed before the @p item, on the container
8652     * gengrid.
8653     *
8654     * @see elm_gengrid_item_next_get()
8655     *
8656     * @ingroup Gengrid
8657     */
8658    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8659
8660    /**
8661     * Get the gengrid object's handle which contains a given gengrid
8662     * item
8663     *
8664     * @param item The item to fetch the container from
8665     * @return The gengrid (parent) object
8666     *
8667     * This returns the gengrid object itself that an item belongs to.
8668     *
8669     * @ingroup Gengrid
8670     */
8671    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8672
8673    /**
8674     * Remove a gengrid item from the its parent, deleting it.
8675     *
8676     * @param item The item to be removed.
8677     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8678     *
8679     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8680     * once.
8681     *
8682     * @ingroup Gengrid
8683     */
8684    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8685
8686    /**
8687     * Update the contents of a given gengrid item
8688     *
8689     * @param item The gengrid item
8690     *
8691     * This updates an item by calling all the item class functions
8692     * again to get the icons, labels and states. Use this when the
8693     * original item data has changed and you want thta changes to be
8694     * reflected.
8695     *
8696     * @ingroup Gengrid
8697     */
8698    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8699    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8700    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8701
8702    /**
8703     * Return the data associated to a given gengrid item
8704     *
8705     * @param item The gengrid item.
8706     * @return the data associated to this item.
8707     *
8708     * This returns the @c data value passed on the
8709     * elm_gengrid_item_append() and related item addition calls.
8710     *
8711     * @see elm_gengrid_item_append()
8712     * @see elm_gengrid_item_data_set()
8713     *
8714     * @ingroup Gengrid
8715     */
8716    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8717
8718    /**
8719     * Set the data associated to a given gengrid item
8720     *
8721     * @param item The gengrid item
8722     * @param data The new data pointer to set on it
8723     *
8724     * This @b overrides the @c data value passed on the
8725     * elm_gengrid_item_append() and related item addition calls. This
8726     * function @b won't call elm_gengrid_item_update() automatically,
8727     * so you'd issue it afterwards if you want to hove the item
8728     * updated to reflect the that new data.
8729     *
8730     * @see elm_gengrid_item_data_get()
8731     *
8732     * @ingroup Gengrid
8733     */
8734    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8735
8736    /**
8737     * Get a given gengrid item's position, relative to the whole
8738     * gengrid's grid area.
8739     *
8740     * @param item The Gengrid item.
8741     * @param x Pointer to variable where to store the item's <b>row
8742     * number</b>.
8743     * @param y Pointer to variable where to store the item's <b>column
8744     * number</b>.
8745     *
8746     * This returns the "logical" position of the item whithin the
8747     * gengrid. For example, @c (0, 1) would stand for first row,
8748     * second column.
8749     *
8750     * @ingroup Gengrid
8751     */
8752    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8753
8754    /**
8755     * Set whether a given gengrid item is selected or not
8756     *
8757     * @param item The gengrid item
8758     * @param selected Use @c EINA_TRUE, to make it selected, @c
8759     * EINA_FALSE to make it unselected
8760     *
8761     * This sets the selected state of an item. If multi selection is
8762     * not enabled on the containing gengrid and @p selected is @c
8763     * EINA_TRUE, any other previously selected items will get
8764     * unselected in favor of this new one.
8765     *
8766     * @see elm_gengrid_item_selected_get()
8767     *
8768     * @ingroup Gengrid
8769     */
8770    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8771
8772    /**
8773     * Get whether a given gengrid item is selected or not
8774     *
8775     * @param item The gengrid item
8776     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8777     *
8778     * @see elm_gengrid_item_selected_set() for more details
8779     *
8780     * @ingroup Gengrid
8781     */
8782    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8783
8784    /**
8785     * Get the real Evas object created to implement the view of a
8786     * given gengrid item
8787     *
8788     * @param item The gengrid item.
8789     * @return the Evas object implementing this item's view.
8790     *
8791     * This returns the actual Evas object used to implement the
8792     * specified gengrid item's view. This may be @c NULL, as it may
8793     * not have been created or may have been deleted, at any time, by
8794     * the gengrid. <b>Do not modify this object</b> (move, resize,
8795     * show, hide, etc.), as the gengrid is controlling it. This
8796     * function is for querying, emitting custom signals or hooking
8797     * lower level callbacks for events on that object. Do not delete
8798     * this object under any circumstances.
8799     *
8800     * @see elm_gengrid_item_data_get()
8801     *
8802     * @ingroup Gengrid
8803     */
8804    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8805
8806    /**
8807     * Show the portion of a gengrid's internal grid containing a given
8808     * item, @b immediately.
8809     *
8810     * @param item The item to display
8811     *
8812     * This causes gengrid to @b redraw its viewport's contents to the
8813     * region contining the given @p item item, if it is not fully
8814     * visible.
8815     *
8816     * @see elm_gengrid_item_bring_in()
8817     *
8818     * @ingroup Gengrid
8819     */
8820    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8821
8822    /**
8823     * Animatedly bring in, to the visible are of a gengrid, a given
8824     * item on it.
8825     *
8826     * @param item The gengrid item to display
8827     *
8828     * This causes gengrig to jump to the given @p item item and show
8829     * it (by scrolling), if it is not fully visible. This will use
8830     * animation to do so and take a period of time to complete.
8831     *
8832     * @see elm_gengrid_item_show()
8833     *
8834     * @ingroup Gengrid
8835     */
8836    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8837
8838    /**
8839     * Set whether a given gengrid item is disabled or not.
8840     *
8841     * @param item The gengrid item
8842     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8843     * to enable it back.
8844     *
8845     * A disabled item cannot be selected or unselected. It will also
8846     * change its appearance, to signal the user it's disabled.
8847     *
8848     * @see elm_gengrid_item_disabled_get()
8849     *
8850     * @ingroup Gengrid
8851     */
8852    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8853
8854    /**
8855     * Get whether a given gengrid item is disabled or not.
8856     *
8857     * @param item The gengrid item
8858     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8859     * (and on errors).
8860     *
8861     * @see elm_gengrid_item_disabled_set() for more details
8862     *
8863     * @ingroup Gengrid
8864     */
8865    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8866
8867    /**
8868     * Set the text to be shown in a given gengrid item's tooltips.
8869     *
8870     * @param item The gengrid item
8871     * @param text The text to set in the content
8872     *
8873     * This call will setup the text to be used as tooltip to that item
8874     * (analogous to elm_object_tooltip_text_set(), but being item
8875     * tooltips with higher precedence than object tooltips). It can
8876     * have only one tooltip at a time, so any previous tooltip data
8877     * will get removed.
8878     *
8879     * @ingroup Gengrid
8880     */
8881    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8882
8883    /**
8884     * Set the content to be shown in a given gengrid item's tooltips
8885     *
8886     * @param item The gengrid item.
8887     * @param func The function returning the tooltip contents.
8888     * @param data What to provide to @a func as callback data/context.
8889     * @param del_cb Called when data is not needed anymore, either when
8890     *        another callback replaces @p func, the tooltip is unset with
8891     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8892     *        dies. This callback receives as its first parameter the
8893     *        given @p data, being @c event_info the item handle.
8894     *
8895     * This call will setup the tooltip's contents to @p item
8896     * (analogous to elm_object_tooltip_content_cb_set(), but being
8897     * item tooltips with higher precedence than object tooltips). It
8898     * can have only one tooltip at a time, so any previous tooltip
8899     * content will get removed. @p func (with @p data) will be called
8900     * every time Elementary needs to show the tooltip and it should
8901     * return a valid Evas object, which will be fully managed by the
8902     * tooltip system, getting deleted when the tooltip is gone.
8903     *
8904     * @ingroup Gengrid
8905     */
8906    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);
8907
8908    /**
8909     * Unset a tooltip from a given gengrid item
8910     *
8911     * @param item gengrid item to remove a previously set tooltip from.
8912     *
8913     * This call removes any tooltip set on @p item. The callback
8914     * provided as @c del_cb to
8915     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8916     * notify it is not used anymore (and have resources cleaned, if
8917     * need be).
8918     *
8919     * @see elm_gengrid_item_tooltip_content_cb_set()
8920     *
8921     * @ingroup Gengrid
8922     */
8923    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8924
8925    /**
8926     * Set a different @b style for a given gengrid item's tooltip.
8927     *
8928     * @param item gengrid item with tooltip set
8929     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8930     * "default", @c "transparent", etc)
8931     *
8932     * Tooltips can have <b>alternate styles</b> to be displayed on,
8933     * which are defined by the theme set on Elementary. This function
8934     * works analogously as elm_object_tooltip_style_set(), but here
8935     * applied only to gengrid item objects. The default style for
8936     * tooltips is @c "default".
8937     *
8938     * @note before you set a style you should define a tooltip with
8939     *       elm_gengrid_item_tooltip_content_cb_set() or
8940     *       elm_gengrid_item_tooltip_text_set()
8941     *
8942     * @see elm_gengrid_item_tooltip_style_get()
8943     *
8944     * @ingroup Gengrid
8945     */
8946    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8947
8948    /**
8949     * Get the style set a given gengrid item's tooltip.
8950     *
8951     * @param item gengrid item with tooltip already set on.
8952     * @return style the theme style in use, which defaults to
8953     *         "default". If the object does not have a tooltip set,
8954     *         then @c NULL is returned.
8955     *
8956     * @see elm_gengrid_item_tooltip_style_set() for more details
8957     *
8958     * @ingroup Gengrid
8959     */
8960    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8961    /**
8962     * @brief Disable size restrictions on an object's tooltip
8963     * @param item The tooltip's anchor object
8964     * @param disable If EINA_TRUE, size restrictions are disabled
8965     * @return EINA_FALSE on failure, EINA_TRUE on success
8966     *
8967     * This function allows a tooltip to expand beyond its parant window's canvas.
8968     * It will instead be limited only by the size of the display.
8969     */
8970    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8971    /**
8972     * @brief Retrieve size restriction state of an object's tooltip
8973     * @param item The tooltip's anchor object
8974     * @return If EINA_TRUE, size restrictions are disabled
8975     *
8976     * This function returns whether a tooltip is allowed to expand beyond
8977     * its parant window's canvas.
8978     * It will instead be limited only by the size of the display.
8979     */
8980    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8981    /**
8982     * Set the type of mouse pointer/cursor decoration to be shown,
8983     * when the mouse pointer is over the given gengrid widget item
8984     *
8985     * @param item gengrid item to customize cursor on
8986     * @param cursor the cursor type's name
8987     *
8988     * This function works analogously as elm_object_cursor_set(), but
8989     * here the cursor's changing area is restricted to the item's
8990     * area, and not the whole widget's. Note that that item cursors
8991     * have precedence over widget cursors, so that a mouse over @p
8992     * item will always show cursor @p type.
8993     *
8994     * If this function is called twice for an object, a previously set
8995     * cursor will be unset on the second call.
8996     *
8997     * @see elm_object_cursor_set()
8998     * @see elm_gengrid_item_cursor_get()
8999     * @see elm_gengrid_item_cursor_unset()
9000     *
9001     * @ingroup Gengrid
9002     */
9003    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9004
9005    /**
9006     * Get the type of mouse pointer/cursor decoration set to be shown,
9007     * when the mouse pointer is over the given gengrid widget item
9008     *
9009     * @param item gengrid item with custom cursor set
9010     * @return the cursor type's name or @c NULL, if no custom cursors
9011     * were set to @p item (and on errors)
9012     *
9013     * @see elm_object_cursor_get()
9014     * @see elm_gengrid_item_cursor_set() for more details
9015     * @see elm_gengrid_item_cursor_unset()
9016     *
9017     * @ingroup Gengrid
9018     */
9019    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9020
9021    /**
9022     * Unset any custom mouse pointer/cursor decoration set to be
9023     * shown, when the mouse pointer is over the given gengrid widget
9024     * item, thus making it show the @b default cursor again.
9025     *
9026     * @param item a gengrid item
9027     *
9028     * Use this call to undo any custom settings on this item's cursor
9029     * decoration, bringing it back to defaults (no custom style set).
9030     *
9031     * @see elm_object_cursor_unset()
9032     * @see elm_gengrid_item_cursor_set() for more details
9033     *
9034     * @ingroup Gengrid
9035     */
9036    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9037
9038    /**
9039     * Set a different @b style for a given custom cursor set for a
9040     * gengrid item.
9041     *
9042     * @param item gengrid item with custom cursor set
9043     * @param style the <b>theme style</b> to use (e.g. @c "default",
9044     * @c "transparent", etc)
9045     *
9046     * This function only makes sense when one is using custom mouse
9047     * cursor decorations <b>defined in a theme file</b> , which can
9048     * have, given a cursor name/type, <b>alternate styles</b> on
9049     * it. It works analogously as elm_object_cursor_style_set(), but
9050     * here applied only to gengrid item objects.
9051     *
9052     * @warning Before you set a cursor style you should have defined a
9053     *       custom cursor previously on the item, with
9054     *       elm_gengrid_item_cursor_set()
9055     *
9056     * @see elm_gengrid_item_cursor_engine_only_set()
9057     * @see elm_gengrid_item_cursor_style_get()
9058     *
9059     * @ingroup Gengrid
9060     */
9061    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9062
9063    /**
9064     * Get the current @b style set for a given gengrid item's custom
9065     * cursor
9066     *
9067     * @param item gengrid item with custom cursor set.
9068     * @return style the cursor style in use. If the object does not
9069     *         have a cursor set, then @c NULL is returned.
9070     *
9071     * @see elm_gengrid_item_cursor_style_set() for more details
9072     *
9073     * @ingroup Gengrid
9074     */
9075    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9076
9077    /**
9078     * Set if the (custom) cursor for a given gengrid item should be
9079     * searched in its theme, also, or should only rely on the
9080     * rendering engine.
9081     *
9082     * @param item item with custom (custom) cursor already set on
9083     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9084     * only on those provided by the rendering engine, @c EINA_FALSE to
9085     * have them searched on the widget's theme, as well.
9086     *
9087     * @note This call is of use only if you've set a custom cursor
9088     * for gengrid items, with elm_gengrid_item_cursor_set().
9089     *
9090     * @note By default, cursors will only be looked for between those
9091     * provided by the rendering engine.
9092     *
9093     * @ingroup Gengrid
9094     */
9095    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9096
9097    /**
9098     * Get if the (custom) cursor for a given gengrid item is being
9099     * searched in its theme, also, or is only relying on the rendering
9100     * engine.
9101     *
9102     * @param item a gengrid item
9103     * @return @c EINA_TRUE, if cursors are being looked for only on
9104     * those provided by the rendering engine, @c EINA_FALSE if they
9105     * are being searched on the widget's theme, as well.
9106     *
9107     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9108     *
9109     * @ingroup Gengrid
9110     */
9111    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9112
9113    /**
9114     * Remove all items from a given gengrid widget
9115     *
9116     * @param obj The gengrid object.
9117     *
9118     * This removes (and deletes) all items in @p obj, leaving it
9119     * empty.
9120     *
9121     * @see elm_gengrid_item_del(), to remove just one item.
9122     *
9123     * @ingroup Gengrid
9124     */
9125    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9126
9127    /**
9128     * Get the selected item in a given gengrid widget
9129     *
9130     * @param obj The gengrid object.
9131     * @return The selected item's handleor @c NULL, if none is
9132     * selected at the moment (and on errors)
9133     *
9134     * This returns the selected item in @p obj. If multi selection is
9135     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9136     * the first item in the list is selected, which might not be very
9137     * useful. For that case, see elm_gengrid_selected_items_get().
9138     *
9139     * @ingroup Gengrid
9140     */
9141    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9142
9143    /**
9144     * Get <b>a list</b> of selected items in a given gengrid
9145     *
9146     * @param obj The gengrid object.
9147     * @return The list of selected items or @c NULL, if none is
9148     * selected at the moment (and on errors)
9149     *
9150     * This returns a list of the selected items, in the order that
9151     * they appear in the grid. This list is only valid as long as no
9152     * more items are selected or unselected (or unselected implictly
9153     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9154     * data, naturally.
9155     *
9156     * @see elm_gengrid_selected_item_get()
9157     *
9158     * @ingroup Gengrid
9159     */
9160    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9161
9162    /**
9163     * @}
9164     */
9165
9166    /**
9167     * @defgroup Clock Clock
9168     *
9169     * @image html img/widget/clock/preview-00.png
9170     * @image latex img/widget/clock/preview-00.eps
9171     *
9172     * This is a @b digital clock widget. In its default theme, it has a
9173     * vintage "flipping numbers clock" appearance, which will animate
9174     * sheets of individual algarisms individually as time goes by.
9175     *
9176     * A newly created clock will fetch system's time (already
9177     * considering local time adjustments) to start with, and will tick
9178     * accondingly. It may or may not show seconds.
9179     *
9180     * Clocks have an @b edition mode. When in it, the sheets will
9181     * display extra arrow indications on the top and bottom and the
9182     * user may click on them to raise or lower the time values. After
9183     * it's told to exit edition mode, it will keep ticking with that
9184     * new time set (it keeps the difference from local time).
9185     *
9186     * Also, when under edition mode, user clicks on the cited arrows
9187     * which are @b held for some time will make the clock to flip the
9188     * sheet, thus editing the time, continuosly and automatically for
9189     * the user. The interval between sheet flips will keep growing in
9190     * time, so that it helps the user to reach a time which is distant
9191     * from the one set.
9192     *
9193     * The time display is, by default, in military mode (24h), but an
9194     * am/pm indicator may be optionally shown, too, when it will
9195     * switch to 12h.
9196     *
9197     * Smart callbacks one can register to:
9198     * - "changed" - the clock's user changed the time
9199     *
9200     * Here is an example on its usage:
9201     * @li @ref clock_example
9202     */
9203
9204    /**
9205     * @addtogroup Clock
9206     * @{
9207     */
9208
9209    /**
9210     * Identifiers for which clock digits should be editable, when a
9211     * clock widget is in edition mode. Values may be ORed together to
9212     * make a mask, naturally.
9213     *
9214     * @see elm_clock_edit_set()
9215     * @see elm_clock_digit_edit_set()
9216     */
9217    typedef enum _Elm_Clock_Digedit
9218      {
9219         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9220         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9221         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9222         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9223         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9224         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9225         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9226         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9227      } Elm_Clock_Digedit;
9228
9229    /**
9230     * Add a new clock widget to the given parent Elementary
9231     * (container) object
9232     *
9233     * @param parent The parent object
9234     * @return a new clock widget handle or @c NULL, on errors
9235     *
9236     * This function inserts a new clock widget on the canvas.
9237     *
9238     * @ingroup Clock
9239     */
9240    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9241
9242    /**
9243     * Set a clock widget's time, programmatically
9244     *
9245     * @param obj The clock widget object
9246     * @param hrs The hours to set
9247     * @param min The minutes to set
9248     * @param sec The secondes to set
9249     *
9250     * This function updates the time that is showed by the clock
9251     * widget.
9252     *
9253     *  Values @b must be set within the following ranges:
9254     * - 0 - 23, for hours
9255     * - 0 - 59, for minutes
9256     * - 0 - 59, for seconds,
9257     *
9258     * even if the clock is not in "military" mode.
9259     *
9260     * @warning The behavior for values set out of those ranges is @b
9261     * indefined.
9262     *
9263     * @ingroup Clock
9264     */
9265    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9266
9267    /**
9268     * Get a clock widget's time values
9269     *
9270     * @param obj The clock object
9271     * @param[out] hrs Pointer to the variable to get the hours value
9272     * @param[out] min Pointer to the variable to get the minutes value
9273     * @param[out] sec Pointer to the variable to get the seconds value
9274     *
9275     * This function gets the time set for @p obj, returning
9276     * it on the variables passed as the arguments to function
9277     *
9278     * @note Use @c NULL pointers on the time values you're not
9279     * interested in: they'll be ignored by the function.
9280     *
9281     * @ingroup Clock
9282     */
9283    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9284
9285    /**
9286     * Set whether a given clock widget is under <b>edition mode</b> or
9287     * under (default) displaying-only mode.
9288     *
9289     * @param obj The clock object
9290     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9291     * put it back to "displaying only" mode
9292     *
9293     * This function makes a clock's time to be editable or not <b>by
9294     * user interaction</b>. When in edition mode, clocks @b stop
9295     * ticking, until one brings them back to canonical mode. The
9296     * elm_clock_digit_edit_set() function will influence which digits
9297     * of the clock will be editable. By default, all of them will be
9298     * (#ELM_CLOCK_NONE).
9299     *
9300     * @note am/pm sheets, if being shown, will @b always be editable
9301     * under edition mode.
9302     *
9303     * @see elm_clock_edit_get()
9304     *
9305     * @ingroup Clock
9306     */
9307    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9308
9309    /**
9310     * Retrieve whether a given clock widget is under <b>edition
9311     * mode</b> or under (default) displaying-only mode.
9312     *
9313     * @param obj The clock object
9314     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9315     * otherwise
9316     *
9317     * This function retrieves whether the clock's time can be edited
9318     * or not by user interaction.
9319     *
9320     * @see elm_clock_edit_set() for more details
9321     *
9322     * @ingroup Clock
9323     */
9324    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9325
9326    /**
9327     * Set what digits of the given clock widget should be editable
9328     * when in edition mode.
9329     *
9330     * @param obj The clock object
9331     * @param digedit Bit mask indicating the digits to be editable
9332     * (values in #Elm_Clock_Digedit).
9333     *
9334     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9335     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9336     * EINA_FALSE).
9337     *
9338     * @see elm_clock_digit_edit_get()
9339     *
9340     * @ingroup Clock
9341     */
9342    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9343
9344    /**
9345     * Retrieve what digits of the given clock widget should be
9346     * editable when in edition mode.
9347     *
9348     * @param obj The clock object
9349     * @return Bit mask indicating the digits to be editable
9350     * (values in #Elm_Clock_Digedit).
9351     *
9352     * @see elm_clock_digit_edit_set() for more details
9353     *
9354     * @ingroup Clock
9355     */
9356    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9357
9358    /**
9359     * Set if the given clock widget must show hours in military or
9360     * am/pm mode
9361     *
9362     * @param obj The clock object
9363     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9364     * to military mode
9365     *
9366     * This function sets if the clock must show hours in military or
9367     * am/pm mode. In some countries like Brazil the military mode
9368     * (00-24h-format) is used, in opposition to the USA, where the
9369     * am/pm mode is more commonly used.
9370     *
9371     * @see elm_clock_show_am_pm_get()
9372     *
9373     * @ingroup Clock
9374     */
9375    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9376
9377    /**
9378     * Get if the given clock widget shows hours in military or am/pm
9379     * mode
9380     *
9381     * @param obj The clock object
9382     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9383     * military
9384     *
9385     * This function gets if the clock shows hours in military or am/pm
9386     * mode.
9387     *
9388     * @see elm_clock_show_am_pm_set() for more details
9389     *
9390     * @ingroup Clock
9391     */
9392    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9393
9394    /**
9395     * Set if the given clock widget must show time with seconds or not
9396     *
9397     * @param obj The clock object
9398     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9399     *
9400     * This function sets if the given clock must show or not elapsed
9401     * seconds. By default, they are @b not shown.
9402     *
9403     * @see elm_clock_show_seconds_get()
9404     *
9405     * @ingroup Clock
9406     */
9407    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9408
9409    /**
9410     * Get whether the given clock widget is showing time with seconds
9411     * or not
9412     *
9413     * @param obj The clock object
9414     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9415     *
9416     * This function gets whether @p obj is showing or not the elapsed
9417     * seconds.
9418     *
9419     * @see elm_clock_show_seconds_set()
9420     *
9421     * @ingroup Clock
9422     */
9423    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9424
9425    /**
9426     * Set the interval on time updates for an user mouse button hold
9427     * on clock widgets' time edition.
9428     *
9429     * @param obj The clock object
9430     * @param interval The (first) interval value in seconds
9431     *
9432     * This interval value is @b decreased while the user holds the
9433     * mouse pointer either incrementing or decrementing a given the
9434     * clock digit's value.
9435     *
9436     * This helps the user to get to a given time distant from the
9437     * current one easier/faster, as it will start to flip quicker and
9438     * quicker on mouse button holds.
9439     *
9440     * The calculation for the next flip interval value, starting from
9441     * the one set with this call, is the previous interval divided by
9442     * 1.05, so it decreases a little bit.
9443     *
9444     * The default starting interval value for automatic flips is
9445     * @b 0.85 seconds.
9446     *
9447     * @see elm_clock_interval_get()
9448     *
9449     * @ingroup Clock
9450     */
9451    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9452
9453    /**
9454     * Get the interval on time updates for an user mouse button hold
9455     * on clock widgets' time edition.
9456     *
9457     * @param obj The clock object
9458     * @return The (first) interval value, in seconds, set on it
9459     *
9460     * @see elm_clock_interval_set() for more details
9461     *
9462     * @ingroup Clock
9463     */
9464    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9465
9466    /**
9467     * @}
9468     */
9469
9470    /**
9471     * @defgroup Layout Layout
9472     *
9473     * @image html img/widget/layout/preview-00.png
9474     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9475     *
9476     * @image html img/layout-predefined.png
9477     * @image latex img/layout-predefined.eps width=\textwidth
9478     *
9479     * This is a container widget that takes a standard Edje design file and
9480     * wraps it very thinly in a widget.
9481     *
9482     * An Edje design (theme) file has a very wide range of possibilities to
9483     * describe the behavior of elements added to the Layout. Check out the Edje
9484     * documentation and the EDC reference to get more information about what can
9485     * be done with Edje.
9486     *
9487     * Just like @ref List, @ref Box, and other container widgets, any
9488     * object added to the Layout will become its child, meaning that it will be
9489     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9490     *
9491     * The Layout widget can contain as many Contents, Boxes or Tables as
9492     * described in its theme file. For instance, objects can be added to
9493     * different Tables by specifying the respective Table part names. The same
9494     * is valid for Content and Box.
9495     *
9496     * The objects added as child of the Layout will behave as described in the
9497     * part description where they were added. There are 3 possible types of
9498     * parts where a child can be added:
9499     *
9500     * @section secContent Content (SWALLOW part)
9501     *
9502     * Only one object can be added to the @c SWALLOW part (but you still can
9503     * have many @c SWALLOW parts and one object on each of them). Use the @c
9504     * elm_layout_content_* set of functions to set, retrieve and unset objects
9505     * as content of the @c SWALLOW. After being set to this part, the object
9506     * size, position, visibility, clipping and other description properties
9507     * will be totally controled by the description of the given part (inside
9508     * the Edje theme file).
9509     *
9510     * One can use @c evas_object_size_hint_* functions on the child to have some
9511     * kind of control over its behavior, but the resulting behavior will still
9512     * depend heavily on the @c SWALLOW part description.
9513     *
9514     * The Edje theme also can change the part description, based on signals or
9515     * scripts running inside the theme. This change can also be animated. All of
9516     * this will affect the child object set as content accordingly. The object
9517     * size will be changed if the part size is changed, it will animate move if
9518     * the part is moving, and so on.
9519     *
9520     * The following picture demonstrates a Layout widget with a child object
9521     * added to its @c SWALLOW:
9522     *
9523     * @image html layout_swallow.png
9524     * @image latex layout_swallow.eps width=\textwidth
9525     *
9526     * @section secBox Box (BOX part)
9527     *
9528     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9529     * allows one to add objects to the box and have them distributed along its
9530     * area, accordingly to the specified @a layout property (now by @a layout we
9531     * mean the chosen layouting design of the Box, not the Layout widget
9532     * itself).
9533     *
9534     * A similar effect for having a box with its position, size and other things
9535     * controled by the Layout theme would be to create an Elementary @ref Box
9536     * widget and add it as a Content in the @c SWALLOW part.
9537     *
9538     * The main difference of using the Layout Box is that its behavior, the box
9539     * properties like layouting format, padding, align, etc. will be all
9540     * controled by the theme. This means, for example, that a signal could be
9541     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9542     * handled the signal by changing the box padding, or align, or both. Using
9543     * the Elementary @ref Box widget is not necessarily harder or easier, it
9544     * just depends on the circunstances and requirements.
9545     *
9546     * The Layout Box can be used through the @c elm_layout_box_* set of
9547     * functions.
9548     *
9549     * The following picture demonstrates a Layout widget with many child objects
9550     * added to its @c BOX part:
9551     *
9552     * @image html layout_box.png
9553     * @image latex layout_box.eps width=\textwidth
9554     *
9555     * @section secTable Table (TABLE part)
9556     *
9557     * Just like the @ref secBox, the Layout Table is very similar to the
9558     * Elementary @ref Table widget. It allows one to add objects to the Table
9559     * specifying the row and column where the object should be added, and any
9560     * column or row span if necessary.
9561     *
9562     * Again, we could have this design by adding a @ref Table widget to the @c
9563     * SWALLOW part using elm_layout_content_set(). The same difference happens
9564     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9565     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9566     *
9567     * The Layout Table can be used through the @c elm_layout_table_* set of
9568     * functions.
9569     *
9570     * The following picture demonstrates a Layout widget with many child objects
9571     * added to its @c TABLE part:
9572     *
9573     * @image html layout_table.png
9574     * @image latex layout_table.eps width=\textwidth
9575     *
9576     * @section secPredef Predefined Layouts
9577     *
9578     * Another interesting thing about the Layout widget is that it offers some
9579     * predefined themes that come with the default Elementary theme. These
9580     * themes can be set by the call elm_layout_theme_set(), and provide some
9581     * basic functionality depending on the theme used.
9582     *
9583     * Most of them already send some signals, some already provide a toolbar or
9584     * back and next buttons.
9585     *
9586     * These are available predefined theme layouts. All of them have class = @c
9587     * layout, group = @c application, and style = one of the following options:
9588     *
9589     * @li @c toolbar-content - application with toolbar and main content area
9590     * @li @c toolbar-content-back - application with toolbar and main content
9591     * area with a back button and title area
9592     * @li @c toolbar-content-back-next - application with toolbar and main
9593     * content area with a back and next buttons and title area
9594     * @li @c content-back - application with a main content area with a back
9595     * button and title area
9596     * @li @c content-back-next - application with a main content area with a
9597     * back and next buttons and title area
9598     * @li @c toolbar-vbox - application with toolbar and main content area as a
9599     * vertical box
9600     * @li @c toolbar-table - application with toolbar and main content area as a
9601     * table
9602     *
9603     * @section secExamples Examples
9604     *
9605     * Some examples of the Layout widget can be found here:
9606     * @li @ref layout_example_01
9607     * @li @ref layout_example_02
9608     * @li @ref layout_example_03
9609     * @li @ref layout_example_edc
9610     *
9611     */
9612
9613    /**
9614     * Add a new layout to the parent
9615     *
9616     * @param parent The parent object
9617     * @return The new object or NULL if it cannot be created
9618     *
9619     * @see elm_layout_file_set()
9620     * @see elm_layout_theme_set()
9621     *
9622     * @ingroup Layout
9623     */
9624    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9625    /**
9626     * Set the file that will be used as layout
9627     *
9628     * @param obj The layout object
9629     * @param file The path to file (edj) that will be used as layout
9630     * @param group The group that the layout belongs in edje file
9631     *
9632     * @return (1 = success, 0 = error)
9633     *
9634     * @ingroup Layout
9635     */
9636    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9637    /**
9638     * Set the edje group from the elementary theme that will be used as layout
9639     *
9640     * @param obj The layout object
9641     * @param clas the clas of the group
9642     * @param group the group
9643     * @param style the style to used
9644     *
9645     * @return (1 = success, 0 = error)
9646     *
9647     * @ingroup Layout
9648     */
9649    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9650    /**
9651     * Set the layout content.
9652     *
9653     * @param obj The layout object
9654     * @param swallow The swallow part name in the edje file
9655     * @param content The child that will be added in this layout object
9656     *
9657     * Once the content object is set, a previously set one will be deleted.
9658     * If you want to keep that old content object, use the
9659     * elm_layout_content_unset() function.
9660     *
9661     * @note In an Edje theme, the part used as a content container is called @c
9662     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9663     * expected to be a part name just like the second parameter of
9664     * elm_layout_box_append().
9665     *
9666     * @see elm_layout_box_append()
9667     * @see elm_layout_content_get()
9668     * @see elm_layout_content_unset()
9669     * @see @ref secBox
9670     *
9671     * @ingroup Layout
9672     */
9673    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9674    /**
9675     * Get the child object in the given content part.
9676     *
9677     * @param obj The layout object
9678     * @param swallow The SWALLOW part to get its content
9679     *
9680     * @return The swallowed object or NULL if none or an error occurred
9681     *
9682     * @see elm_layout_content_set()
9683     *
9684     * @ingroup Layout
9685     */
9686    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9687    /**
9688     * Unset the layout content.
9689     *
9690     * @param obj The layout object
9691     * @param swallow The swallow part name in the edje file
9692     * @return The content that was being used
9693     *
9694     * Unparent and return the content object which was set for this part.
9695     *
9696     * @see elm_layout_content_set()
9697     *
9698     * @ingroup Layout
9699     */
9700     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9701    /**
9702     * Set the text of the given part
9703     *
9704     * @param obj The layout object
9705     * @param part The TEXT part where to set the text
9706     * @param text The text to set
9707     *
9708     * @ingroup Layout
9709     * @deprecated use elm_object_text_* instead.
9710     */
9711    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9712    /**
9713     * Get the text set in the given part
9714     *
9715     * @param obj The layout object
9716     * @param part The TEXT part to retrieve the text off
9717     *
9718     * @return The text set in @p part
9719     *
9720     * @ingroup Layout
9721     * @deprecated use elm_object_text_* instead.
9722     */
9723    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9724    /**
9725     * Append child to layout box part.
9726     *
9727     * @param obj the layout object
9728     * @param part the box part to which the object will be appended.
9729     * @param child the child object to append to box.
9730     *
9731     * Once the object is appended, it will become child of the layout. Its
9732     * lifetime will be bound to the layout, whenever the layout dies the child
9733     * will be deleted automatically. One should use elm_layout_box_remove() to
9734     * make this layout forget about the object.
9735     *
9736     * @see elm_layout_box_prepend()
9737     * @see elm_layout_box_insert_before()
9738     * @see elm_layout_box_insert_at()
9739     * @see elm_layout_box_remove()
9740     *
9741     * @ingroup Layout
9742     */
9743    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9744    /**
9745     * Prepend child to layout box part.
9746     *
9747     * @param obj the layout object
9748     * @param part the box part to prepend.
9749     * @param child the child object to prepend to box.
9750     *
9751     * Once the object is prepended, it will become child of the layout. Its
9752     * lifetime will be bound to the layout, whenever the layout dies the child
9753     * will be deleted automatically. One should use elm_layout_box_remove() to
9754     * make this layout forget about the object.
9755     *
9756     * @see elm_layout_box_append()
9757     * @see elm_layout_box_insert_before()
9758     * @see elm_layout_box_insert_at()
9759     * @see elm_layout_box_remove()
9760     *
9761     * @ingroup Layout
9762     */
9763    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9764    /**
9765     * Insert child to layout box part before a reference object.
9766     *
9767     * @param obj the layout object
9768     * @param part the box part to insert.
9769     * @param child the child object to insert into box.
9770     * @param reference another reference object to insert before in box.
9771     *
9772     * Once the object is inserted, it will become child of the layout. Its
9773     * lifetime will be bound to the layout, whenever the layout dies the child
9774     * will be deleted automatically. One should use elm_layout_box_remove() to
9775     * make this layout forget about the object.
9776     *
9777     * @see elm_layout_box_append()
9778     * @see elm_layout_box_prepend()
9779     * @see elm_layout_box_insert_before()
9780     * @see elm_layout_box_remove()
9781     *
9782     * @ingroup Layout
9783     */
9784    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9785    /**
9786     * Insert child to layout box part at a given position.
9787     *
9788     * @param obj the layout object
9789     * @param part the box part to insert.
9790     * @param child the child object to insert into box.
9791     * @param pos the numeric position >=0 to insert the child.
9792     *
9793     * Once the object is inserted, it will become child of the layout. Its
9794     * lifetime will be bound to the layout, whenever the layout dies the child
9795     * will be deleted automatically. One should use elm_layout_box_remove() to
9796     * make this layout forget about the object.
9797     *
9798     * @see elm_layout_box_append()
9799     * @see elm_layout_box_prepend()
9800     * @see elm_layout_box_insert_before()
9801     * @see elm_layout_box_remove()
9802     *
9803     * @ingroup Layout
9804     */
9805    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9806    /**
9807     * Remove a child of the given part box.
9808     *
9809     * @param obj The layout object
9810     * @param part The box part name to remove child.
9811     * @param child The object to remove from box.
9812     * @return The object that was being used, or NULL if not found.
9813     *
9814     * The object will be removed from the box part and its lifetime will
9815     * not be handled by the layout anymore. This is equivalent to
9816     * elm_layout_content_unset() for box.
9817     *
9818     * @see elm_layout_box_append()
9819     * @see elm_layout_box_remove_all()
9820     *
9821     * @ingroup Layout
9822     */
9823    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9824    /**
9825     * Remove all child of the given part box.
9826     *
9827     * @param obj The layout object
9828     * @param part The box part name to remove child.
9829     * @param clear If EINA_TRUE, then all objects will be deleted as
9830     *        well, otherwise they will just be removed and will be
9831     *        dangling on the canvas.
9832     *
9833     * The objects will be removed from the box part and their lifetime will
9834     * not be handled by the layout anymore. This is equivalent to
9835     * elm_layout_box_remove() for all box children.
9836     *
9837     * @see elm_layout_box_append()
9838     * @see elm_layout_box_remove()
9839     *
9840     * @ingroup Layout
9841     */
9842    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9843    /**
9844     * Insert child to layout table part.
9845     *
9846     * @param obj the layout object
9847     * @param part the box part to pack child.
9848     * @param child_obj the child object to pack into table.
9849     * @param col the column to which the child should be added. (>= 0)
9850     * @param row the row to which the child should be added. (>= 0)
9851     * @param colspan how many columns should be used to store this object. (>=
9852     *        1)
9853     * @param rowspan how many rows should be used to store this object. (>= 1)
9854     *
9855     * Once the object is inserted, it will become child of the table. Its
9856     * lifetime will be bound to the layout, and whenever the layout dies the
9857     * child will be deleted automatically. One should use
9858     * elm_layout_table_remove() to make this layout forget about the object.
9859     *
9860     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9861     * more space than a single cell. For instance, the following code:
9862     * @code
9863     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9864     * @endcode
9865     *
9866     * Would result in an object being added like the following picture:
9867     *
9868     * @image html layout_colspan.png
9869     * @image latex layout_colspan.eps width=\textwidth
9870     *
9871     * @see elm_layout_table_unpack()
9872     * @see elm_layout_table_clear()
9873     *
9874     * @ingroup Layout
9875     */
9876    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);
9877    /**
9878     * Unpack (remove) a child of the given part table.
9879     *
9880     * @param obj The layout object
9881     * @param part The table part name to remove child.
9882     * @param child_obj The object to remove from table.
9883     * @return The object that was being used, or NULL if not found.
9884     *
9885     * The object will be unpacked from the table part and its lifetime
9886     * will not be handled by the layout anymore. This is equivalent to
9887     * elm_layout_content_unset() for table.
9888     *
9889     * @see elm_layout_table_pack()
9890     * @see elm_layout_table_clear()
9891     *
9892     * @ingroup Layout
9893     */
9894    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9895    /**
9896     * Remove all child of the given part table.
9897     *
9898     * @param obj The layout object
9899     * @param part The table part name to remove child.
9900     * @param clear If EINA_TRUE, then all objects will be deleted as
9901     *        well, otherwise they will just be removed and will be
9902     *        dangling on the canvas.
9903     *
9904     * The objects will be removed from the table part and their lifetime will
9905     * not be handled by the layout anymore. This is equivalent to
9906     * elm_layout_table_unpack() for all table children.
9907     *
9908     * @see elm_layout_table_pack()
9909     * @see elm_layout_table_unpack()
9910     *
9911     * @ingroup Layout
9912     */
9913    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9914    /**
9915     * Get the edje layout
9916     *
9917     * @param obj The layout object
9918     *
9919     * @return A Evas_Object with the edje layout settings loaded
9920     * with function elm_layout_file_set
9921     *
9922     * This returns the edje object. It is not expected to be used to then
9923     * swallow objects via edje_object_part_swallow() for example. Use
9924     * elm_layout_content_set() instead so child object handling and sizing is
9925     * done properly.
9926     *
9927     * @note This function should only be used if you really need to call some
9928     * low level Edje function on this edje object. All the common stuff (setting
9929     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9930     * with proper elementary functions.
9931     *
9932     * @see elm_object_signal_callback_add()
9933     * @see elm_object_signal_emit()
9934     * @see elm_object_text_part_set()
9935     * @see elm_layout_content_set()
9936     * @see elm_layout_box_append()
9937     * @see elm_layout_table_pack()
9938     * @see elm_layout_data_get()
9939     *
9940     * @ingroup Layout
9941     */
9942    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9943    /**
9944     * Get the edje data from the given layout
9945     *
9946     * @param obj The layout object
9947     * @param key The data key
9948     *
9949     * @return The edje data string
9950     *
9951     * This function fetches data specified inside the edje theme of this layout.
9952     * This function return NULL if data is not found.
9953     *
9954     * In EDC this comes from a data block within the group block that @p
9955     * obj was loaded from. E.g.
9956     *
9957     * @code
9958     * collections {
9959     *   group {
9960     *     name: "a_group";
9961     *     data {
9962     *       item: "key1" "value1";
9963     *       item: "key2" "value2";
9964     *     }
9965     *   }
9966     * }
9967     * @endcode
9968     *
9969     * @ingroup Layout
9970     */
9971    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9972    /**
9973     * Eval sizing
9974     *
9975     * @param obj The layout object
9976     *
9977     * Manually forces a sizing re-evaluation. This is useful when the minimum
9978     * size required by the edje theme of this layout has changed. The change on
9979     * the minimum size required by the edje theme is not immediately reported to
9980     * the elementary layout, so one needs to call this function in order to tell
9981     * the widget (layout) that it needs to reevaluate its own size.
9982     *
9983     * The minimum size of the theme is calculated based on minimum size of
9984     * parts, the size of elements inside containers like box and table, etc. All
9985     * of this can change due to state changes, and that's when this function
9986     * should be called.
9987     *
9988     * Also note that a standard signal of "size,eval" "elm" emitted from the
9989     * edje object will cause this to happen too.
9990     *
9991     * @ingroup Layout
9992     */
9993    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9994
9995    /**
9996     * Sets a specific cursor for an edje part.
9997     *
9998     * @param obj The layout object.
9999     * @param part_name a part from loaded edje group.
10000     * @param cursor cursor name to use, see Elementary_Cursor.h
10001     *
10002     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10003     *         part not exists or it has "mouse_events: 0".
10004     *
10005     * @ingroup Layout
10006     */
10007    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10008
10009    /**
10010     * Get the cursor to be shown when mouse is over an edje part
10011     *
10012     * @param obj The layout object.
10013     * @param part_name a part from loaded edje group.
10014     * @return the cursor name.
10015     *
10016     * @ingroup Layout
10017     */
10018    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10019
10020    /**
10021     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10022     *
10023     * @param obj The layout object.
10024     * @param part_name a part from loaded edje group, that had a cursor set
10025     *        with elm_layout_part_cursor_set().
10026     *
10027     * @ingroup Layout
10028     */
10029    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10030
10031    /**
10032     * Sets a specific cursor style for an edje part.
10033     *
10034     * @param obj The layout object.
10035     * @param part_name a part from loaded edje group.
10036     * @param style the theme style to use (default, transparent, ...)
10037     *
10038     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10039     *         part not exists or it did not had a cursor set.
10040     *
10041     * @ingroup Layout
10042     */
10043    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10044
10045    /**
10046     * Gets a specific cursor style for an edje part.
10047     *
10048     * @param obj The layout object.
10049     * @param part_name a part from loaded edje group.
10050     *
10051     * @return the theme style in use, defaults to "default". If the
10052     *         object does not have a cursor set, then NULL is returned.
10053     *
10054     * @ingroup Layout
10055     */
10056    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10057
10058    /**
10059     * Sets if the cursor set should be searched on the theme or should use
10060     * the provided by the engine, only.
10061     *
10062     * @note before you set if should look on theme you should define a
10063     * cursor with elm_layout_part_cursor_set(). By default it will only
10064     * look for cursors provided by the engine.
10065     *
10066     * @param obj The layout object.
10067     * @param part_name a part from loaded edje group.
10068     * @param engine_only if cursors should be just provided by the engine
10069     *        or should also search on widget's theme as well
10070     *
10071     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10072     *         part not exists or it did not had a cursor set.
10073     *
10074     * @ingroup Layout
10075     */
10076    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);
10077
10078    /**
10079     * Gets a specific cursor engine_only for an edje part.
10080     *
10081     * @param obj The layout object.
10082     * @param part_name a part from loaded edje group.
10083     *
10084     * @return whenever the cursor is just provided by engine or also from theme.
10085     *
10086     * @ingroup Layout
10087     */
10088    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10089
10090 /**
10091  * @def elm_layout_icon_set
10092  * Convienience macro to set the icon object in a layout that follows the
10093  * Elementary naming convention for its parts.
10094  *
10095  * @ingroup Layout
10096  */
10097 #define elm_layout_icon_set(_ly, _obj) \
10098   do { \
10099     const char *sig; \
10100     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10101     if ((_obj)) sig = "elm,state,icon,visible"; \
10102     else sig = "elm,state,icon,hidden"; \
10103     elm_object_signal_emit((_ly), sig, "elm"); \
10104   } while (0)
10105
10106 /**
10107  * @def elm_layout_icon_get
10108  * Convienience macro to get the icon object from a layout that follows the
10109  * Elementary naming convention for its parts.
10110  *
10111  * @ingroup Layout
10112  */
10113 #define elm_layout_icon_get(_ly) \
10114   elm_layout_content_get((_ly), "elm.swallow.icon")
10115
10116 /**
10117  * @def elm_layout_end_set
10118  * Convienience macro to set the end object in a layout that follows the
10119  * Elementary naming convention for its parts.
10120  *
10121  * @ingroup Layout
10122  */
10123 #define elm_layout_end_set(_ly, _obj) \
10124   do { \
10125     const char *sig; \
10126     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10127     if ((_obj)) sig = "elm,state,end,visible"; \
10128     else sig = "elm,state,end,hidden"; \
10129     elm_object_signal_emit((_ly), sig, "elm"); \
10130   } while (0)
10131
10132 /**
10133  * @def elm_layout_end_get
10134  * Convienience macro to get the end object in a layout that follows the
10135  * Elementary naming convention for its parts.
10136  *
10137  * @ingroup Layout
10138  */
10139 #define elm_layout_end_get(_ly) \
10140   elm_layout_content_get((_ly), "elm.swallow.end")
10141
10142 /**
10143  * @def elm_layout_label_set
10144  * Convienience macro to set the label in a layout that follows the
10145  * Elementary naming convention for its parts.
10146  *
10147  * @ingroup Layout
10148  * @deprecated use elm_object_text_* instead.
10149  */
10150 #define elm_layout_label_set(_ly, _txt) \
10151   elm_layout_text_set((_ly), "elm.text", (_txt))
10152
10153 /**
10154  * @def elm_layout_label_get
10155  * Convienience macro to get the label in a layout that follows the
10156  * Elementary naming convention for its parts.
10157  *
10158  * @ingroup Layout
10159  * @deprecated use elm_object_text_* instead.
10160  */
10161 #define elm_layout_label_get(_ly) \
10162   elm_layout_text_get((_ly), "elm.text")
10163
10164    /* smart callbacks called:
10165     * "theme,changed" - when elm theme is changed.
10166     */
10167
10168    /**
10169     * @defgroup Notify Notify
10170     *
10171     * @image html img/widget/notify/preview-00.png
10172     * @image latex img/widget/notify/preview-00.eps
10173     *
10174     * Display a container in a particular region of the parent(top, bottom,
10175     * etc.  A timeout can be set to automatically hide the notify. This is so
10176     * that, after an evas_object_show() on a notify object, if a timeout was set
10177     * on it, it will @b automatically get hidden after that time.
10178     *
10179     * Signals that you can add callbacks for are:
10180     * @li "timeout" - when timeout happens on notify and it's hidden
10181     * @li "block,clicked" - when a click outside of the notify happens
10182     *
10183     * @ref tutorial_notify show usage of the API.
10184     *
10185     * @{
10186     */
10187    /**
10188     * @brief Possible orient values for notify.
10189     *
10190     * This values should be used in conjunction to elm_notify_orient_set() to
10191     * set the position in which the notify should appear(relative to its parent)
10192     * and in conjunction with elm_notify_orient_get() to know where the notify
10193     * is appearing.
10194     */
10195    typedef enum _Elm_Notify_Orient
10196      {
10197         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10198         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10199         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10200         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10201         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10202         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10203         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10204         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10205         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10206         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10207      } Elm_Notify_Orient;
10208    /**
10209     * @brief Add a new notify to the parent
10210     *
10211     * @param parent The parent object
10212     * @return The new object or NULL if it cannot be created
10213     */
10214    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10215    /**
10216     * @brief Set the content of the notify widget
10217     *
10218     * @param obj The notify object
10219     * @param content The content will be filled in this notify object
10220     *
10221     * Once the content object is set, a previously set one will be deleted. If
10222     * you want to keep that old content object, use the
10223     * elm_notify_content_unset() function.
10224     */
10225    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10226    /**
10227     * @brief Unset the content of the notify widget
10228     *
10229     * @param obj The notify object
10230     * @return The content that was being used
10231     *
10232     * Unparent and return the content object which was set for this widget
10233     *
10234     * @see elm_notify_content_set()
10235     */
10236    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10237    /**
10238     * @brief Return the content of the notify widget
10239     *
10240     * @param obj The notify object
10241     * @return The content that is being used
10242     *
10243     * @see elm_notify_content_set()
10244     */
10245    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10246    /**
10247     * @brief Set the notify parent
10248     *
10249     * @param obj The notify object
10250     * @param content The new parent
10251     *
10252     * Once the parent object is set, a previously set one will be disconnected
10253     * and replaced.
10254     */
10255    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10256    /**
10257     * @brief Get the notify parent
10258     *
10259     * @param obj The notify object
10260     * @return The parent
10261     *
10262     * @see elm_notify_parent_set()
10263     */
10264    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10265    /**
10266     * @brief Set the orientation
10267     *
10268     * @param obj The notify object
10269     * @param orient The new orientation
10270     *
10271     * Sets the position in which the notify will appear in its parent.
10272     *
10273     * @see @ref Elm_Notify_Orient for possible values.
10274     */
10275    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10276    /**
10277     * @brief Return the orientation
10278     * @param obj The notify object
10279     * @return The orientation of the notification
10280     *
10281     * @see elm_notify_orient_set()
10282     * @see Elm_Notify_Orient
10283     */
10284    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10285    /**
10286     * @brief Set the time interval after which the notify window is going to be
10287     * hidden.
10288     *
10289     * @param obj The notify object
10290     * @param time The timeout in seconds
10291     *
10292     * This function sets a timeout and starts the timer controlling when the
10293     * notify is hidden. Since calling evas_object_show() on a notify restarts
10294     * the timer controlling when the notify is hidden, setting this before the
10295     * notify is shown will in effect mean starting the timer when the notify is
10296     * shown.
10297     *
10298     * @note Set a value <= 0.0 to disable a running timer.
10299     *
10300     * @note If the value > 0.0 and the notify is previously visible, the
10301     * timer will be started with this value, canceling any running timer.
10302     */
10303    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10304    /**
10305     * @brief Return the timeout value (in seconds)
10306     * @param obj the notify object
10307     *
10308     * @see elm_notify_timeout_set()
10309     */
10310    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10311    /**
10312     * @brief Sets whether events should be passed to by a click outside
10313     * its area.
10314     *
10315     * @param obj The notify object
10316     * @param repeats EINA_TRUE Events are repeats, else no
10317     *
10318     * When true if the user clicks outside the window the events will be caught
10319     * by the others widgets, else the events are blocked.
10320     *
10321     * @note The default value is EINA_TRUE.
10322     */
10323    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10324    /**
10325     * @brief Return true if events are repeat below the notify object
10326     * @param obj the notify object
10327     *
10328     * @see elm_notify_repeat_events_set()
10329     */
10330    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10331    /**
10332     * @}
10333     */
10334
10335    /**
10336     * @defgroup Hover Hover
10337     *
10338     * @image html img/widget/hover/preview-00.png
10339     * @image latex img/widget/hover/preview-00.eps
10340     *
10341     * A Hover object will hover over its @p parent object at the @p target
10342     * location. Anything in the background will be given a darker coloring to
10343     * indicate that the hover object is on top (at the default theme). When the
10344     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10345     * clicked that @b doesn't cause the hover to be dismissed.
10346     *
10347     * @note The hover object will take up the entire space of @p target
10348     * object.
10349     *
10350     * Elementary has the following styles for the hover widget:
10351     * @li default
10352     * @li popout
10353     * @li menu
10354     * @li hoversel_vertical
10355     *
10356     * The following are the available position for content:
10357     * @li left
10358     * @li top-left
10359     * @li top
10360     * @li top-right
10361     * @li right
10362     * @li bottom-right
10363     * @li bottom
10364     * @li bottom-left
10365     * @li middle
10366     * @li smart
10367     *
10368     * Signals that you can add callbacks for are:
10369     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10370     * @li "smart,changed" - a content object placed under the "smart"
10371     *                   policy was replaced to a new slot direction.
10372     *
10373     * See @ref tutorial_hover for more information.
10374     *
10375     * @{
10376     */
10377    typedef enum _Elm_Hover_Axis
10378      {
10379         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10380         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10381         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10382         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10383      } Elm_Hover_Axis;
10384    /**
10385     * @brief Adds a hover object to @p parent
10386     *
10387     * @param parent The parent object
10388     * @return The hover object or NULL if one could not be created
10389     */
10390    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10391    /**
10392     * @brief Sets the target object for the hover.
10393     *
10394     * @param obj The hover object
10395     * @param target The object to center the hover onto. The hover
10396     *
10397     * This function will cause the hover to be centered on the target object.
10398     */
10399    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10400    /**
10401     * @brief Gets the target object for the hover.
10402     *
10403     * @param obj The hover object
10404     * @param parent The object to locate the hover over.
10405     *
10406     * @see elm_hover_target_set()
10407     */
10408    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10409    /**
10410     * @brief Sets the parent object for the hover.
10411     *
10412     * @param obj The hover object
10413     * @param parent The object to locate the hover over.
10414     *
10415     * This function will cause the hover to take up the entire space that the
10416     * parent object fills.
10417     */
10418    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10419    /**
10420     * @brief Gets the parent object for the hover.
10421     *
10422     * @param obj The hover object
10423     * @return The parent object to locate the hover over.
10424     *
10425     * @see elm_hover_parent_set()
10426     */
10427    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10428    /**
10429     * @brief Sets the content of the hover object and the direction in which it
10430     * will pop out.
10431     *
10432     * @param obj The hover object
10433     * @param swallow The direction that the object will be displayed
10434     * at. Accepted values are "left", "top-left", "top", "top-right",
10435     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10436     * "smart".
10437     * @param content The content to place at @p swallow
10438     *
10439     * Once the content object is set for a given direction, a previously
10440     * set one (on the same direction) will be deleted. If you want to
10441     * keep that old content object, use the elm_hover_content_unset()
10442     * function.
10443     *
10444     * All directions may have contents at the same time, except for
10445     * "smart". This is a special placement hint and its use case
10446     * independs of the calculations coming from
10447     * elm_hover_best_content_location_get(). Its use is for cases when
10448     * one desires only one hover content, but with a dinamic special
10449     * placement within the hover area. The content's geometry, whenever
10450     * it changes, will be used to decide on a best location not
10451     * extrapolating the hover's parent object view to show it in (still
10452     * being the hover's target determinant of its medium part -- move and
10453     * resize it to simulate finger sizes, for example). If one of the
10454     * directions other than "smart" are used, a previously content set
10455     * using it will be deleted, and vice-versa.
10456     */
10457    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10458    /**
10459     * @brief Get the content of the hover object, in a given direction.
10460     *
10461     * Return the content object which was set for this widget in the
10462     * @p swallow direction.
10463     *
10464     * @param obj The hover object
10465     * @param swallow The direction that the object was display at.
10466     * @return The content that was being used
10467     *
10468     * @see elm_hover_content_set()
10469     */
10470    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10471    /**
10472     * @brief Unset the content of the hover object, in a given direction.
10473     *
10474     * Unparent and return the content object set at @p swallow direction.
10475     *
10476     * @param obj The hover object
10477     * @param swallow The direction that the object was display at.
10478     * @return The content that was being used.
10479     *
10480     * @see elm_hover_content_set()
10481     */
10482    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10483    /**
10484     * @brief Returns the best swallow location for content in the hover.
10485     *
10486     * @param obj The hover object
10487     * @param pref_axis The preferred orientation axis for the hover object to use
10488     * @return The edje location to place content into the hover or @c
10489     *         NULL, on errors.
10490     *
10491     * Best is defined here as the location at which there is the most available
10492     * space.
10493     *
10494     * @p pref_axis may be one of
10495     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10496     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10497     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10498     * - @c ELM_HOVER_AXIS_BOTH -- both
10499     *
10500     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10501     * nescessarily be along the horizontal axis("left" or "right"). If
10502     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10503     * be along the vertical axis("top" or "bottom"). Chossing
10504     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10505     * returned position may be in either axis.
10506     *
10507     * @see elm_hover_content_set()
10508     */
10509    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10510    /**
10511     * @}
10512     */
10513
10514    /* entry */
10515    /**
10516     * @defgroup Entry Entry
10517     *
10518     * @image html img/widget/entry/preview-00.png
10519     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10520     * @image html img/widget/entry/preview-01.png
10521     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10522     * @image html img/widget/entry/preview-02.png
10523     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10524     * @image html img/widget/entry/preview-03.png
10525     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10526     *
10527     * An entry is a convenience widget which shows a box that the user can
10528     * enter text into. Entries by default don't scroll, so they grow to
10529     * accomodate the entire text, resizing the parent window as needed. This
10530     * can be changed with the elm_entry_scrollable_set() function.
10531     *
10532     * They can also be single line or multi line (the default) and when set
10533     * to multi line mode they support text wrapping in any of the modes
10534     * indicated by #Elm_Wrap_Type.
10535     *
10536     * Other features include password mode, filtering of inserted text with
10537     * elm_entry_text_filter_append() and related functions, inline "items" and
10538     * formatted markup text.
10539     *
10540     * @section entry-markup Formatted text
10541     *
10542     * The markup tags supported by the Entry are defined by the theme, but
10543     * even when writing new themes or extensions it's a good idea to stick to
10544     * a sane default, to maintain coherency and avoid application breakages.
10545     * Currently defined by the default theme are the following tags:
10546     * @li \<br\>: Inserts a line break.
10547     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10548     * breaks.
10549     * @li \<tab\>: Inserts a tab.
10550     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10551     * enclosed text.
10552     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10553     * @li \<link\>...\</link\>: Underlines the enclosed text.
10554     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10555     *
10556     * @section entry-special Special markups
10557     *
10558     * Besides those used to format text, entries support two special markup
10559     * tags used to insert clickable portions of text or items inlined within
10560     * the text.
10561     *
10562     * @subsection entry-anchors Anchors
10563     *
10564     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10565     * \</a\> tags and an event will be generated when this text is clicked,
10566     * like this:
10567     *
10568     * @code
10569     * This text is outside <a href=anc-01>but this one is an anchor</a>
10570     * @endcode
10571     *
10572     * The @c href attribute in the opening tag gives the name that will be
10573     * used to identify the anchor and it can be any valid utf8 string.
10574     *
10575     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10576     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10577     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10578     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10579     * an anchor.
10580     *
10581     * @subsection entry-items Items
10582     *
10583     * Inlined in the text, any other @c Evas_Object can be inserted by using
10584     * \<item\> tags this way:
10585     *
10586     * @code
10587     * <item size=16x16 vsize=full href=emoticon/haha></item>
10588     * @endcode
10589     *
10590     * Just like with anchors, the @c href identifies each item, but these need,
10591     * in addition, to indicate their size, which is done using any one of
10592     * @c size, @c absize or @c relsize attributes. These attributes take their
10593     * value in the WxH format, where W is the width and H the height of the
10594     * item.
10595     *
10596     * @li absize: Absolute pixel size for the item. Whatever value is set will
10597     * be the item's size regardless of any scale value the object may have
10598     * been set to. The final line height will be adjusted to fit larger items.
10599     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10600     * for the object.
10601     * @li relsize: Size is adjusted for the item to fit within the current
10602     * line height.
10603     *
10604     * Besides their size, items are specificed a @c vsize value that affects
10605     * how their final size and position are calculated. The possible values
10606     * are:
10607     * @li ascent: Item will be placed within the line's baseline and its
10608     * ascent. That is, the height between the line where all characters are
10609     * positioned and the highest point in the line. For @c size and @c absize
10610     * items, the descent value will be added to the total line height to make
10611     * them fit. @c relsize items will be adjusted to fit within this space.
10612     * @li full: Items will be placed between the descent and ascent, or the
10613     * lowest point in the line and its highest.
10614     *
10615     * The next image shows different configurations of items and how they
10616     * are the previously mentioned options affect their sizes. In all cases,
10617     * the green line indicates the ascent, blue for the baseline and red for
10618     * the descent.
10619     *
10620     * @image html entry_item.png
10621     * @image latex entry_item.eps width=\textwidth
10622     *
10623     * And another one to show how size differs from absize. In the first one,
10624     * the scale value is set to 1.0, while the second one is using one of 2.0.
10625     *
10626     * @image html entry_item_scale.png
10627     * @image latex entry_item_scale.eps width=\textwidth
10628     *
10629     * After the size for an item is calculated, the entry will request an
10630     * object to place in its space. For this, the functions set with
10631     * elm_entry_item_provider_append() and related functions will be called
10632     * in order until one of them returns a @c non-NULL value. If no providers
10633     * are available, or all of them return @c NULL, then the entry falls back
10634     * to one of the internal defaults, provided the name matches with one of
10635     * them.
10636     *
10637     * All of the following are currently supported:
10638     *
10639     * - emoticon/angry
10640     * - emoticon/angry-shout
10641     * - emoticon/crazy-laugh
10642     * - emoticon/evil-laugh
10643     * - emoticon/evil
10644     * - emoticon/goggle-smile
10645     * - emoticon/grumpy
10646     * - emoticon/grumpy-smile
10647     * - emoticon/guilty
10648     * - emoticon/guilty-smile
10649     * - emoticon/haha
10650     * - emoticon/half-smile
10651     * - emoticon/happy-panting
10652     * - emoticon/happy
10653     * - emoticon/indifferent
10654     * - emoticon/kiss
10655     * - emoticon/knowing-grin
10656     * - emoticon/laugh
10657     * - emoticon/little-bit-sorry
10658     * - emoticon/love-lots
10659     * - emoticon/love
10660     * - emoticon/minimal-smile
10661     * - emoticon/not-happy
10662     * - emoticon/not-impressed
10663     * - emoticon/omg
10664     * - emoticon/opensmile
10665     * - emoticon/smile
10666     * - emoticon/sorry
10667     * - emoticon/squint-laugh
10668     * - emoticon/surprised
10669     * - emoticon/suspicious
10670     * - emoticon/tongue-dangling
10671     * - emoticon/tongue-poke
10672     * - emoticon/uh
10673     * - emoticon/unhappy
10674     * - emoticon/very-sorry
10675     * - emoticon/what
10676     * - emoticon/wink
10677     * - emoticon/worried
10678     * - emoticon/wtf
10679     *
10680     * Alternatively, an item may reference an image by its path, using
10681     * the URI form @c file:///path/to/an/image.png and the entry will then
10682     * use that image for the item.
10683     *
10684     * @section entry-files Loading and saving files
10685     *
10686     * Entries have convinience functions to load text from a file and save
10687     * changes back to it after a short delay. The automatic saving is enabled
10688     * by default, but can be disabled with elm_entry_autosave_set() and files
10689     * can be loaded directly as plain text or have any markup in them
10690     * recognized. See elm_entry_file_set() for more details.
10691     *
10692     * @section entry-signals Emitted signals
10693     *
10694     * This widget emits the following signals:
10695     *
10696     * @li "changed": The text within the entry was changed.
10697     * @li "changed,user": The text within the entry was changed because of user interaction.
10698     * @li "activated": The enter key was pressed on a single line entry.
10699     * @li "press": A mouse button has been pressed on the entry.
10700     * @li "longpressed": A mouse button has been pressed and held for a couple
10701     * seconds.
10702     * @li "clicked": The entry has been clicked (mouse press and release).
10703     * @li "clicked,double": The entry has been double clicked.
10704     * @li "clicked,triple": The entry has been triple clicked.
10705     * @li "focused": The entry has received focus.
10706     * @li "unfocused": The entry has lost focus.
10707     * @li "selection,paste": A paste of the clipboard contents was requested.
10708     * @li "selection,copy": A copy of the selected text into the clipboard was
10709     * requested.
10710     * @li "selection,cut": A cut of the selected text into the clipboard was
10711     * requested.
10712     * @li "selection,start": A selection has begun and no previous selection
10713     * existed.
10714     * @li "selection,changed": The current selection has changed.
10715     * @li "selection,cleared": The current selection has been cleared.
10716     * @li "cursor,changed": The cursor has changed position.
10717     * @li "anchor,clicked": An anchor has been clicked. The event_info
10718     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10719     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10720     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10721     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10722     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10723     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10724     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10725     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10726     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10727     * @li "preedit,changed": The preedit string has changed.
10728     *
10729     * @section entry-examples
10730     *
10731     * An overview of the Entry API can be seen in @ref entry_example_01
10732     *
10733     * @{
10734     */
10735    /**
10736     * @typedef Elm_Entry_Anchor_Info
10737     *
10738     * The info sent in the callback for the "anchor,clicked" signals emitted
10739     * by entries.
10740     */
10741    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10742    /**
10743     * @struct _Elm_Entry_Anchor_Info
10744     *
10745     * The info sent in the callback for the "anchor,clicked" signals emitted
10746     * by entries.
10747     */
10748    struct _Elm_Entry_Anchor_Info
10749      {
10750         const char *name; /**< The name of the anchor, as stated in its href */
10751         int         button; /**< The mouse button used to click on it */
10752         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10753                     y, /**< Anchor geometry, relative to canvas */
10754                     w, /**< Anchor geometry, relative to canvas */
10755                     h; /**< Anchor geometry, relative to canvas */
10756      };
10757    /**
10758     * @typedef Elm_Entry_Filter_Cb
10759     * This callback type is used by entry filters to modify text.
10760     * @param data The data specified as the last param when adding the filter
10761     * @param entry The entry object
10762     * @param text A pointer to the location of the text being filtered. This data can be modified,
10763     * but any additional allocations must be managed by the user.
10764     * @see elm_entry_text_filter_append
10765     * @see elm_entry_text_filter_prepend
10766     */
10767    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10768
10769    /**
10770     * This adds an entry to @p parent object.
10771     *
10772     * By default, entries are:
10773     * @li not scrolled
10774     * @li multi-line
10775     * @li word wrapped
10776     * @li autosave is enabled
10777     *
10778     * @param parent The parent object
10779     * @return The new object or NULL if it cannot be created
10780     */
10781    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10782    /**
10783     * Sets the entry to single line mode.
10784     *
10785     * In single line mode, entries don't ever wrap when the text reaches the
10786     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10787     * key will generate an @c "activate" event instead of adding a new line.
10788     *
10789     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10790     * and pressing enter will break the text into a different line
10791     * without generating any events.
10792     *
10793     * @param obj The entry object
10794     * @param single_line If true, the text in the entry
10795     * will be on a single line.
10796     */
10797    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10798    /**
10799     * Gets whether the entry is set to be single line.
10800     *
10801     * @param obj The entry object
10802     * @return single_line If true, the text in the entry is set to display
10803     * on a single line.
10804     *
10805     * @see elm_entry_single_line_set()
10806     */
10807    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10808    /**
10809     * Sets the entry to password mode.
10810     *
10811     * In password mode, entries are implicitly single line and the display of
10812     * any text in them is replaced with asterisks (*).
10813     *
10814     * @param obj The entry object
10815     * @param password If true, password mode is enabled.
10816     */
10817    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10818    /**
10819     * Gets whether the entry is set to password mode.
10820     *
10821     * @param obj The entry object
10822     * @return If true, the entry is set to display all characters
10823     * as asterisks (*).
10824     *
10825     * @see elm_entry_password_set()
10826     */
10827    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10828    /**
10829     * This sets the text displayed within the entry to @p entry.
10830     *
10831     * @param obj The entry object
10832     * @param entry The text to be displayed
10833     *
10834     * @deprecated Use elm_object_text_set() instead.
10835     */
10836    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10837    /**
10838     * This returns the text currently shown in object @p entry.
10839     * See also elm_entry_entry_set().
10840     *
10841     * @param obj The entry object
10842     * @return The currently displayed text or NULL on failure
10843     *
10844     * @deprecated Use elm_object_text_get() instead.
10845     */
10846    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10847    /**
10848     * Appends @p entry to the text of the entry.
10849     *
10850     * Adds the text in @p entry to the end of any text already present in the
10851     * widget.
10852     *
10853     * The appended text is subject to any filters set for the widget.
10854     *
10855     * @param obj The entry object
10856     * @param entry The text to be displayed
10857     *
10858     * @see elm_entry_text_filter_append()
10859     */
10860    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10861    /**
10862     * Gets whether the entry is empty.
10863     *
10864     * Empty means no text at all. If there are any markup tags, like an item
10865     * tag for which no provider finds anything, and no text is displayed, this
10866     * function still returns EINA_FALSE.
10867     *
10868     * @param obj The entry object
10869     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10870     */
10871    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10872    /**
10873     * Gets any selected text within the entry.
10874     *
10875     * If there's any selected text in the entry, this function returns it as
10876     * a string in markup format. NULL is returned if no selection exists or
10877     * if an error occurred.
10878     *
10879     * The returned value points to an internal string and should not be freed
10880     * or modified in any way. If the @p entry object is deleted or its
10881     * contents are changed, the returned pointer should be considered invalid.
10882     *
10883     * @param obj The entry object
10884     * @return The selected text within the entry or NULL on failure
10885     */
10886    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10887    /**
10888     * Inserts the given text into the entry at the current cursor position.
10889     *
10890     * This inserts text at the cursor position as if it was typed
10891     * by the user (note that this also allows markup which a user
10892     * can't just "type" as it would be converted to escaped text, so this
10893     * call can be used to insert things like emoticon items or bold push/pop
10894     * tags, other font and color change tags etc.)
10895     *
10896     * If any selection exists, it will be replaced by the inserted text.
10897     *
10898     * The inserted text is subject to any filters set for the widget.
10899     *
10900     * @param obj The entry object
10901     * @param entry The text to insert
10902     *
10903     * @see elm_entry_text_filter_append()
10904     */
10905    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10906    /**
10907     * Set the line wrap type to use on multi-line entries.
10908     *
10909     * Sets the wrap type used by the entry to any of the specified in
10910     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10911     * line (without inserting a line break or paragraph separator) when it
10912     * reaches the far edge of the widget.
10913     *
10914     * Note that this only makes sense for multi-line entries. A widget set
10915     * to be single line will never wrap.
10916     *
10917     * @param obj The entry object
10918     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10919     */
10920    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10921    /**
10922     * Gets the wrap mode the entry was set to use.
10923     *
10924     * @param obj The entry object
10925     * @return Wrap type
10926     *
10927     * @see also elm_entry_line_wrap_set()
10928     */
10929    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10930    /**
10931     * Sets if the entry is to be editable or not.
10932     *
10933     * By default, entries are editable and when focused, any text input by the
10934     * user will be inserted at the current cursor position. But calling this
10935     * function with @p editable as EINA_FALSE will prevent the user from
10936     * inputting text into the entry.
10937     *
10938     * The only way to change the text of a non-editable entry is to use
10939     * elm_object_text_set(), elm_entry_entry_insert() and other related
10940     * functions.
10941     *
10942     * @param obj The entry object
10943     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10944     * if not, the entry is read-only and no user input is allowed.
10945     */
10946    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10947    /**
10948     * Gets whether the entry is editable or not.
10949     *
10950     * @param obj The entry object
10951     * @return If true, the entry is editable by the user.
10952     * If false, it is not editable by the user
10953     *
10954     * @see elm_entry_editable_set()
10955     */
10956    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10957    /**
10958     * This drops any existing text selection within the entry.
10959     *
10960     * @param obj The entry object
10961     */
10962    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10963    /**
10964     * This selects all text within the entry.
10965     *
10966     * @param obj The entry object
10967     */
10968    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10969    /**
10970     * This moves the cursor one place to the right within the entry.
10971     *
10972     * @param obj The entry object
10973     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10974     */
10975    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10976    /**
10977     * This moves the cursor one place to the left within the entry.
10978     *
10979     * @param obj The entry object
10980     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10981     */
10982    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10983    /**
10984     * This moves the cursor one line up within the entry.
10985     *
10986     * @param obj The entry object
10987     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10988     */
10989    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10990    /**
10991     * This moves the cursor one line down within the entry.
10992     *
10993     * @param obj The entry object
10994     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10995     */
10996    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10997    /**
10998     * This moves the cursor to the beginning of the entry.
10999     *
11000     * @param obj The entry object
11001     */
11002    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11003    /**
11004     * This moves the cursor to the end of the entry.
11005     *
11006     * @param obj The entry object
11007     */
11008    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11009    /**
11010     * This moves the cursor to the beginning of the current line.
11011     *
11012     * @param obj The entry object
11013     */
11014    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11015    /**
11016     * This moves the cursor to the end of the current line.
11017     *
11018     * @param obj The entry object
11019     */
11020    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11021    /**
11022     * This begins a selection within the entry as though
11023     * the user were holding down the mouse button to make a selection.
11024     *
11025     * @param obj The entry object
11026     */
11027    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11028    /**
11029     * This ends a selection within the entry as though
11030     * the user had just released the mouse button while making a selection.
11031     *
11032     * @param obj The entry object
11033     */
11034    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11035    /**
11036     * Gets whether a format node exists at the current cursor position.
11037     *
11038     * A format node is anything that defines how the text is rendered. It can
11039     * be a visible format node, such as a line break or a paragraph separator,
11040     * or an invisible one, such as bold begin or end tag.
11041     * This function returns whether any format node exists at the current
11042     * cursor position.
11043     *
11044     * @param obj The entry object
11045     * @return EINA_TRUE if the current cursor position contains a format node,
11046     * EINA_FALSE otherwise.
11047     *
11048     * @see elm_entry_cursor_is_visible_format_get()
11049     */
11050    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11051    /**
11052     * Gets if the current cursor position holds a visible format node.
11053     *
11054     * @param obj The entry object
11055     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11056     * if it's an invisible one or no format exists.
11057     *
11058     * @see elm_entry_cursor_is_format_get()
11059     */
11060    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11061    /**
11062     * Gets the character pointed by the cursor at its current position.
11063     *
11064     * This function returns a string with the utf8 character stored at the
11065     * current cursor position.
11066     * Only the text is returned, any format that may exist will not be part
11067     * of the return value.
11068     *
11069     * @param obj The entry object
11070     * @return The text pointed by the cursors.
11071     */
11072    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11073    /**
11074     * This function returns the geometry of the cursor.
11075     *
11076     * It's useful if you want to draw something on the cursor (or where it is),
11077     * or for example in the case of scrolled entry where you want to show the
11078     * cursor.
11079     *
11080     * @param obj The entry object
11081     * @param x returned geometry
11082     * @param y returned geometry
11083     * @param w returned geometry
11084     * @param h returned geometry
11085     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11086     */
11087    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);
11088    /**
11089     * Sets the cursor position in the entry to the given value
11090     *
11091     * The value in @p pos is the index of the character position within the
11092     * contents of the string as returned by elm_entry_cursor_pos_get().
11093     *
11094     * @param obj The entry object
11095     * @param pos The position of the cursor
11096     */
11097    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11098    /**
11099     * Retrieves the current position of the cursor in the entry
11100     *
11101     * @param obj The entry object
11102     * @return The cursor position
11103     */
11104    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11105    /**
11106     * This executes a "cut" action on the selected text in the entry.
11107     *
11108     * @param obj The entry object
11109     */
11110    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11111    /**
11112     * This executes a "copy" action on the selected text in the entry.
11113     *
11114     * @param obj The entry object
11115     */
11116    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11117    /**
11118     * This executes a "paste" action in the entry.
11119     *
11120     * @param obj The entry object
11121     */
11122    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11123    /**
11124     * This clears and frees the items in a entry's contextual (longpress)
11125     * menu.
11126     *
11127     * @param obj The entry object
11128     *
11129     * @see elm_entry_context_menu_item_add()
11130     */
11131    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11132    /**
11133     * This adds an item to the entry's contextual menu.
11134     *
11135     * A longpress on an entry will make the contextual menu show up, if this
11136     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11137     * By default, this menu provides a few options like enabling selection mode,
11138     * which is useful on embedded devices that need to be explicit about it,
11139     * and when a selection exists it also shows the copy and cut actions.
11140     *
11141     * With this function, developers can add other options to this menu to
11142     * perform any action they deem necessary.
11143     *
11144     * @param obj The entry object
11145     * @param label The item's text label
11146     * @param icon_file The item's icon file
11147     * @param icon_type The item's icon type
11148     * @param func The callback to execute when the item is clicked
11149     * @param data The data to associate with the item for related functions
11150     */
11151    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);
11152    /**
11153     * This disables the entry's contextual (longpress) menu.
11154     *
11155     * @param obj The entry object
11156     * @param disabled If true, the menu is disabled
11157     */
11158    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11159    /**
11160     * This returns whether the entry's contextual (longpress) menu is
11161     * disabled.
11162     *
11163     * @param obj The entry object
11164     * @return If true, the menu is disabled
11165     */
11166    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11167    /**
11168     * This appends a custom item provider to the list for that entry
11169     *
11170     * This appends the given callback. The list is walked from beginning to end
11171     * with each function called given the item href string in the text. If the
11172     * function returns an object handle other than NULL (it should create an
11173     * object to do this), then this object is used to replace that item. If
11174     * not the next provider is called until one provides an item object, or the
11175     * default provider in entry does.
11176     *
11177     * @param obj The entry object
11178     * @param func The function called to provide the item object
11179     * @param data The data passed to @p func
11180     *
11181     * @see @ref entry-items
11182     */
11183    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);
11184    /**
11185     * This prepends a custom item provider to the list for that entry
11186     *
11187     * This prepends the given callback. See elm_entry_item_provider_append() for
11188     * more information
11189     *
11190     * @param obj The entry object
11191     * @param func The function called to provide the item object
11192     * @param data The data passed to @p func
11193     */
11194    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);
11195    /**
11196     * This removes a custom item provider to the list for that entry
11197     *
11198     * This removes the given callback. See elm_entry_item_provider_append() for
11199     * more information
11200     *
11201     * @param obj The entry object
11202     * @param func The function called to provide the item object
11203     * @param data The data passed to @p func
11204     */
11205    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);
11206    /**
11207     * Append a filter function for text inserted in the entry
11208     *
11209     * Append the given callback to the list. This functions will be called
11210     * whenever any text is inserted into the entry, with the text to be inserted
11211     * as a parameter. The callback function is free to alter the text in any way
11212     * it wants, but it must remember to free the given pointer and update it.
11213     * If the new text is to be discarded, the function can free it and set its
11214     * text parameter to NULL. This will also prevent any following filters from
11215     * being called.
11216     *
11217     * @param obj The entry object
11218     * @param func The function to use as text filter
11219     * @param data User data to pass to @p func
11220     */
11221    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11222    /**
11223     * Prepend a filter function for text insdrted in the entry
11224     *
11225     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11226     * for more information
11227     *
11228     * @param obj The entry object
11229     * @param func The function to use as text filter
11230     * @param data User data to pass to @p func
11231     */
11232    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11233    /**
11234     * Remove a filter from the list
11235     *
11236     * Removes the given callback from the filter list. See
11237     * elm_entry_text_filter_append() for more information.
11238     *
11239     * @param obj The entry object
11240     * @param func The filter function to remove
11241     * @param data The user data passed when adding the function
11242     */
11243    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11244    /**
11245     * This converts a markup (HTML-like) string into UTF-8.
11246     *
11247     * The returned string is a malloc'ed buffer and it should be freed when
11248     * not needed anymore.
11249     *
11250     * @param s The string (in markup) to be converted
11251     * @return The converted string (in UTF-8). It should be freed.
11252     */
11253    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11254    /**
11255     * This converts a UTF-8 string into markup (HTML-like).
11256     *
11257     * The returned string is a malloc'ed buffer and it should be freed when
11258     * not needed anymore.
11259     *
11260     * @param s The string (in UTF-8) to be converted
11261     * @return The converted string (in markup). It should be freed.
11262     */
11263    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11264    /**
11265     * This sets the file (and implicitly loads it) for the text to display and
11266     * then edit. All changes are written back to the file after a short delay if
11267     * the entry object is set to autosave (which is the default).
11268     *
11269     * If the entry had any other file set previously, any changes made to it
11270     * will be saved if the autosave feature is enabled, otherwise, the file
11271     * will be silently discarded and any non-saved changes will be lost.
11272     *
11273     * @param obj The entry object
11274     * @param file The path to the file to load and save
11275     * @param format The file format
11276     */
11277    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11278    /**
11279     * Gets the file being edited by the entry.
11280     *
11281     * This function can be used to retrieve any file set on the entry for
11282     * edition, along with the format used to load and save it.
11283     *
11284     * @param obj The entry object
11285     * @param file The path to the file to load and save
11286     * @param format The file format
11287     */
11288    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11289    /**
11290     * This function writes any changes made to the file set with
11291     * elm_entry_file_set()
11292     *
11293     * @param obj The entry object
11294     */
11295    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11296    /**
11297     * This sets the entry object to 'autosave' the loaded text file or not.
11298     *
11299     * @param obj The entry object
11300     * @param autosave Autosave the loaded file or not
11301     *
11302     * @see elm_entry_file_set()
11303     */
11304    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11305    /**
11306     * This gets the entry object's 'autosave' status.
11307     *
11308     * @param obj The entry object
11309     * @return Autosave the loaded file or not
11310     *
11311     * @see elm_entry_file_set()
11312     */
11313    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11314    /**
11315     * Control pasting of text and images for the widget.
11316     *
11317     * Normally the entry allows both text and images to be pasted.  By setting
11318     * textonly to be true, this prevents images from being pasted.
11319     *
11320     * Note this only changes the behaviour of text.
11321     *
11322     * @param obj The entry object
11323     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11324     * text+image+other.
11325     */
11326    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11327    /**
11328     * Getting elm_entry text paste/drop mode.
11329     *
11330     * In textonly mode, only text may be pasted or dropped into the widget.
11331     *
11332     * @param obj The entry object
11333     * @return If the widget only accepts text from pastes.
11334     */
11335    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11336    /**
11337     * Enable or disable scrolling in entry
11338     *
11339     * Normally the entry is not scrollable unless you enable it with this call.
11340     *
11341     * @param obj The entry object
11342     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11343     */
11344    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11345    /**
11346     * Get the scrollable state of the entry
11347     *
11348     * Normally the entry is not scrollable. This gets the scrollable state
11349     * of the entry. See elm_entry_scrollable_set() for more information.
11350     *
11351     * @param obj The entry object
11352     * @return The scrollable state
11353     */
11354    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11355    /**
11356     * This sets a widget to be displayed to the left of a scrolled entry.
11357     *
11358     * @param obj The scrolled entry object
11359     * @param icon The widget to display on the left side of the scrolled
11360     * entry.
11361     *
11362     * @note A previously set widget will be destroyed.
11363     * @note If the object being set does not have minimum size hints set,
11364     * it won't get properly displayed.
11365     *
11366     * @see elm_entry_end_set()
11367     */
11368    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11369    /**
11370     * Gets the leftmost widget of the scrolled entry. This object is
11371     * owned by the scrolled entry and should not be modified.
11372     *
11373     * @param obj The scrolled entry object
11374     * @return the left widget inside the scroller
11375     */
11376    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11377    /**
11378     * Unset the leftmost widget of the scrolled entry, unparenting and
11379     * returning it.
11380     *
11381     * @param obj The scrolled entry object
11382     * @return the previously set icon sub-object of this entry, on
11383     * success.
11384     *
11385     * @see elm_entry_icon_set()
11386     */
11387    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11388    /**
11389     * Sets the visibility of the left-side widget of the scrolled entry,
11390     * set by elm_entry_icon_set().
11391     *
11392     * @param obj The scrolled entry object
11393     * @param setting EINA_TRUE if the object should be displayed,
11394     * EINA_FALSE if not.
11395     */
11396    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11397    /**
11398     * This sets a widget to be displayed to the end of a scrolled entry.
11399     *
11400     * @param obj The scrolled entry object
11401     * @param end The widget to display on the right side of the scrolled
11402     * entry.
11403     *
11404     * @note A previously set widget will be destroyed.
11405     * @note If the object being set does not have minimum size hints set,
11406     * it won't get properly displayed.
11407     *
11408     * @see elm_entry_icon_set
11409     */
11410    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11411    /**
11412     * Gets the endmost widget of the scrolled entry. This object is owned
11413     * by the scrolled entry and should not be modified.
11414     *
11415     * @param obj The scrolled entry object
11416     * @return the right widget inside the scroller
11417     */
11418    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11419    /**
11420     * Unset the endmost widget of the scrolled entry, unparenting and
11421     * returning it.
11422     *
11423     * @param obj The scrolled entry object
11424     * @return the previously set icon sub-object of this entry, on
11425     * success.
11426     *
11427     * @see elm_entry_icon_set()
11428     */
11429    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11430    /**
11431     * Sets the visibility of the end widget of the scrolled entry, set by
11432     * elm_entry_end_set().
11433     *
11434     * @param obj The scrolled entry object
11435     * @param setting EINA_TRUE if the object should be displayed,
11436     * EINA_FALSE if not.
11437     */
11438    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11439    /**
11440     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11441     * them).
11442     *
11443     * Setting an entry to single-line mode with elm_entry_single_line_set()
11444     * will automatically disable the display of scrollbars when the entry
11445     * moves inside its scroller.
11446     *
11447     * @param obj The scrolled entry object
11448     * @param h The horizontal scrollbar policy to apply
11449     * @param v The vertical scrollbar policy to apply
11450     */
11451    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11452    /**
11453     * This enables/disables bouncing within the entry.
11454     *
11455     * This function sets whether the entry will bounce when scrolling reaches
11456     * the end of the contained entry.
11457     *
11458     * @param obj The scrolled entry object
11459     * @param h The horizontal bounce state
11460     * @param v The vertical bounce state
11461     */
11462    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11463    /**
11464     * Get the bounce mode
11465     *
11466     * @param obj The Entry object
11467     * @param h_bounce Allow bounce horizontally
11468     * @param v_bounce Allow bounce vertically
11469     */
11470    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11471
11472    /* pre-made filters for entries */
11473    /**
11474     * @typedef Elm_Entry_Filter_Limit_Size
11475     *
11476     * Data for the elm_entry_filter_limit_size() entry filter.
11477     */
11478    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11479    /**
11480     * @struct _Elm_Entry_Filter_Limit_Size
11481     *
11482     * Data for the elm_entry_filter_limit_size() entry filter.
11483     */
11484    struct _Elm_Entry_Filter_Limit_Size
11485      {
11486         int max_char_count; /**< The maximum number of characters allowed. */
11487         int max_byte_count; /**< The maximum number of bytes allowed*/
11488      };
11489    /**
11490     * Filter inserted text based on user defined character and byte limits
11491     *
11492     * Add this filter to an entry to limit the characters that it will accept
11493     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11494     * The funtion works on the UTF-8 representation of the string, converting
11495     * it from the set markup, thus not accounting for any format in it.
11496     *
11497     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11498     * it as data when setting the filter. In it, it's possible to set limits
11499     * by character count or bytes (any of them is disabled if 0), and both can
11500     * be set at the same time. In that case, it first checks for characters,
11501     * then bytes.
11502     *
11503     * The function will cut the inserted text in order to allow only the first
11504     * number of characters that are still allowed. The cut is made in
11505     * characters, even when limiting by bytes, in order to always contain
11506     * valid ones and avoid half unicode characters making it in.
11507     *
11508     * This filter, like any others, does not apply when setting the entry text
11509     * directly with elm_object_text_set() (or the deprecated
11510     * elm_entry_entry_set()).
11511     */
11512    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11513    /**
11514     * @typedef Elm_Entry_Filter_Accept_Set
11515     *
11516     * Data for the elm_entry_filter_accept_set() entry filter.
11517     */
11518    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11519    /**
11520     * @struct _Elm_Entry_Filter_Accept_Set
11521     *
11522     * Data for the elm_entry_filter_accept_set() entry filter.
11523     */
11524    struct _Elm_Entry_Filter_Accept_Set
11525      {
11526         const char *accepted; /**< Set of characters accepted in the entry. */
11527         const char *rejected; /**< Set of characters rejected from the entry. */
11528      };
11529    /**
11530     * Filter inserted text based on accepted or rejected sets of characters
11531     *
11532     * Add this filter to an entry to restrict the set of accepted characters
11533     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11534     * This structure contains both accepted and rejected sets, but they are
11535     * mutually exclusive.
11536     *
11537     * The @c accepted set takes preference, so if it is set, the filter will
11538     * only work based on the accepted characters, ignoring anything in the
11539     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11540     *
11541     * In both cases, the function filters by matching utf8 characters to the
11542     * raw markup text, so it can be used to remove formatting tags.
11543     *
11544     * This filter, like any others, does not apply when setting the entry text
11545     * directly with elm_object_text_set() (or the deprecated
11546     * elm_entry_entry_set()).
11547     */
11548    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11549    /**
11550     * Set the input panel layout of the entry
11551     *
11552     * @param obj The entry object
11553     * @param layout layout type
11554     */
11555    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11556    /**
11557     * Get the input panel layout of the entry
11558     *
11559     * @param obj The entry object
11560     * @return layout type
11561     *
11562     * @see elm_entry_input_panel_layout_set
11563     */
11564    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11565    /**
11566     * @}
11567     */
11568
11569    /* composite widgets - these basically put together basic widgets above
11570     * in convenient packages that do more than basic stuff */
11571
11572    /* anchorview */
11573    /**
11574     * @defgroup Anchorview Anchorview
11575     *
11576     * @image html img/widget/anchorview/preview-00.png
11577     * @image latex img/widget/anchorview/preview-00.eps
11578     *
11579     * Anchorview is for displaying text that contains markup with anchors
11580     * like <c>\<a href=1234\>something\</\></c> in it.
11581     *
11582     * Besides being styled differently, the anchorview widget provides the
11583     * necessary functionality so that clicking on these anchors brings up a
11584     * popup with user defined content such as "call", "add to contacts" or
11585     * "open web page". This popup is provided using the @ref Hover widget.
11586     *
11587     * This widget is very similar to @ref Anchorblock, so refer to that
11588     * widget for an example. The only difference Anchorview has is that the
11589     * widget is already provided with scrolling functionality, so if the
11590     * text set to it is too large to fit in the given space, it will scroll,
11591     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11592     * text can be displayed.
11593     *
11594     * This widget emits the following signals:
11595     * @li "anchor,clicked": will be called when an anchor is clicked. The
11596     * @p event_info parameter on the callback will be a pointer of type
11597     * ::Elm_Entry_Anchorview_Info.
11598     *
11599     * See @ref Anchorblock for an example on how to use both of them.
11600     *
11601     * @see Anchorblock
11602     * @see Entry
11603     * @see Hover
11604     *
11605     * @{
11606     */
11607    /**
11608     * @typedef Elm_Entry_Anchorview_Info
11609     *
11610     * The info sent in the callback for "anchor,clicked" signals emitted by
11611     * the Anchorview widget.
11612     */
11613    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11614    /**
11615     * @struct _Elm_Entry_Anchorview_Info
11616     *
11617     * The info sent in the callback for "anchor,clicked" signals emitted by
11618     * the Anchorview widget.
11619     */
11620    struct _Elm_Entry_Anchorview_Info
11621      {
11622         const char     *name; /**< Name of the anchor, as indicated in its href
11623                                    attribute */
11624         int             button; /**< The mouse button used to click on it */
11625         Evas_Object    *hover; /**< The hover object to use for the popup */
11626         struct {
11627              Evas_Coord    x, y, w, h;
11628         } anchor, /**< Geometry selection of text used as anchor */
11629           hover_parent; /**< Geometry of the object used as parent by the
11630                              hover */
11631         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11632                                              for content on the left side of
11633                                              the hover. Before calling the
11634                                              callback, the widget will make the
11635                                              necessary calculations to check
11636                                              which sides are fit to be set with
11637                                              content, based on the position the
11638                                              hover is activated and its distance
11639                                              to the edges of its parent object
11640                                              */
11641         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11642                                               the right side of the hover.
11643                                               See @ref hover_left */
11644         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11645                                             of the hover. See @ref hover_left */
11646         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11647                                                below the hover. See @ref
11648                                                hover_left */
11649      };
11650    /**
11651     * Add a new Anchorview object
11652     *
11653     * @param parent The parent object
11654     * @return The new object or NULL if it cannot be created
11655     */
11656    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11657    /**
11658     * Set the text to show in the anchorview
11659     *
11660     * Sets the text of the anchorview to @p text. This text can include markup
11661     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11662     * text that will be specially styled and react to click events, ended with
11663     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11664     * "anchor,clicked" signal that you can attach a callback to with
11665     * evas_object_smart_callback_add(). The name of the anchor given in the
11666     * event info struct will be the one set in the href attribute, in this
11667     * case, anchorname.
11668     *
11669     * Other markup can be used to style the text in different ways, but it's
11670     * up to the style defined in the theme which tags do what.
11671     * @deprecated use elm_object_text_set() instead.
11672     */
11673    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11674    /**
11675     * Get the markup text set for the anchorview
11676     *
11677     * Retrieves the text set on the anchorview, with markup tags included.
11678     *
11679     * @param obj The anchorview object
11680     * @return The markup text set or @c NULL if nothing was set or an error
11681     * occurred
11682     * @deprecated use elm_object_text_set() instead.
11683     */
11684    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11685    /**
11686     * Set the parent of the hover popup
11687     *
11688     * Sets the parent object to use by the hover created by the anchorview
11689     * when an anchor is clicked. See @ref Hover for more details on this.
11690     * If no parent is set, the same anchorview object will be used.
11691     *
11692     * @param obj The anchorview object
11693     * @param parent The object to use as parent for the hover
11694     */
11695    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11696    /**
11697     * Get the parent of the hover popup
11698     *
11699     * Get the object used as parent for the hover created by the anchorview
11700     * widget. See @ref Hover for more details on this.
11701     *
11702     * @param obj The anchorview object
11703     * @return The object used as parent for the hover, NULL if none is set.
11704     */
11705    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11706    /**
11707     * Set the style that the hover should use
11708     *
11709     * When creating the popup hover, anchorview will request that it's
11710     * themed according to @p style.
11711     *
11712     * @param obj The anchorview object
11713     * @param style The style to use for the underlying hover
11714     *
11715     * @see elm_object_style_set()
11716     */
11717    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11718    /**
11719     * Get the style that the hover should use
11720     *
11721     * Get the style the hover created by anchorview will use.
11722     *
11723     * @param obj The anchorview object
11724     * @return The style to use by the hover. NULL means the default is used.
11725     *
11726     * @see elm_object_style_set()
11727     */
11728    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11729    /**
11730     * Ends the hover popup in the anchorview
11731     *
11732     * When an anchor is clicked, the anchorview widget will create a hover
11733     * object to use as a popup with user provided content. This function
11734     * terminates this popup, returning the anchorview to its normal state.
11735     *
11736     * @param obj The anchorview object
11737     */
11738    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11739    /**
11740     * Set bouncing behaviour when the scrolled content reaches an edge
11741     *
11742     * Tell the internal scroller object whether it should bounce or not
11743     * when it reaches the respective edges for each axis.
11744     *
11745     * @param obj The anchorview object
11746     * @param h_bounce Whether to bounce or not in the horizontal axis
11747     * @param v_bounce Whether to bounce or not in the vertical axis
11748     *
11749     * @see elm_scroller_bounce_set()
11750     */
11751    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11752    /**
11753     * Get the set bouncing behaviour of the internal scroller
11754     *
11755     * Get whether the internal scroller should bounce when the edge of each
11756     * axis is reached scrolling.
11757     *
11758     * @param obj The anchorview object
11759     * @param h_bounce Pointer where to store the bounce state of the horizontal
11760     *                 axis
11761     * @param v_bounce Pointer where to store the bounce state of the vertical
11762     *                 axis
11763     *
11764     * @see elm_scroller_bounce_get()
11765     */
11766    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11767    /**
11768     * Appends a custom item provider to the given anchorview
11769     *
11770     * Appends the given function to the list of items providers. This list is
11771     * called, one function at a time, with the given @p data pointer, the
11772     * anchorview object and, in the @p item parameter, the item name as
11773     * referenced in its href string. Following functions in the list will be
11774     * called in order until one of them returns something different to NULL,
11775     * which should be an Evas_Object which will be used in place of the item
11776     * element.
11777     *
11778     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11779     * href=item/name\>\</item\>
11780     *
11781     * @param obj The anchorview object
11782     * @param func The function to add to the list of providers
11783     * @param data User data that will be passed to the callback function
11784     *
11785     * @see elm_entry_item_provider_append()
11786     */
11787    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);
11788    /**
11789     * Prepend a custom item provider to the given anchorview
11790     *
11791     * Like elm_anchorview_item_provider_append(), but it adds the function
11792     * @p func to the beginning of the list, instead of the end.
11793     *
11794     * @param obj The anchorview object
11795     * @param func The function to add to the list of providers
11796     * @param data User data that will be passed to the callback function
11797     */
11798    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);
11799    /**
11800     * Remove a custom item provider from the list of the given anchorview
11801     *
11802     * Removes the function and data pairing that matches @p func and @p data.
11803     * That is, unless the same function and same user data are given, the
11804     * function will not be removed from the list. This allows us to add the
11805     * same callback several times, with different @p data pointers and be
11806     * able to remove them later without conflicts.
11807     *
11808     * @param obj The anchorview object
11809     * @param func The function to remove from the list
11810     * @param data The data matching the function to remove from the list
11811     */
11812    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);
11813    /**
11814     * @}
11815     */
11816
11817    /* anchorblock */
11818    /**
11819     * @defgroup Anchorblock Anchorblock
11820     *
11821     * @image html img/widget/anchorblock/preview-00.png
11822     * @image latex img/widget/anchorblock/preview-00.eps
11823     *
11824     * Anchorblock is for displaying text that contains markup with anchors
11825     * like <c>\<a href=1234\>something\</\></c> in it.
11826     *
11827     * Besides being styled differently, the anchorblock widget provides the
11828     * necessary functionality so that clicking on these anchors brings up a
11829     * popup with user defined content such as "call", "add to contacts" or
11830     * "open web page". This popup is provided using the @ref Hover widget.
11831     *
11832     * This widget emits the following signals:
11833     * @li "anchor,clicked": will be called when an anchor is clicked. The
11834     * @p event_info parameter on the callback will be a pointer of type
11835     * ::Elm_Entry_Anchorblock_Info.
11836     *
11837     * @see Anchorview
11838     * @see Entry
11839     * @see Hover
11840     *
11841     * Since examples are usually better than plain words, we might as well
11842     * try @ref tutorial_anchorblock_example "one".
11843     */
11844    /**
11845     * @addtogroup Anchorblock
11846     * @{
11847     */
11848    /**
11849     * @typedef Elm_Entry_Anchorblock_Info
11850     *
11851     * The info sent in the callback for "anchor,clicked" signals emitted by
11852     * the Anchorblock widget.
11853     */
11854    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11855    /**
11856     * @struct _Elm_Entry_Anchorblock_Info
11857     *
11858     * The info sent in the callback for "anchor,clicked" signals emitted by
11859     * the Anchorblock widget.
11860     */
11861    struct _Elm_Entry_Anchorblock_Info
11862      {
11863         const char     *name; /**< Name of the anchor, as indicated in its href
11864                                    attribute */
11865         int             button; /**< The mouse button used to click on it */
11866         Evas_Object    *hover; /**< The hover object to use for the popup */
11867         struct {
11868              Evas_Coord    x, y, w, h;
11869         } anchor, /**< Geometry selection of text used as anchor */
11870           hover_parent; /**< Geometry of the object used as parent by the
11871                              hover */
11872         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11873                                              for content on the left side of
11874                                              the hover. Before calling the
11875                                              callback, the widget will make the
11876                                              necessary calculations to check
11877                                              which sides are fit to be set with
11878                                              content, based on the position the
11879                                              hover is activated and its distance
11880                                              to the edges of its parent object
11881                                              */
11882         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11883                                               the right side of the hover.
11884                                               See @ref hover_left */
11885         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11886                                             of the hover. See @ref hover_left */
11887         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11888                                                below the hover. See @ref
11889                                                hover_left */
11890      };
11891    /**
11892     * Add a new Anchorblock object
11893     *
11894     * @param parent The parent object
11895     * @return The new object or NULL if it cannot be created
11896     */
11897    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11898    /**
11899     * Set the text to show in the anchorblock
11900     *
11901     * Sets the text of the anchorblock to @p text. This text can include markup
11902     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11903     * of text that will be specially styled and react to click events, ended
11904     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11905     * "anchor,clicked" signal that you can attach a callback to with
11906     * evas_object_smart_callback_add(). The name of the anchor given in the
11907     * event info struct will be the one set in the href attribute, in this
11908     * case, anchorname.
11909     *
11910     * Other markup can be used to style the text in different ways, but it's
11911     * up to the style defined in the theme which tags do what.
11912     * @deprecated use elm_object_text_set() instead.
11913     */
11914    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11915    /**
11916     * Get the markup text set for the anchorblock
11917     *
11918     * Retrieves the text set on the anchorblock, with markup tags included.
11919     *
11920     * @param obj The anchorblock object
11921     * @return The markup text set or @c NULL if nothing was set or an error
11922     * occurred
11923     * @deprecated use elm_object_text_set() instead.
11924     */
11925    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11926    /**
11927     * Set the parent of the hover popup
11928     *
11929     * Sets the parent object to use by the hover created by the anchorblock
11930     * when an anchor is clicked. See @ref Hover for more details on this.
11931     *
11932     * @param obj The anchorblock object
11933     * @param parent The object to use as parent for the hover
11934     */
11935    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11936    /**
11937     * Get the parent of the hover popup
11938     *
11939     * Get the object used as parent for the hover created by the anchorblock
11940     * widget. See @ref Hover for more details on this.
11941     * If no parent is set, the same anchorblock object will be used.
11942     *
11943     * @param obj The anchorblock object
11944     * @return The object used as parent for the hover, NULL if none is set.
11945     */
11946    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11947    /**
11948     * Set the style that the hover should use
11949     *
11950     * When creating the popup hover, anchorblock will request that it's
11951     * themed according to @p style.
11952     *
11953     * @param obj The anchorblock object
11954     * @param style The style to use for the underlying hover
11955     *
11956     * @see elm_object_style_set()
11957     */
11958    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11959    /**
11960     * Get the style that the hover should use
11961     *
11962     * Get the style the hover created by anchorblock will use.
11963     *
11964     * @param obj The anchorblock object
11965     * @return The style to use by the hover. NULL means the default is used.
11966     *
11967     * @see elm_object_style_set()
11968     */
11969    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11970    /**
11971     * Ends the hover popup in the anchorblock
11972     *
11973     * When an anchor is clicked, the anchorblock widget will create a hover
11974     * object to use as a popup with user provided content. This function
11975     * terminates this popup, returning the anchorblock to its normal state.
11976     *
11977     * @param obj The anchorblock object
11978     */
11979    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11980    /**
11981     * Appends a custom item provider to the given anchorblock
11982     *
11983     * Appends the given function to the list of items providers. This list is
11984     * called, one function at a time, with the given @p data pointer, the
11985     * anchorblock object and, in the @p item parameter, the item name as
11986     * referenced in its href string. Following functions in the list will be
11987     * called in order until one of them returns something different to NULL,
11988     * which should be an Evas_Object which will be used in place of the item
11989     * element.
11990     *
11991     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11992     * href=item/name\>\</item\>
11993     *
11994     * @param obj The anchorblock object
11995     * @param func The function to add to the list of providers
11996     * @param data User data that will be passed to the callback function
11997     *
11998     * @see elm_entry_item_provider_append()
11999     */
12000    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);
12001    /**
12002     * Prepend a custom item provider to the given anchorblock
12003     *
12004     * Like elm_anchorblock_item_provider_append(), but it adds the function
12005     * @p func to the beginning of the list, instead of the end.
12006     *
12007     * @param obj The anchorblock object
12008     * @param func The function to add to the list of providers
12009     * @param data User data that will be passed to the callback function
12010     */
12011    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);
12012    /**
12013     * Remove a custom item provider from the list of the given anchorblock
12014     *
12015     * Removes the function and data pairing that matches @p func and @p data.
12016     * That is, unless the same function and same user data are given, the
12017     * function will not be removed from the list. This allows us to add the
12018     * same callback several times, with different @p data pointers and be
12019     * able to remove them later without conflicts.
12020     *
12021     * @param obj The anchorblock object
12022     * @param func The function to remove from the list
12023     * @param data The data matching the function to remove from the list
12024     */
12025    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);
12026    /**
12027     * @}
12028     */
12029
12030    /**
12031     * @defgroup Bubble Bubble
12032     *
12033     * @image html img/widget/bubble/preview-00.png
12034     * @image latex img/widget/bubble/preview-00.eps
12035     * @image html img/widget/bubble/preview-01.png
12036     * @image latex img/widget/bubble/preview-01.eps
12037     * @image html img/widget/bubble/preview-02.png
12038     * @image latex img/widget/bubble/preview-02.eps
12039     *
12040     * @brief The Bubble is a widget to show text similarly to how speech is
12041     * represented in comics.
12042     *
12043     * The bubble widget contains 5 important visual elements:
12044     * @li The frame is a rectangle with rounded rectangles and an "arrow".
12045     * @li The @p icon is an image to which the frame's arrow points to.
12046     * @li The @p label is a text which appears to the right of the icon if the
12047     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12048     * otherwise.
12049     * @li The @p info is a text which appears to the right of the label. Info's
12050     * font is of a ligther color than label.
12051     * @li The @p content is an evas object that is shown inside the frame.
12052     *
12053     * The position of the arrow, icon, label and info depends on which corner is
12054     * selected. The four available corners are:
12055     * @li "top_left" - Default
12056     * @li "top_right"
12057     * @li "bottom_left"
12058     * @li "bottom_right"
12059     *
12060     * Signals that you can add callbacks for are:
12061     * @li "clicked" - This is called when a user has clicked the bubble.
12062     *
12063     * For an example of using a buble see @ref bubble_01_example_page "this".
12064     *
12065     * @{
12066     */
12067    /**
12068     * Add a new bubble to the parent
12069     *
12070     * @param parent The parent object
12071     * @return The new object or NULL if it cannot be created
12072     *
12073     * This function adds a text bubble to the given parent evas object.
12074     */
12075    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12076    /**
12077     * Set the label of the bubble
12078     *
12079     * @param obj The bubble object
12080     * @param label The string to set in the label
12081     *
12082     * This function sets the title of the bubble. Where this appears depends on
12083     * the selected corner.
12084     * @deprecated use elm_object_text_set() instead.
12085     */
12086    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12087    /**
12088     * Get the label of the bubble
12089     *
12090     * @param obj The bubble object
12091     * @return The string of set in the label
12092     *
12093     * This function gets the title of the bubble.
12094     * @deprecated use elm_object_text_get() instead.
12095     */
12096    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12097    /**
12098     * Set the info of the bubble
12099     *
12100     * @param obj The bubble object
12101     * @param info The given info about the bubble
12102     *
12103     * This function sets the info of the bubble. Where this appears depends on
12104     * the selected corner.
12105     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12106     */
12107    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12108    /**
12109     * Get the info of the bubble
12110     *
12111     * @param obj The bubble object
12112     *
12113     * @return The "info" string of the bubble
12114     *
12115     * This function gets the info text.
12116     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12117     */
12118    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12119    /**
12120     * Set the content to be shown in the bubble
12121     *
12122     * Once the content object is set, a previously set one will be deleted.
12123     * If you want to keep the old content object, use the
12124     * elm_bubble_content_unset() function.
12125     *
12126     * @param obj The bubble object
12127     * @param content The given content of the bubble
12128     *
12129     * This function sets the content shown on the middle of the bubble.
12130     */
12131    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12132    /**
12133     * Get the content shown in the bubble
12134     *
12135     * Return the content object which is set for this widget.
12136     *
12137     * @param obj The bubble object
12138     * @return The content that is being used
12139     */
12140    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12141    /**
12142     * Unset the content shown in the bubble
12143     *
12144     * Unparent and return the content object which was set for this widget.
12145     *
12146     * @param obj The bubble object
12147     * @return The content that was being used
12148     */
12149    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12150    /**
12151     * Set the icon of the bubble
12152     *
12153     * Once the icon object is set, a previously set one will be deleted.
12154     * If you want to keep the old content object, use the
12155     * elm_icon_content_unset() function.
12156     *
12157     * @param obj The bubble object
12158     * @param icon The given icon for the bubble
12159     */
12160    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12161    /**
12162     * Get the icon of the bubble
12163     *
12164     * @param obj The bubble object
12165     * @return The icon for the bubble
12166     *
12167     * This function gets the icon shown on the top left of bubble.
12168     */
12169    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12170    /**
12171     * Unset the icon of the bubble
12172     *
12173     * Unparent and return the icon object which was set for this widget.
12174     *
12175     * @param obj The bubble object
12176     * @return The icon that was being used
12177     */
12178    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12179    /**
12180     * Set the corner of the bubble
12181     *
12182     * @param obj The bubble object.
12183     * @param corner The given corner for the bubble.
12184     *
12185     * This function sets the corner of the bubble. The corner will be used to
12186     * determine where the arrow in the frame points to and where label, icon and
12187     * info arre shown.
12188     *
12189     * Possible values for corner are:
12190     * @li "top_left" - Default
12191     * @li "top_right"
12192     * @li "bottom_left"
12193     * @li "bottom_right"
12194     */
12195    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12196    /**
12197     * Get the corner of the bubble
12198     *
12199     * @param obj The bubble object.
12200     * @return The given corner for the bubble.
12201     *
12202     * This function gets the selected corner of the bubble.
12203     */
12204    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12205    /**
12206     * @}
12207     */
12208
12209    /**
12210     * @defgroup Photo Photo
12211     *
12212     * For displaying the photo of a person (contact). Simple yet
12213     * with a very specific purpose.
12214     *
12215     * Signals that you can add callbacks for are:
12216     *
12217     * "clicked" - This is called when a user has clicked the photo
12218     * "drag,start" - Someone started dragging the image out of the object
12219     * "drag,end" - Dragged item was dropped (somewhere)
12220     *
12221     * @{
12222     */
12223
12224    /**
12225     * Add a new photo to the parent
12226     *
12227     * @param parent The parent object
12228     * @return The new object or NULL if it cannot be created
12229     *
12230     * @ingroup Photo
12231     */
12232    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12233
12234    /**
12235     * Set the file that will be used as photo
12236     *
12237     * @param obj The photo object
12238     * @param file The path to file that will be used as photo
12239     *
12240     * @return (1 = success, 0 = error)
12241     *
12242     * @ingroup Photo
12243     */
12244    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12245
12246     /**
12247     * Set the file that will be used as thumbnail in the photo.
12248     *
12249     * @param obj The photo object.
12250     * @param file The path to file that will be used as thumb.
12251     * @param group The key used in case of an EET file.
12252     *
12253     * @ingroup Photo
12254     */
12255    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12256
12257    /**
12258     * Set the size that will be used on the photo
12259     *
12260     * @param obj The photo object
12261     * @param size The size that the photo will be
12262     *
12263     * @ingroup Photo
12264     */
12265    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12266
12267    /**
12268     * Set if the photo should be completely visible or not.
12269     *
12270     * @param obj The photo object
12271     * @param fill if true the photo will be completely visible
12272     *
12273     * @ingroup Photo
12274     */
12275    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12276
12277    /**
12278     * Set editability of the photo.
12279     *
12280     * An editable photo can be dragged to or from, and can be cut or
12281     * pasted too.  Note that pasting an image or dropping an item on
12282     * the image will delete the existing content.
12283     *
12284     * @param obj The photo object.
12285     * @param set To set of clear editablity.
12286     */
12287    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12288
12289    /**
12290     * @}
12291     */
12292
12293    /* gesture layer */
12294    /**
12295     * @defgroup Elm_Gesture_Layer Gesture Layer
12296     * Gesture Layer Usage:
12297     *
12298     * Use Gesture Layer to detect gestures.
12299     * The advantage is that you don't have to implement
12300     * gesture detection, just set callbacks of gesture state.
12301     * By using gesture layer we make standard interface.
12302     *
12303     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12304     * with a parent object parameter.
12305     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12306     * call. Usually with same object as target (2nd parameter).
12307     *
12308     * Now you need to tell gesture layer what gestures you follow.
12309     * This is done with @ref elm_gesture_layer_cb_set call.
12310     * By setting the callback you actually saying to gesture layer:
12311     * I would like to know when the gesture @ref Elm_Gesture_Types
12312     * switches to state @ref Elm_Gesture_State.
12313     *
12314     * Next, you need to implement the actual action that follows the input
12315     * in your callback.
12316     *
12317     * Note that if you like to stop being reported about a gesture, just set
12318     * all callbacks referring this gesture to NULL.
12319     * (again with @ref elm_gesture_layer_cb_set)
12320     *
12321     * The information reported by gesture layer to your callback is depending
12322     * on @ref Elm_Gesture_Types:
12323     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12324     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12325     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12326     *
12327     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12328     * @ref ELM_GESTURE_MOMENTUM.
12329     *
12330     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12331     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12332     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12333     * Note that we consider a flick as a line-gesture that should be completed
12334     * in flick-time-limit as defined in @ref Config.
12335     *
12336     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12337     *
12338     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12339     *
12340     *
12341     * Gesture Layer Tweaks:
12342     *
12343     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12344     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12345     *
12346     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12347     * so gesture starts when user touches (a *DOWN event) touch-surface
12348     * and ends when no fingers touches surface (a *UP event).
12349     */
12350
12351    /**
12352     * @enum _Elm_Gesture_Types
12353     * Enum of supported gesture types.
12354     * @ingroup Elm_Gesture_Layer
12355     */
12356    enum _Elm_Gesture_Types
12357      {
12358         ELM_GESTURE_FIRST = 0,
12359
12360         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12361         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12362         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12363         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12364
12365         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12366
12367         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12368         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12369
12370         ELM_GESTURE_ZOOM, /**< Zoom */
12371         ELM_GESTURE_ROTATE, /**< Rotate */
12372
12373         ELM_GESTURE_LAST
12374      };
12375
12376    /**
12377     * @typedef Elm_Gesture_Types
12378     * gesture types enum
12379     * @ingroup Elm_Gesture_Layer
12380     */
12381    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12382
12383    /**
12384     * @enum _Elm_Gesture_State
12385     * Enum of gesture states.
12386     * @ingroup Elm_Gesture_Layer
12387     */
12388    enum _Elm_Gesture_State
12389      {
12390         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12391         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12392         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12393         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12394         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12395      };
12396
12397    /**
12398     * @typedef Elm_Gesture_State
12399     * gesture states enum
12400     * @ingroup Elm_Gesture_Layer
12401     */
12402    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12403
12404    /**
12405     * @struct _Elm_Gesture_Taps_Info
12406     * Struct holds taps info for user
12407     * @ingroup Elm_Gesture_Layer
12408     */
12409    struct _Elm_Gesture_Taps_Info
12410      {
12411         Evas_Coord x, y;         /**< Holds center point between fingers */
12412         unsigned int n;          /**< Number of fingers tapped           */
12413         unsigned int timestamp;  /**< event timestamp       */
12414      };
12415
12416    /**
12417     * @typedef Elm_Gesture_Taps_Info
12418     * holds taps info for user
12419     * @ingroup Elm_Gesture_Layer
12420     */
12421    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12422
12423    /**
12424     * @struct _Elm_Gesture_Momentum_Info
12425     * Struct holds momentum info for user
12426     * x1 and y1 are not necessarily in sync
12427     * x1 holds x value of x direction starting point
12428     * and same holds for y1.
12429     * This is noticeable when doing V-shape movement
12430     * @ingroup Elm_Gesture_Layer
12431     */
12432    struct _Elm_Gesture_Momentum_Info
12433      {  /* Report line ends, timestamps, and momentum computed        */
12434         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12435         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12436         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12437         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12438
12439         unsigned int tx; /**< Timestamp of start of final x-swipe */
12440         unsigned int ty; /**< Timestamp of start of final y-swipe */
12441
12442         Evas_Coord mx; /**< Momentum on X */
12443         Evas_Coord my; /**< Momentum on Y */
12444      };
12445
12446    /**
12447     * @typedef Elm_Gesture_Momentum_Info
12448     * holds momentum info for user
12449     * @ingroup Elm_Gesture_Layer
12450     */
12451     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12452
12453    /**
12454     * @struct _Elm_Gesture_Line_Info
12455     * Struct holds line info for user
12456     * @ingroup Elm_Gesture_Layer
12457     */
12458    struct _Elm_Gesture_Line_Info
12459      {  /* Report line ends, timestamps, and momentum computed      */
12460         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12461         unsigned int n;            /**< Number of fingers (lines)   */
12462         /* FIXME should be radians, bot degrees */
12463         double angle;              /**< Angle (direction) of lines  */
12464      };
12465
12466    /**
12467     * @typedef Elm_Gesture_Line_Info
12468     * Holds line info for user
12469     * @ingroup Elm_Gesture_Layer
12470     */
12471     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12472
12473    /**
12474     * @struct _Elm_Gesture_Zoom_Info
12475     * Struct holds zoom info for user
12476     * @ingroup Elm_Gesture_Layer
12477     */
12478    struct _Elm_Gesture_Zoom_Info
12479      {
12480         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12481         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12482         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12483         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12484      };
12485
12486    /**
12487     * @typedef Elm_Gesture_Zoom_Info
12488     * Holds zoom info for user
12489     * @ingroup Elm_Gesture_Layer
12490     */
12491    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12492
12493    /**
12494     * @struct _Elm_Gesture_Rotate_Info
12495     * Struct holds rotation info for user
12496     * @ingroup Elm_Gesture_Layer
12497     */
12498    struct _Elm_Gesture_Rotate_Info
12499      {
12500         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12501         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12502         double base_angle; /**< Holds start-angle */
12503         double angle;      /**< Rotation value: 0.0 means no rotation         */
12504         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12505      };
12506
12507    /**
12508     * @typedef Elm_Gesture_Rotate_Info
12509     * Holds rotation info for user
12510     * @ingroup Elm_Gesture_Layer
12511     */
12512    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12513
12514    /**
12515     * @typedef Elm_Gesture_Event_Cb
12516     * User callback used to stream gesture info from gesture layer
12517     * @param data user data
12518     * @param event_info gesture report info
12519     * Returns a flag field to be applied on the causing event.
12520     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12521     * upon the event, in an irreversible way.
12522     *
12523     * @ingroup Elm_Gesture_Layer
12524     */
12525    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12526
12527    /**
12528     * Use function to set callbacks to be notified about
12529     * change of state of gesture.
12530     * When a user registers a callback with this function
12531     * this means this gesture has to be tested.
12532     *
12533     * When ALL callbacks for a gesture are set to NULL
12534     * it means user isn't interested in gesture-state
12535     * and it will not be tested.
12536     *
12537     * @param obj Pointer to gesture-layer.
12538     * @param idx The gesture you would like to track its state.
12539     * @param cb callback function pointer.
12540     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12541     * @param data user info to be sent to callback (usually, Smart Data)
12542     *
12543     * @ingroup Elm_Gesture_Layer
12544     */
12545    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);
12546
12547    /**
12548     * Call this function to get repeat-events settings.
12549     *
12550     * @param obj Pointer to gesture-layer.
12551     *
12552     * @return repeat events settings.
12553     * @see elm_gesture_layer_hold_events_set()
12554     * @ingroup Elm_Gesture_Layer
12555     */
12556    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12557
12558    /**
12559     * This function called in order to make gesture-layer repeat events.
12560     * Set this of you like to get the raw events only if gestures were not detected.
12561     * Clear this if you like gesture layer to fwd events as testing gestures.
12562     *
12563     * @param obj Pointer to gesture-layer.
12564     * @param r Repeat: TRUE/FALSE
12565     *
12566     * @ingroup Elm_Gesture_Layer
12567     */
12568    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12569
12570    /**
12571     * This function sets step-value for zoom action.
12572     * Set step to any positive value.
12573     * Cancel step setting by setting to 0.0
12574     *
12575     * @param obj Pointer to gesture-layer.
12576     * @param s new zoom step value.
12577     *
12578     * @ingroup Elm_Gesture_Layer
12579     */
12580    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12581
12582    /**
12583     * This function sets step-value for rotate action.
12584     * Set step to any positive value.
12585     * Cancel step setting by setting to 0.0
12586     *
12587     * @param obj Pointer to gesture-layer.
12588     * @param s new roatate step value.
12589     *
12590     * @ingroup Elm_Gesture_Layer
12591     */
12592    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12593
12594    /**
12595     * This function called to attach gesture-layer to an Evas_Object.
12596     * @param obj Pointer to gesture-layer.
12597     * @param t Pointer to underlying object (AKA Target)
12598     *
12599     * @return TRUE, FALSE on success, failure.
12600     *
12601     * @ingroup Elm_Gesture_Layer
12602     */
12603    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12604
12605    /**
12606     * Call this function to construct a new gesture-layer object.
12607     * This does not activate the gesture layer. You have to
12608     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12609     *
12610     * @param parent the parent object.
12611     *
12612     * @return Pointer to new gesture-layer object.
12613     *
12614     * @ingroup Elm_Gesture_Layer
12615     */
12616    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12617
12618    /**
12619     * @defgroup Thumb Thumb
12620     *
12621     * @image html img/widget/thumb/preview-00.png
12622     * @image latex img/widget/thumb/preview-00.eps
12623     *
12624     * A thumb object is used for displaying the thumbnail of an image or video.
12625     * You must have compiled Elementary with Ethumb_Client support and the DBus
12626     * service must be present and auto-activated in order to have thumbnails to
12627     * be generated.
12628     *
12629     * Once the thumbnail object becomes visible, it will check if there is a
12630     * previously generated thumbnail image for the file set on it. If not, it
12631     * will start generating this thumbnail.
12632     *
12633     * Different config settings will cause different thumbnails to be generated
12634     * even on the same file.
12635     *
12636     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12637     * Ethumb documentation to change this path, and to see other configuration
12638     * options.
12639     *
12640     * Signals that you can add callbacks for are:
12641     *
12642     * - "clicked" - This is called when a user has clicked the thumb without dragging
12643     *             around.
12644     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12645     * - "press" - This is called when a user has pressed down the thumb.
12646     * - "generate,start" - The thumbnail generation started.
12647     * - "generate,stop" - The generation process stopped.
12648     * - "generate,error" - The generation failed.
12649     * - "load,error" - The thumbnail image loading failed.
12650     *
12651     * available styles:
12652     * - default
12653     * - noframe
12654     *
12655     * An example of use of thumbnail:
12656     *
12657     * - @ref thumb_example_01
12658     */
12659
12660    /**
12661     * @addtogroup Thumb
12662     * @{
12663     */
12664
12665    /**
12666     * @enum _Elm_Thumb_Animation_Setting
12667     * @typedef Elm_Thumb_Animation_Setting
12668     *
12669     * Used to set if a video thumbnail is animating or not.
12670     *
12671     * @ingroup Thumb
12672     */
12673    typedef enum _Elm_Thumb_Animation_Setting
12674      {
12675         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12676         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12677         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12678         ELM_THUMB_ANIMATION_LAST
12679      } Elm_Thumb_Animation_Setting;
12680
12681    /**
12682     * Add a new thumb object to the parent.
12683     *
12684     * @param parent The parent object.
12685     * @return The new object or NULL if it cannot be created.
12686     *
12687     * @see elm_thumb_file_set()
12688     * @see elm_thumb_ethumb_client_get()
12689     *
12690     * @ingroup Thumb
12691     */
12692    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12693    /**
12694     * Reload thumbnail if it was generated before.
12695     *
12696     * @param obj The thumb object to reload
12697     *
12698     * This is useful if the ethumb client configuration changed, like its
12699     * size, aspect or any other property one set in the handle returned
12700     * by elm_thumb_ethumb_client_get().
12701     *
12702     * If the options didn't change, the thumbnail won't be generated again, but
12703     * the old one will still be used.
12704     *
12705     * @see elm_thumb_file_set()
12706     *
12707     * @ingroup Thumb
12708     */
12709    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12710    /**
12711     * Set the file that will be used as thumbnail.
12712     *
12713     * @param obj The thumb object.
12714     * @param file The path to file that will be used as thumb.
12715     * @param key The key used in case of an EET file.
12716     *
12717     * The file can be an image or a video (in that case, acceptable extensions are:
12718     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12719     * function elm_thumb_animate().
12720     *
12721     * @see elm_thumb_file_get()
12722     * @see elm_thumb_reload()
12723     * @see elm_thumb_animate()
12724     *
12725     * @ingroup Thumb
12726     */
12727    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12728    /**
12729     * Get the image or video path and key used to generate the thumbnail.
12730     *
12731     * @param obj The thumb object.
12732     * @param file Pointer to filename.
12733     * @param key Pointer to key.
12734     *
12735     * @see elm_thumb_file_set()
12736     * @see elm_thumb_path_get()
12737     *
12738     * @ingroup Thumb
12739     */
12740    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12741    /**
12742     * Get the path and key to the image or video generated by ethumb.
12743     *
12744     * One just need to make sure that the thumbnail was generated before getting
12745     * its path; otherwise, the path will be NULL. One way to do that is by asking
12746     * for the path when/after the "generate,stop" smart callback is called.
12747     *
12748     * @param obj The thumb object.
12749     * @param file Pointer to thumb path.
12750     * @param key Pointer to thumb key.
12751     *
12752     * @see elm_thumb_file_get()
12753     *
12754     * @ingroup Thumb
12755     */
12756    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12757    /**
12758     * Set the animation state for the thumb object. If its content is an animated
12759     * video, you may start/stop the animation or tell it to play continuously and
12760     * looping.
12761     *
12762     * @param obj The thumb object.
12763     * @param setting The animation setting.
12764     *
12765     * @see elm_thumb_file_set()
12766     *
12767     * @ingroup Thumb
12768     */
12769    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12770    /**
12771     * Get the animation state for the thumb object.
12772     *
12773     * @param obj The thumb object.
12774     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12775     * on errors.
12776     *
12777     * @see elm_thumb_animate_set()
12778     *
12779     * @ingroup Thumb
12780     */
12781    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12782    /**
12783     * Get the ethumb_client handle so custom configuration can be made.
12784     *
12785     * @return Ethumb_Client instance or NULL.
12786     *
12787     * This must be called before the objects are created to be sure no object is
12788     * visible and no generation started.
12789     *
12790     * Example of usage:
12791     *
12792     * @code
12793     * #include <Elementary.h>
12794     * #ifndef ELM_LIB_QUICKLAUNCH
12795     * EAPI_MAIN int
12796     * elm_main(int argc, char **argv)
12797     * {
12798     *    Ethumb_Client *client;
12799     *
12800     *    elm_need_ethumb();
12801     *
12802     *    // ... your code
12803     *
12804     *    client = elm_thumb_ethumb_client_get();
12805     *    if (!client)
12806     *      {
12807     *         ERR("could not get ethumb_client");
12808     *         return 1;
12809     *      }
12810     *    ethumb_client_size_set(client, 100, 100);
12811     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12812     *    // ... your code
12813     *
12814     *    // Create elm_thumb objects here
12815     *
12816     *    elm_run();
12817     *    elm_shutdown();
12818     *    return 0;
12819     * }
12820     * #endif
12821     * ELM_MAIN()
12822     * @endcode
12823     *
12824     * @note There's only one client handle for Ethumb, so once a configuration
12825     * change is done to it, any other request for thumbnails (for any thumbnail
12826     * object) will use that configuration. Thus, this configuration is global.
12827     *
12828     * @ingroup Thumb
12829     */
12830    EAPI void                        *elm_thumb_ethumb_client_get(void);
12831    /**
12832     * Get the ethumb_client connection state.
12833     *
12834     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12835     * otherwise.
12836     */
12837    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12838    /**
12839     * Make the thumbnail 'editable'.
12840     *
12841     * @param obj Thumb object.
12842     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12843     *
12844     * This means the thumbnail is a valid drag target for drag and drop, and can be
12845     * cut or pasted too.
12846     *
12847     * @see elm_thumb_editable_get()
12848     *
12849     * @ingroup Thumb
12850     */
12851    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12852    /**
12853     * Make the thumbnail 'editable'.
12854     *
12855     * @param obj Thumb object.
12856     * @return Editability.
12857     *
12858     * This means the thumbnail is a valid drag target for drag and drop, and can be
12859     * cut or pasted too.
12860     *
12861     * @see elm_thumb_editable_set()
12862     *
12863     * @ingroup Thumb
12864     */
12865    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12866
12867    /**
12868     * @}
12869     */
12870
12871    /**
12872     * @defgroup Web Web
12873     *
12874     * @image html img/widget/web/preview-00.png
12875     * @image latex img/widget/web/preview-00.eps
12876     *
12877     * A web object is used for displaying web pages (HTML/CSS/JS)
12878     * using WebKit-EFL. You must have compiled Elementary with
12879     * ewebkit support.
12880     *
12881     * Signals that you can add callbacks for are:
12882     * @li "download,request": A file download has been requested. Event info is
12883     * a pointer to a Elm_Web_Download
12884     * @li "editorclient,contents,changed": Editor client's contents changed
12885     * @li "editorclient,selection,changed": Editor client's selection changed
12886     * @li "frame,created": A new frame was created. Event info is an
12887     * Evas_Object which can be handled with WebKit's ewk_frame API
12888     * @li "icon,received": An icon was received by the main frame
12889     * @li "inputmethod,changed": Input method changed. Event info is an
12890     * Eina_Bool indicating whether it's enabled or not
12891     * @li "js,windowobject,clear": JS window object has been cleared
12892     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12893     * is a char *link[2], where the first string contains the URL the link
12894     * points to, and the second one the title of the link
12895     * @li "link,hover,out": Mouse cursor left the link
12896     * @li "load,document,finished": Loading of a document finished. Event info
12897     * is the frame that finished loading
12898     * @li "load,error": Load failed. Event info is a pointer to
12899     * Elm_Web_Frame_Load_Error
12900     * @li "load,finished": Load finished. Event info is NULL on success, on
12901     * error it's a pointer to Elm_Web_Frame_Load_Error
12902     * @li "load,newwindow,show": A new window was created and is ready to be
12903     * shown
12904     * @li "load,progress": Overall load progress. Event info is a pointer to
12905     * a double containing a value between 0.0 and 1.0
12906     * @li "load,provisional": Started provisional load
12907     * @li "load,started": Loading of a document started
12908     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12909     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12910     * the menubar is visible, or EINA_FALSE in case it's not
12911     * @li "menubar,visible,set": Informs menubar visibility. Event info is
12912     * an Eina_Bool indicating the visibility
12913     * @li "popup,created": A dropdown widget was activated, requesting its
12914     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12915     * @li "popup,willdelete": The web object is ready to destroy the popup
12916     * object created. Event info is a pointer to Elm_Web_Menu
12917     * @li "ready": Page is fully loaded
12918     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12919     * info is a pointer to Eina_Bool where the visibility state should be set
12920     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12921     * is an Eina_Bool with the visibility state set
12922     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12923     * a string with the new text
12924     * @li "statusbar,visible,get": Queries visibility of the status bar.
12925     * Event info is a pointer to Eina_Bool where the visibility state should be
12926     * set.
12927     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12928     * an Eina_Bool with the visibility value
12929     * @li "title,changed": Title of the main frame changed. Event info is a
12930     * string with the new title
12931     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
12932     * is a pointer to Eina_Bool where the visibility state should be set
12933     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
12934     * info is an Eina_Bool with the visibility state
12935     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
12936     * a string with the text to show
12937     * @li "uri,changed": URI of the main frame changed. Event info is a string
12938     * with the new URI
12939     * @li "view,resized": The web object internal's view changed sized
12940     * @li "windows,close,request": A JavaScript request to close the current
12941     * window was requested
12942     * @li "zoom,animated,end": Animated zoom finished
12943     *
12944     * available styles:
12945     * - default
12946     *
12947     * An example of use of web:
12948     *
12949     * - @ref web_example_01 TBD
12950     */
12951
12952    /**
12953     * @addtogroup Web
12954     * @{
12955     */
12956
12957    /**
12958     * Structure used to report load errors.
12959     *
12960     * Load errors are reported as signal by elm_web. All the strings are
12961     * temporary references and should @b not be used after the signal
12962     * callback returns. If it's required, make copies with strdup() or
12963     * eina_stringshare_add() (they are not even guaranteed to be
12964     * stringshared, so must use eina_stringshare_add() and not
12965     * eina_stringshare_ref()).
12966     */
12967    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
12968    /**
12969     * Structure used to report load errors.
12970     *
12971     * Load errors are reported as signal by elm_web. All the strings are
12972     * temporary references and should @b not be used after the signal
12973     * callback returns. If it's required, make copies with strdup() or
12974     * eina_stringshare_add() (they are not even guaranteed to be
12975     * stringshared, so must use eina_stringshare_add() and not
12976     * eina_stringshare_ref()).
12977     */
12978    struct _Elm_Web_Frame_Load_Error
12979      {
12980         int code; /**< Numeric error code */
12981         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
12982         const char *domain; /**< Error domain name */
12983         const char *description; /**< Error description (already localized) */
12984         const char *failing_url; /**< The URL that failed to load */
12985         Evas_Object *frame; /**< Frame object that produced the error */
12986      };
12987
12988    /**
12989     * The possibles types that the items in a menu can be
12990     */
12991    typedef enum _Elm_Web_Menu_Item_Type
12992      {
12993         ELM_WEB_MENU_SEPARATOR,
12994         ELM_WEB_MENU_GROUP,
12995         ELM_WEB_MENU_OPTION
12996      } Elm_Web_Menu_Item_Type;
12997
12998    /**
12999     * Structure describing the items in a menu
13000     */
13001    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13002    /**
13003     * Structure describing the items in a menu
13004     */
13005    struct _Elm_Web_Menu_Item
13006      {
13007         const char *text; /**< The text for the item */
13008         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13009      };
13010
13011    /**
13012     * Structure describing the menu of a popup
13013     *
13014     * This structure will be passed as the @c event_info for the "popup,create"
13015     * signal, which is emitted when a dropdown menu is opened. Users wanting
13016     * to handle these popups by themselves should listen to this signal and
13017     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13018     * property as @c EINA_FALSE means that the user will not handle the popup
13019     * and the default implementation will be used.
13020     *
13021     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13022     * will be emitted to notify the user that it can destroy any objects and
13023     * free all data related to it.
13024     *
13025     * @see elm_web_popup_selected_set()
13026     * @see elm_web_popup_destroy()
13027     */
13028    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13029    /**
13030     * Structure describing the menu of a popup
13031     *
13032     * This structure will be passed as the @c event_info for the "popup,create"
13033     * signal, which is emitted when a dropdown menu is opened. Users wanting
13034     * to handle these popups by themselves should listen to this signal and
13035     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13036     * property as @c EINA_FALSE means that the user will not handle the popup
13037     * and the default implementation will be used.
13038     *
13039     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13040     * will be emitted to notify the user that it can destroy any objects and
13041     * free all data related to it.
13042     *
13043     * @see elm_web_popup_selected_set()
13044     * @see elm_web_popup_destroy()
13045     */
13046    struct _Elm_Web_Menu
13047      {
13048         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13049         int x; /**< The X position of the popup, relative to the elm_web object */
13050         int y; /**< The Y position of the popup, relative to the elm_web object */
13051         int width; /**< Width of the popup menu */
13052         int height; /**< Height of the popup menu */
13053
13054         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. */
13055      };
13056
13057    typedef struct _Elm_Web_Download Elm_Web_Download;
13058    struct _Elm_Web_Download
13059      {
13060         const char *url;
13061      };
13062
13063    /**
13064     * Types of zoom available.
13065     */
13066    typedef enum _Elm_Web_Zoom_Mode
13067      {
13068         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13069         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13070         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13071         ELM_WEB_ZOOM_MODE_LAST
13072      } Elm_Web_Zoom_Mode;
13073    /**
13074     * Opaque handler containing the features (such as statusbar, menubar, etc)
13075     * that are to be set on a newly requested window.
13076     */
13077    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13078    /**
13079     * Callback type for the create_window hook.
13080     *
13081     * The function parameters are:
13082     * @li @p data User data pointer set when setting the hook function
13083     * @li @p obj The elm_web object requesting the new window
13084     * @li @p js Set to @c EINA_TRUE if the request was originated from
13085     * JavaScript. @c EINA_FALSE otherwise.
13086     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13087     * the features requested for the new window.
13088     *
13089     * The returned value of the function should be the @c elm_web widget where
13090     * the request will be loaded. That is, if a new window or tab is created,
13091     * the elm_web widget in it should be returned, and @b NOT the window
13092     * object.
13093     * Returning @c NULL should cancel the request.
13094     *
13095     * @see elm_web_window_create_hook_set()
13096     */
13097    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13098    /**
13099     * Callback type for the JS alert hook.
13100     *
13101     * The function parameters are:
13102     * @li @p data User data pointer set when setting the hook function
13103     * @li @p obj The elm_web object requesting the new window
13104     * @li @p message The message to show in the alert dialog
13105     *
13106     * The function should return the object representing the alert dialog.
13107     * Elm_Web will run a second main loop to handle the dialog and normal
13108     * flow of the application will be restored when the object is deleted, so
13109     * the user should handle the popup properly in order to delete the object
13110     * when the action is finished.
13111     * If the function returns @c NULL the popup will be ignored.
13112     *
13113     * @see elm_web_dialog_alert_hook_set()
13114     */
13115    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13116    /**
13117     * Callback type for the JS confirm hook.
13118     *
13119     * The function parameters are:
13120     * @li @p data User data pointer set when setting the hook function
13121     * @li @p obj The elm_web object requesting the new window
13122     * @li @p message The message to show in the confirm dialog
13123     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13124     * the user selected @c Ok, @c EINA_FALSE otherwise.
13125     *
13126     * The function should return the object representing the confirm dialog.
13127     * Elm_Web will run a second main loop to handle the dialog and normal
13128     * flow of the application will be restored when the object is deleted, so
13129     * the user should handle the popup properly in order to delete the object
13130     * when the action is finished.
13131     * If the function returns @c NULL the popup will be ignored.
13132     *
13133     * @see elm_web_dialog_confirm_hook_set()
13134     */
13135    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13136    /**
13137     * Callback type for the JS prompt hook.
13138     *
13139     * The function parameters are:
13140     * @li @p data User data pointer set when setting the hook function
13141     * @li @p obj The elm_web object requesting the new window
13142     * @li @p message The message to show in the prompt dialog
13143     * @li @p def_value The default value to present the user in the entry
13144     * @li @p value Pointer where to store the value given by the user. Must
13145     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13146     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13147     * the user selected @c Ok, @c EINA_FALSE otherwise.
13148     *
13149     * The function should return the object representing the prompt dialog.
13150     * Elm_Web will run a second main loop to handle the dialog and normal
13151     * flow of the application will be restored when the object is deleted, so
13152     * the user should handle the popup properly in order to delete the object
13153     * when the action is finished.
13154     * If the function returns @c NULL the popup will be ignored.
13155     *
13156     * @see elm_web_dialog_prompt_hook_set()
13157     */
13158    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13159    /**
13160     * Callback type for the JS file selector hook.
13161     *
13162     * The function parameters are:
13163     * @li @p data User data pointer set when setting the hook function
13164     * @li @p obj The elm_web object requesting the new window
13165     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13166     * @li @p accept_types Mime types accepted
13167     * @li @p selected Pointer where to store the list of malloc'ed strings
13168     * containing the path to each file selected. Must be @c NULL if the file
13169     * dialog is cancelled
13170     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13171     * the user selected @c Ok, @c EINA_FALSE otherwise.
13172     *
13173     * The function should return the object representing the file selector
13174     * dialog.
13175     * Elm_Web will run a second main loop to handle the dialog and normal
13176     * flow of the application will be restored when the object is deleted, so
13177     * the user should handle the popup properly in order to delete the object
13178     * when the action is finished.
13179     * If the function returns @c NULL the popup will be ignored.
13180     *
13181     * @see elm_web_dialog_file selector_hook_set()
13182     */
13183    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, const char *accept_types, Eina_List **selected, Eina_Bool *ret);
13184    /**
13185     * Callback type for the JS console message hook.
13186     *
13187     * When a console message is added from JavaScript, any set function to the
13188     * console message hook will be called for the user to handle. There is no
13189     * default implementation of this hook.
13190     *
13191     * The function parameters are:
13192     * @li @p data User data pointer set when setting the hook function
13193     * @li @p obj The elm_web object that originated the message
13194     * @li @p message The message sent
13195     * @li @p line_number The line number
13196     * @li @p source_id Source id
13197     *
13198     * @see elm_web_console_message_hook_set()
13199     */
13200    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13201    /**
13202     * Add a new web object to the parent.
13203     *
13204     * @param parent The parent object.
13205     * @return The new object or NULL if it cannot be created.
13206     *
13207     * @see elm_web_uri_set()
13208     * @see elm_web_webkit_view_get()
13209     */
13210    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13211
13212    /**
13213     * Get internal ewk_view object from web object.
13214     *
13215     * Elementary may not provide some low level features of EWebKit,
13216     * instead of cluttering the API with proxy methods we opted to
13217     * return the internal reference. Be careful using it as it may
13218     * interfere with elm_web behavior.
13219     *
13220     * @param obj The web object.
13221     * @return The internal ewk_view object or NULL if it does not
13222     *         exist. (Failure to create or Elementary compiled without
13223     *         ewebkit)
13224     *
13225     * @see elm_web_add()
13226     */
13227    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13228
13229    /**
13230     * Sets the function to call when a new window is requested
13231     *
13232     * This hook will be called when a request to create a new window is
13233     * issued from the web page loaded.
13234     * There is no default implementation for this feature, so leaving this
13235     * unset or passing @c NULL in @p func will prevent new windows from
13236     * opening.
13237     *
13238     * @param obj The web object where to set the hook function
13239     * @param func The hook function to be called when a window is requested
13240     * @param data User data
13241     */
13242    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13243    /**
13244     * Sets the function to call when an alert dialog
13245     *
13246     * This hook will be called when a JavaScript alert dialog is requested.
13247     * If no function is set or @c NULL is passed in @p func, the default
13248     * implementation will take place.
13249     *
13250     * @param obj The web object where to set the hook function
13251     * @param func The callback function to be used
13252     * @param data User data
13253     *
13254     * @see elm_web_inwin_mode_set()
13255     */
13256    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13257    /**
13258     * Sets the function to call when an confirm dialog
13259     *
13260     * This hook will be called when a JavaScript confirm dialog is requested.
13261     * If no function is set or @c NULL is passed in @p func, the default
13262     * implementation will take place.
13263     *
13264     * @param obj The web object where to set the hook function
13265     * @param func The callback function to be used
13266     * @param data User data
13267     *
13268     * @see elm_web_inwin_mode_set()
13269     */
13270    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13271    /**
13272     * Sets the function to call when an prompt dialog
13273     *
13274     * This hook will be called when a JavaScript prompt dialog is requested.
13275     * If no function is set or @c NULL is passed in @p func, the default
13276     * implementation will take place.
13277     *
13278     * @param obj The web object where to set the hook function
13279     * @param func The callback function to be used
13280     * @param data User data
13281     *
13282     * @see elm_web_inwin_mode_set()
13283     */
13284    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13285    /**
13286     * Sets the function to call when an file selector dialog
13287     *
13288     * This hook will be called when a JavaScript file selector dialog is
13289     * requested.
13290     * If no function is set or @c NULL is passed in @p func, the default
13291     * implementation will take place.
13292     *
13293     * @param obj The web object where to set the hook function
13294     * @param func The callback function to be used
13295     * @param data User data
13296     *
13297     * @see elm_web_inwin_mode_set()
13298     */
13299    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13300    /**
13301     * Sets the function to call when a console message is emitted from JS
13302     *
13303     * This hook will be called when a console message is emitted from
13304     * JavaScript. There is no default implementation for this feature.
13305     *
13306     * @param obj The web object where to set the hook function
13307     * @param func The callback function to be used
13308     * @param data User data
13309     */
13310    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13311    /**
13312     * Gets the status of the tab propagation
13313     *
13314     * @param obj The web object to query
13315     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13316     *
13317     * @see elm_web_tab_propagate_set()
13318     */
13319    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13320    /**
13321     * Sets whether to use tab propagation
13322     *
13323     * If tab propagation is enabled, whenever the user presses the Tab key,
13324     * Elementary will handle it and switch focus to the next widget.
13325     * The default value is disabled, where WebKit will handle the Tab key to
13326     * cycle focus though its internal objects, jumping to the next widget
13327     * only when that cycle ends.
13328     *
13329     * @param obj The web object
13330     * @param propagate Whether to propagate Tab keys to Elementary or not
13331     */
13332    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13333    /**
13334     * Sets the URI for the web object
13335     *
13336     * It must be a full URI, with resource included, in the form
13337     * http://www.enlightenment.org or file:///tmp/something.html
13338     *
13339     * @param obj The web object
13340     * @param uri The URI to set
13341     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13342     */
13343    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13344    /**
13345     * Gets the current URI for the object
13346     *
13347     * The returned string must not be freed and is guaranteed to be
13348     * stringshared.
13349     *
13350     * @param obj The web object
13351     * @return A stringshared internal string with the current URI, or NULL on
13352     * failure
13353     */
13354    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13355    /**
13356     * Gets the current title
13357     *
13358     * The returned string must not be freed and is guaranteed to be
13359     * stringshared.
13360     *
13361     * @param obj The web object
13362     * @return A stringshared internal string with the current title, or NULL on
13363     * failure
13364     */
13365    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13366    /**
13367     * Sets the background color to be used by the web object
13368     *
13369     * This is the color that will be used by default when the loaded page
13370     * does not set it's own. Color values are pre-multiplied.
13371     *
13372     * @param obj The web object
13373     * @param r Red component
13374     * @param g Green component
13375     * @param b Blue component
13376     * @param a Alpha component
13377     */
13378    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13379    /**
13380     * Gets the background color to be used by the web object
13381     *
13382     * This is the color that will be used by default when the loaded page
13383     * does not set it's own. Color values are pre-multiplied.
13384     *
13385     * @param obj The web object
13386     * @param r Red component
13387     * @param g Green component
13388     * @param b Blue component
13389     * @param a Alpha component
13390     */
13391    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13392    /**
13393     * Gets a copy of the currently selected text
13394     *
13395     * The string returned must be freed by the user when it's done with it.
13396     *
13397     * @param obj The web object
13398     * @return A newly allocated string, or NULL if nothing is selected or an
13399     * error occurred
13400     */
13401    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13402    /**
13403     * Tells the web object which index in the currently open popup was selected
13404     *
13405     * When the user handles the popup creation from the "popup,created" signal,
13406     * it needs to tell the web object which item was selected by calling this
13407     * function with the index corresponding to the item.
13408     *
13409     * @param obj The web object
13410     * @param index The index selected
13411     *
13412     * @see elm_web_popup_destroy()
13413     */
13414    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13415    /**
13416     * Dismisses an open dropdown popup
13417     *
13418     * When the popup from a dropdown widget is to be dismissed, either after
13419     * selecting an option or to cancel it, this function must be called, which
13420     * will later emit an "popup,willdelete" signal to notify the user that
13421     * any memory and objects related to this popup can be freed.
13422     *
13423     * @param obj The web object
13424     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13425     * if there was no menu to destroy
13426     */
13427    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13428    /**
13429     * Searches the given string in a document.
13430     *
13431     * @param obj The web object where to search the text
13432     * @param string String to search
13433     * @param case_sensitive If search should be case sensitive or not
13434     * @param forward If search is from cursor and on or backwards
13435     * @param wrap If search should wrap at the end
13436     *
13437     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13438     * or failure
13439     */
13440    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13441    /**
13442     * Marks matches of the given string in a document.
13443     *
13444     * @param obj The web object where to search text
13445     * @param string String to match
13446     * @param case_sensitive If match should be case sensitive or not
13447     * @param highlight If matches should be highlighted
13448     * @param limit Maximum amount of matches, or zero to unlimited
13449     *
13450     * @return number of matched @a string
13451     */
13452    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13453    /**
13454     * Clears all marked matches in the document
13455     *
13456     * @param obj The web object
13457     *
13458     * @return EINA_TRUE on success, EINA_FALSE otherwise
13459     */
13460    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13461    /**
13462     * Sets whether to highlight the matched marks
13463     *
13464     * If enabled, marks set with elm_web_text_matches_mark() will be
13465     * highlighted.
13466     *
13467     * @param obj The web object
13468     * @param highlight Whether to highlight the marks or not
13469     *
13470     * @return EINA_TRUE on success, EINA_FALSE otherwise
13471     */
13472    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13473    /**
13474     * Gets whether highlighting marks is enabled
13475     *
13476     * @param The web object
13477     *
13478     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13479     * otherwise
13480     */
13481    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13482    /**
13483     * Gets the overall loading progress of the page
13484     *
13485     * Returns the estimated loading progress of the page, with a value between
13486     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13487     * included in the page.
13488     *
13489     * @param The web object
13490     *
13491     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13492     * failure
13493     */
13494    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13495    /**
13496     * Stops loading the current page
13497     *
13498     * Cancels the loading of the current page in the web object. This will
13499     * cause a "load,error" signal to be emitted, with the is_cancellation
13500     * flag set to EINA_TRUE.
13501     *
13502     * @param obj The web object
13503     *
13504     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13505     */
13506    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13507    /**
13508     * Requests a reload of the current document in the object
13509     *
13510     * @param obj The web object
13511     *
13512     * @return EINA_TRUE on success, EINA_FALSE otherwise
13513     */
13514    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13515    /**
13516     * Requests a reload of the current document, avoiding any existing caches
13517     *
13518     * @param obj The web object
13519     *
13520     * @return EINA_TRUE on success, EINA_FALSE otherwise
13521     */
13522    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13523    /**
13524     * Goes back one step in the browsing history
13525     *
13526     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13527     *
13528     * @param obj The web object
13529     *
13530     * @return EINA_TRUE on success, EINA_FALSE otherwise
13531     *
13532     * @see elm_web_history_enable_set()
13533     * @see elm_web_back_possible()
13534     * @see elm_web_forward()
13535     * @see elm_web_navigate()
13536     */
13537    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13538    /**
13539     * Goes forward one step in the browsing history
13540     *
13541     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13542     *
13543     * @param obj The web object
13544     *
13545     * @return EINA_TRUE on success, EINA_FALSE otherwise
13546     *
13547     * @see elm_web_history_enable_set()
13548     * @see elm_web_forward_possible()
13549     * @see elm_web_back()
13550     * @see elm_web_navigate()
13551     */
13552    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13553    /**
13554     * Jumps the given number of steps in the browsing history
13555     *
13556     * The @p steps value can be a negative integer to back in history, or a
13557     * positive to move forward.
13558     *
13559     * @param obj The web object
13560     * @param steps The number of steps to jump
13561     *
13562     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13563     * history exists to jump the given number of steps
13564     *
13565     * @see elm_web_history_enable_set()
13566     * @see elm_web_navigate_possible()
13567     * @see elm_web_back()
13568     * @see elm_web_forward()
13569     */
13570    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13571    /**
13572     * Queries whether it's possible to go back in history
13573     *
13574     * @param obj The web object
13575     *
13576     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13577     * otherwise
13578     */
13579    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13580    /**
13581     * Queries whether it's possible to go forward in history
13582     *
13583     * @param obj The web object
13584     *
13585     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13586     * otherwise
13587     */
13588    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13589    /**
13590     * Queries whether it's possible to jump the given number of steps
13591     *
13592     * The @p steps value can be a negative integer to back in history, or a
13593     * positive to move forward.
13594     *
13595     * @param obj The web object
13596     * @param steps The number of steps to check for
13597     *
13598     * @return EINA_TRUE if enough history exists to perform the given jump,
13599     * EINA_FALSE otherwise
13600     */
13601    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13602    /**
13603     * Gets whether browsing history is enabled for the given object
13604     *
13605     * @param obj The web object
13606     *
13607     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13608     */
13609    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13610    /**
13611     * Enables or disables the browsing history
13612     *
13613     * @param obj The web object
13614     * @param enable Whether to enable or disable the browsing history
13615     */
13616    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13617    /**
13618     * Sets the zoom level of the web object
13619     *
13620     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13621     * values meaning zoom in and lower meaning zoom out. This function will
13622     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13623     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13624     *
13625     * @param obj The web object
13626     * @param zoom The zoom level to set
13627     */
13628    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13629    /**
13630     * Gets the current zoom level set on the web object
13631     *
13632     * Note that this is the zoom level set on the web object and not that
13633     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13634     * the two zoom levels should match, but for the other two modes the
13635     * Webkit zoom is calculated internally to match the chosen mode without
13636     * changing the zoom level set for the web object.
13637     *
13638     * @param obj The web object
13639     *
13640     * @return The zoom level set on the object
13641     */
13642    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13643    /**
13644     * Sets the zoom mode to use
13645     *
13646     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13647     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13648     *
13649     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13650     * with the elm_web_zoom_set() function.
13651     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13652     * make sure the entirety of the web object's contents are shown.
13653     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13654     * fit the contents in the web object's size, without leaving any space
13655     * unused.
13656     *
13657     * @param obj The web object
13658     * @param mode The mode to set
13659     */
13660    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13661    /**
13662     * Gets the currently set zoom mode
13663     *
13664     * @param obj The web object
13665     *
13666     * @return The current zoom mode set for the object, or
13667     * ::ELM_WEB_ZOOM_MODE_LAST on error
13668     */
13669    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13670    /**
13671     * Shows the given region in the web object
13672     *
13673     * @param obj The web object
13674     * @param x The x coordinate of the region to show
13675     * @param y The y coordinate of the region to show
13676     * @param w The width of the region to show
13677     * @param h The height of the region to show
13678     */
13679    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13680    /**
13681     * Brings in the region to the visible area
13682     *
13683     * Like elm_web_region_show(), but it animates the scrolling of the object
13684     * to show the area
13685     *
13686     * @param obj The web object
13687     * @param x The x coordinate of the region to show
13688     * @param y The y coordinate of the region to show
13689     * @param w The width of the region to show
13690     * @param h The height of the region to show
13691     */
13692    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13693    /**
13694     * Sets the default dialogs to use an Inwin instead of a normal window
13695     *
13696     * If set, then the default implementation for the JavaScript dialogs and
13697     * file selector will be opened in an Inwin. Otherwise they will use a
13698     * normal separated window.
13699     *
13700     * @param obj The web object
13701     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13702     */
13703    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13704    /**
13705     * Gets whether Inwin mode is set for the current object
13706     *
13707     * @param obj The web object
13708     *
13709     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13710     */
13711    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13712
13713    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13714    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13715    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);
13716    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13717
13718    /**
13719     * @}
13720     */
13721
13722    /**
13723     * @defgroup Hoversel Hoversel
13724     *
13725     * @image html img/widget/hoversel/preview-00.png
13726     * @image latex img/widget/hoversel/preview-00.eps
13727     *
13728     * A hoversel is a button that pops up a list of items (automatically
13729     * choosing the direction to display) that have a label and, optionally, an
13730     * icon to select from. It is a convenience widget to avoid the need to do
13731     * all the piecing together yourself. It is intended for a small number of
13732     * items in the hoversel menu (no more than 8), though is capable of many
13733     * more.
13734     *
13735     * Signals that you can add callbacks for are:
13736     * "clicked" - the user clicked the hoversel button and popped up the sel
13737     * "selected" - an item in the hoversel list is selected. event_info is the item
13738     * "dismissed" - the hover is dismissed
13739     *
13740     * See @ref tutorial_hoversel for an example.
13741     * @{
13742     */
13743    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13744    /**
13745     * @brief Add a new Hoversel object
13746     *
13747     * @param parent The parent object
13748     * @return The new object or NULL if it cannot be created
13749     */
13750    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13751    /**
13752     * @brief This sets the hoversel to expand horizontally.
13753     *
13754     * @param obj The hoversel object
13755     * @param horizontal If true, the hover will expand horizontally to the
13756     * right.
13757     *
13758     * @note The initial button will display horizontally regardless of this
13759     * setting.
13760     */
13761    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13762    /**
13763     * @brief This returns whether the hoversel is set to expand horizontally.
13764     *
13765     * @param obj The hoversel object
13766     * @return If true, the hover will expand horizontally to the right.
13767     *
13768     * @see elm_hoversel_horizontal_set()
13769     */
13770    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13771    /**
13772     * @brief Set the Hover parent
13773     *
13774     * @param obj The hoversel object
13775     * @param parent The parent to use
13776     *
13777     * Sets the hover parent object, the area that will be darkened when the
13778     * hoversel is clicked. Should probably be the window that the hoversel is
13779     * in. See @ref Hover objects for more information.
13780     */
13781    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13782    /**
13783     * @brief Get the Hover parent
13784     *
13785     * @param obj The hoversel object
13786     * @return The used parent
13787     *
13788     * Gets the hover parent object.
13789     *
13790     * @see elm_hoversel_hover_parent_set()
13791     */
13792    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13793    /**
13794     * @brief Set the hoversel button label
13795     *
13796     * @param obj The hoversel object
13797     * @param label The label text.
13798     *
13799     * This sets the label of the button that is always visible (before it is
13800     * clicked and expanded).
13801     *
13802     * @deprecated elm_object_text_set()
13803     */
13804    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13805    /**
13806     * @brief Get the hoversel button label
13807     *
13808     * @param obj The hoversel object
13809     * @return The label text.
13810     *
13811     * @deprecated elm_object_text_get()
13812     */
13813    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13814    /**
13815     * @brief Set the icon of the hoversel button
13816     *
13817     * @param obj The hoversel object
13818     * @param icon The icon object
13819     *
13820     * Sets the icon of the button that is always visible (before it is clicked
13821     * and expanded).  Once the icon object is set, a previously set one will be
13822     * deleted, if you want to keep that old content object, use the
13823     * elm_hoversel_icon_unset() function.
13824     *
13825     * @see elm_button_icon_set()
13826     */
13827    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13828    /**
13829     * @brief Get the icon of the hoversel button
13830     *
13831     * @param obj The hoversel object
13832     * @return The icon object
13833     *
13834     * Get the icon of the button that is always visible (before it is clicked
13835     * and expanded). Also see elm_button_icon_get().
13836     *
13837     * @see elm_hoversel_icon_set()
13838     */
13839    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13840    /**
13841     * @brief Get and unparent the icon of the hoversel button
13842     *
13843     * @param obj The hoversel object
13844     * @return The icon object that was being used
13845     *
13846     * Unparent and return the icon of the button that is always visible
13847     * (before it is clicked and expanded).
13848     *
13849     * @see elm_hoversel_icon_set()
13850     * @see elm_button_icon_unset()
13851     */
13852    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13853    /**
13854     * @brief This triggers the hoversel popup from code, the same as if the user
13855     * had clicked the button.
13856     *
13857     * @param obj The hoversel object
13858     */
13859    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13860    /**
13861     * @brief This dismisses the hoversel popup as if the user had clicked
13862     * outside the hover.
13863     *
13864     * @param obj The hoversel object
13865     */
13866    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13867    /**
13868     * @brief Returns whether the hoversel is expanded.
13869     *
13870     * @param obj The hoversel object
13871     * @return  This will return EINA_TRUE if the hoversel is expanded or
13872     * EINA_FALSE if it is not expanded.
13873     */
13874    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13875    /**
13876     * @brief This will remove all the children items from the hoversel.
13877     *
13878     * @param obj The hoversel object
13879     *
13880     * @warning Should @b not be called while the hoversel is active; use
13881     * elm_hoversel_expanded_get() to check first.
13882     *
13883     * @see elm_hoversel_item_del_cb_set()
13884     * @see elm_hoversel_item_del()
13885     */
13886    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13887    /**
13888     * @brief Get the list of items within the given hoversel.
13889     *
13890     * @param obj The hoversel object
13891     * @return Returns a list of Elm_Hoversel_Item*
13892     *
13893     * @see elm_hoversel_item_add()
13894     */
13895    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13896    /**
13897     * @brief Add an item to the hoversel button
13898     *
13899     * @param obj The hoversel object
13900     * @param label The text label to use for the item (NULL if not desired)
13901     * @param icon_file An image file path on disk to use for the icon or standard
13902     * icon name (NULL if not desired)
13903     * @param icon_type The icon type if relevant
13904     * @param func Convenience function to call when this item is selected
13905     * @param data Data to pass to item-related functions
13906     * @return A handle to the item added.
13907     *
13908     * This adds an item to the hoversel to show when it is clicked. Note: if you
13909     * need to use an icon from an edje file then use
13910     * elm_hoversel_item_icon_set() right after the this function, and set
13911     * icon_file to NULL here.
13912     *
13913     * For more information on what @p icon_file and @p icon_type are see the
13914     * @ref Icon "icon documentation".
13915     */
13916    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);
13917    /**
13918     * @brief Delete an item from the hoversel
13919     *
13920     * @param item The item to delete
13921     *
13922     * This deletes the item from the hoversel (should not be called while the
13923     * hoversel is active; use elm_hoversel_expanded_get() to check first).
13924     *
13925     * @see elm_hoversel_item_add()
13926     * @see elm_hoversel_item_del_cb_set()
13927     */
13928    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13929    /**
13930     * @brief Set the function to be called when an item from the hoversel is
13931     * freed.
13932     *
13933     * @param item The item to set the callback on
13934     * @param func The function called
13935     *
13936     * That function will receive these parameters:
13937     * @li void *item_data
13938     * @li Evas_Object *the_item_object
13939     * @li Elm_Hoversel_Item *the_object_struct
13940     *
13941     * @see elm_hoversel_item_add()
13942     */
13943    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13944    /**
13945     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13946     * that will be passed to associated function callbacks.
13947     *
13948     * @param item The item to get the data from
13949     * @return The data pointer set with elm_hoversel_item_add()
13950     *
13951     * @see elm_hoversel_item_add()
13952     */
13953    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13954    /**
13955     * @brief This returns the label text of the given hoversel item.
13956     *
13957     * @param item The item to get the label
13958     * @return The label text of the hoversel item
13959     *
13960     * @see elm_hoversel_item_add()
13961     */
13962    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13963    /**
13964     * @brief This sets the icon for the given hoversel item.
13965     *
13966     * @param item The item to set the icon
13967     * @param icon_file An image file path on disk to use for the icon or standard
13968     * icon name
13969     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13970     * to NULL if the icon is not an edje file
13971     * @param icon_type The icon type
13972     *
13973     * The icon can be loaded from the standard set, from an image file, or from
13974     * an edje file.
13975     *
13976     * @see elm_hoversel_item_add()
13977     */
13978    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);
13979    /**
13980     * @brief Get the icon object of the hoversel item
13981     *
13982     * @param item The item to get the icon from
13983     * @param icon_file The image file path on disk used for the icon or standard
13984     * icon name
13985     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13986     * if the icon is not an edje file
13987     * @param icon_type The icon type
13988     *
13989     * @see elm_hoversel_item_icon_set()
13990     * @see elm_hoversel_item_add()
13991     */
13992    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);
13993    /**
13994     * @}
13995     */
13996
13997    /**
13998     * @defgroup Toolbar Toolbar
13999     * @ingroup Elementary
14000     *
14001     * @image html img/widget/toolbar/preview-00.png
14002     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14003     *
14004     * @image html img/toolbar.png
14005     * @image latex img/toolbar.eps width=\textwidth
14006     *
14007     * A toolbar is a widget that displays a list of items inside
14008     * a box. It can be scrollable, show a menu with items that don't fit
14009     * to toolbar size or even crop them.
14010     *
14011     * Only one item can be selected at a time.
14012     *
14013     * Items can have multiple states, or show menus when selected by the user.
14014     *
14015     * Smart callbacks one can listen to:
14016     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14017     *
14018     * Available styles for it:
14019     * - @c "default"
14020     * - @c "transparent" - no background or shadow, just show the content
14021     *
14022     * List of examples:
14023     * @li @ref toolbar_example_01
14024     * @li @ref toolbar_example_02
14025     * @li @ref toolbar_example_03
14026     */
14027
14028    /**
14029     * @addtogroup Toolbar
14030     * @{
14031     */
14032
14033    /**
14034     * @enum _Elm_Toolbar_Shrink_Mode
14035     * @typedef Elm_Toolbar_Shrink_Mode
14036     *
14037     * Set toolbar's items display behavior, it can be scrollabel,
14038     * show a menu with exceeding items, or simply hide them.
14039     *
14040     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14041     * from elm config.
14042     *
14043     * Values <b> don't </b> work as bitmask, only one can be choosen.
14044     *
14045     * @see elm_toolbar_mode_shrink_set()
14046     * @see elm_toolbar_mode_shrink_get()
14047     *
14048     * @ingroup Toolbar
14049     */
14050    typedef enum _Elm_Toolbar_Shrink_Mode
14051      {
14052         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14053         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14054         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14055         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
14056      } Elm_Toolbar_Shrink_Mode;
14057
14058    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(). */
14059
14060    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(). */
14061
14062    /**
14063     * Add a new toolbar widget to the given parent Elementary
14064     * (container) object.
14065     *
14066     * @param parent The parent object.
14067     * @return a new toolbar widget handle or @c NULL, on errors.
14068     *
14069     * This function inserts a new toolbar widget on the canvas.
14070     *
14071     * @ingroup Toolbar
14072     */
14073    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14074
14075    /**
14076     * Set the icon size, in pixels, to be used by toolbar items.
14077     *
14078     * @param obj The toolbar object
14079     * @param icon_size The icon size in pixels
14080     *
14081     * @note Default value is @c 32. It reads value from elm config.
14082     *
14083     * @see elm_toolbar_icon_size_get()
14084     *
14085     * @ingroup Toolbar
14086     */
14087    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14088
14089    /**
14090     * Get the icon size, in pixels, to be used by toolbar items.
14091     *
14092     * @param obj The toolbar object.
14093     * @return The icon size in pixels.
14094     *
14095     * @see elm_toolbar_icon_size_set() for details.
14096     *
14097     * @ingroup Toolbar
14098     */
14099    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14100
14101    /**
14102     * Sets icon lookup order, for toolbar items' icons.
14103     *
14104     * @param obj The toolbar object.
14105     * @param order The icon lookup order.
14106     *
14107     * Icons added before calling this function will not be affected.
14108     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14109     *
14110     * @see elm_toolbar_icon_order_lookup_get()
14111     *
14112     * @ingroup Toolbar
14113     */
14114    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14115
14116    /**
14117     * Gets the icon lookup order.
14118     *
14119     * @param obj The toolbar object.
14120     * @return The icon lookup order.
14121     *
14122     * @see elm_toolbar_icon_order_lookup_set() for details.
14123     *
14124     * @ingroup Toolbar
14125     */
14126    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14127
14128    /**
14129     * Set whether the toolbar should always have an item selected.
14130     *
14131     * @param obj The toolbar object.
14132     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14133     * disable it.
14134     *
14135     * This will cause the toolbar to always have an item selected, and clicking
14136     * the selected item will not cause a selected event to be emitted. Enabling this mode
14137     * will immediately select the first toolbar item.
14138     *
14139     * Always-selected is disabled by default.
14140     *
14141     * @see elm_toolbar_always_select_mode_get().
14142     *
14143     * @ingroup Toolbar
14144     */
14145    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14146
14147    /**
14148     * Get whether the toolbar should always have an item selected.
14149     *
14150     * @param obj The toolbar object.
14151     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14152     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14153     *
14154     * @see elm_toolbar_always_select_mode_set() for details.
14155     *
14156     * @ingroup Toolbar
14157     */
14158    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14159
14160    /**
14161     * Set whether the toolbar items' should be selected by the user or not.
14162     *
14163     * @param obj The toolbar object.
14164     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14165     * enable it.
14166     *
14167     * This will turn off the ability to select items entirely and they will
14168     * neither appear selected nor emit selected signals. The clicked
14169     * callback function will still be called.
14170     *
14171     * Selection is enabled by default.
14172     *
14173     * @see elm_toolbar_no_select_mode_get().
14174     *
14175     * @ingroup Toolbar
14176     */
14177    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14178
14179    /**
14180     * Set whether the toolbar items' should be selected by the user or not.
14181     *
14182     * @param obj The toolbar object.
14183     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14184     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14185     *
14186     * @see elm_toolbar_no_select_mode_set() for details.
14187     *
14188     * @ingroup Toolbar
14189     */
14190    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14191
14192    /**
14193     * Append item to the toolbar.
14194     *
14195     * @param obj The toolbar object.
14196     * @param icon A string with icon name or the absolute path of an image file.
14197     * @param label The label of the item.
14198     * @param func The function to call when the item is clicked.
14199     * @param data The data to associate with the item for related callbacks.
14200     * @return The created item or @c NULL upon failure.
14201     *
14202     * A new item will be created and appended to the toolbar, i.e., will
14203     * be set as @b last item.
14204     *
14205     * Items created with this method can be deleted with
14206     * elm_toolbar_item_del().
14207     *
14208     * Associated @p data can be properly freed when item is deleted if a
14209     * callback function is set with elm_toolbar_item_del_cb_set().
14210     *
14211     * If a function is passed as argument, it will be called everytime this item
14212     * is selected, i.e., the user clicks over an unselected item.
14213     * If such function isn't needed, just passing
14214     * @c NULL as @p func is enough. The same should be done for @p data.
14215     *
14216     * Toolbar will load icon image from fdo or current theme.
14217     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14218     * If an absolute path is provided it will load it direct from a file.
14219     *
14220     * @see elm_toolbar_item_icon_set()
14221     * @see elm_toolbar_item_del()
14222     * @see elm_toolbar_item_del_cb_set()
14223     *
14224     * @ingroup Toolbar
14225     */
14226    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);
14227
14228    /**
14229     * Prepend item to the toolbar.
14230     *
14231     * @param obj The toolbar object.
14232     * @param icon A string with icon name or the absolute path of an image file.
14233     * @param label The label of the item.
14234     * @param func The function to call when the item is clicked.
14235     * @param data The data to associate with the item for related callbacks.
14236     * @return The created item or @c NULL upon failure.
14237     *
14238     * A new item will be created and prepended to the toolbar, i.e., will
14239     * be set as @b first item.
14240     *
14241     * Items created with this method can be deleted with
14242     * elm_toolbar_item_del().
14243     *
14244     * Associated @p data can be properly freed when item is deleted if a
14245     * callback function is set with elm_toolbar_item_del_cb_set().
14246     *
14247     * If a function is passed as argument, it will be called everytime this item
14248     * is selected, i.e., the user clicks over an unselected item.
14249     * If such function isn't needed, just passing
14250     * @c NULL as @p func is enough. The same should be done for @p data.
14251     *
14252     * Toolbar will load icon image from fdo or current theme.
14253     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14254     * If an absolute path is provided it will load it direct from a file.
14255     *
14256     * @see elm_toolbar_item_icon_set()
14257     * @see elm_toolbar_item_del()
14258     * @see elm_toolbar_item_del_cb_set()
14259     *
14260     * @ingroup Toolbar
14261     */
14262    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);
14263
14264    /**
14265     * Insert a new item into the toolbar object before item @p before.
14266     *
14267     * @param obj The toolbar object.
14268     * @param before The toolbar item to insert before.
14269     * @param icon A string with icon name or the absolute path of an image file.
14270     * @param label The label of the item.
14271     * @param func The function to call when the item is clicked.
14272     * @param data The data to associate with the item for related callbacks.
14273     * @return The created item or @c NULL upon failure.
14274     *
14275     * A new item will be created and added to the toolbar. Its position in
14276     * this toolbar will be just before item @p before.
14277     *
14278     * Items created with this method can be deleted with
14279     * elm_toolbar_item_del().
14280     *
14281     * Associated @p data can be properly freed when item is deleted if a
14282     * callback function is set with elm_toolbar_item_del_cb_set().
14283     *
14284     * If a function is passed as argument, it will be called everytime this item
14285     * is selected, i.e., the user clicks over an unselected item.
14286     * If such function isn't needed, just passing
14287     * @c NULL as @p func is enough. The same should be done for @p data.
14288     *
14289     * Toolbar will load icon image from fdo or current theme.
14290     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14291     * If an absolute path is provided it will load it direct from a file.
14292     *
14293     * @see elm_toolbar_item_icon_set()
14294     * @see elm_toolbar_item_del()
14295     * @see elm_toolbar_item_del_cb_set()
14296     *
14297     * @ingroup Toolbar
14298     */
14299    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);
14300
14301    /**
14302     * Insert a new item into the toolbar object after item @p after.
14303     *
14304     * @param obj The toolbar object.
14305     * @param before The toolbar item to insert before.
14306     * @param icon A string with icon name or the absolute path of an image file.
14307     * @param label The label of the item.
14308     * @param func The function to call when the item is clicked.
14309     * @param data The data to associate with the item for related callbacks.
14310     * @return The created item or @c NULL upon failure.
14311     *
14312     * A new item will be created and added to the toolbar. Its position in
14313     * this toolbar will be just after item @p after.
14314     *
14315     * Items created with this method can be deleted with
14316     * elm_toolbar_item_del().
14317     *
14318     * Associated @p data can be properly freed when item is deleted if a
14319     * callback function is set with elm_toolbar_item_del_cb_set().
14320     *
14321     * If a function is passed as argument, it will be called everytime this item
14322     * is selected, i.e., the user clicks over an unselected item.
14323     * If such function isn't needed, just passing
14324     * @c NULL as @p func is enough. The same should be done for @p data.
14325     *
14326     * Toolbar will load icon image from fdo or current theme.
14327     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14328     * If an absolute path is provided it will load it direct from a file.
14329     *
14330     * @see elm_toolbar_item_icon_set()
14331     * @see elm_toolbar_item_del()
14332     * @see elm_toolbar_item_del_cb_set()
14333     *
14334     * @ingroup Toolbar
14335     */
14336    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);
14337
14338    /**
14339     * Get the first item in the given toolbar widget's list of
14340     * items.
14341     *
14342     * @param obj The toolbar object
14343     * @return The first item or @c NULL, if it has no items (and on
14344     * errors)
14345     *
14346     * @see elm_toolbar_item_append()
14347     * @see elm_toolbar_last_item_get()
14348     *
14349     * @ingroup Toolbar
14350     */
14351    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14352
14353    /**
14354     * Get the last item in the given toolbar widget's list of
14355     * items.
14356     *
14357     * @param obj The toolbar object
14358     * @return The last item or @c NULL, if it has no items (and on
14359     * errors)
14360     *
14361     * @see elm_toolbar_item_prepend()
14362     * @see elm_toolbar_first_item_get()
14363     *
14364     * @ingroup Toolbar
14365     */
14366    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14367
14368    /**
14369     * Get the item after @p item in toolbar.
14370     *
14371     * @param item The toolbar item.
14372     * @return The item after @p item, or @c NULL if none or on failure.
14373     *
14374     * @note If it is the last item, @c NULL will be returned.
14375     *
14376     * @see elm_toolbar_item_append()
14377     *
14378     * @ingroup Toolbar
14379     */
14380    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14381
14382    /**
14383     * Get the item before @p item in toolbar.
14384     *
14385     * @param item The toolbar item.
14386     * @return The item before @p item, or @c NULL if none or on failure.
14387     *
14388     * @note If it is the first item, @c NULL will be returned.
14389     *
14390     * @see elm_toolbar_item_prepend()
14391     *
14392     * @ingroup Toolbar
14393     */
14394    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14395
14396    /**
14397     * Get the toolbar object from an item.
14398     *
14399     * @param item The item.
14400     * @return The toolbar object.
14401     *
14402     * This returns the toolbar object itself that an item belongs to.
14403     *
14404     * @ingroup Toolbar
14405     */
14406    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14407
14408    /**
14409     * Set the priority of a toolbar item.
14410     *
14411     * @param item The toolbar item.
14412     * @param priority The item priority. The default is zero.
14413     *
14414     * This is used only when the toolbar shrink mode is set to
14415     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14416     * When space is less than required, items with low priority
14417     * will be removed from the toolbar and added to a dynamically-created menu,
14418     * while items with higher priority will remain on the toolbar,
14419     * with the same order they were added.
14420     *
14421     * @see elm_toolbar_item_priority_get()
14422     *
14423     * @ingroup Toolbar
14424     */
14425    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14426
14427    /**
14428     * Get the priority of a toolbar item.
14429     *
14430     * @param item The toolbar item.
14431     * @return The @p item priority, or @c 0 on failure.
14432     *
14433     * @see elm_toolbar_item_priority_set() for details.
14434     *
14435     * @ingroup Toolbar
14436     */
14437    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14438
14439    /**
14440     * Get the label of item.
14441     *
14442     * @param item The item of toolbar.
14443     * @return The label of item.
14444     *
14445     * The return value is a pointer to the label associated to @p item when
14446     * it was created, with function elm_toolbar_item_append() or similar,
14447     * or later,
14448     * with function elm_toolbar_item_label_set. If no label
14449     * was passed as argument, it will return @c NULL.
14450     *
14451     * @see elm_toolbar_item_label_set() for more details.
14452     * @see elm_toolbar_item_append()
14453     *
14454     * @ingroup Toolbar
14455     */
14456    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14457
14458    /**
14459     * Set the label of item.
14460     *
14461     * @param item The item of toolbar.
14462     * @param text The label of item.
14463     *
14464     * The label to be displayed by the item.
14465     * Label will be placed at icons bottom (if set).
14466     *
14467     * If a label was passed as argument on item creation, with function
14468     * elm_toolbar_item_append() or similar, it will be already
14469     * displayed by the item.
14470     *
14471     * @see elm_toolbar_item_label_get()
14472     * @see elm_toolbar_item_append()
14473     *
14474     * @ingroup Toolbar
14475     */
14476    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14477
14478    /**
14479     * Return the data associated with a given toolbar widget item.
14480     *
14481     * @param item The toolbar widget item handle.
14482     * @return The data associated with @p item.
14483     *
14484     * @see elm_toolbar_item_data_set()
14485     *
14486     * @ingroup Toolbar
14487     */
14488    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14489
14490    /**
14491     * Set the data associated with a given toolbar widget item.
14492     *
14493     * @param item The toolbar widget item handle.
14494     * @param data The new data pointer to set to @p item.
14495     *
14496     * This sets new item data on @p item.
14497     *
14498     * @warning The old data pointer won't be touched by this function, so
14499     * the user had better to free that old data himself/herself.
14500     *
14501     * @ingroup Toolbar
14502     */
14503    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14504
14505    /**
14506     * Returns a pointer to a toolbar item by its label.
14507     *
14508     * @param obj The toolbar object.
14509     * @param label The label of the item to find.
14510     *
14511     * @return The pointer to the toolbar item matching @p label or @c NULL
14512     * on failure.
14513     *
14514     * @ingroup Toolbar
14515     */
14516    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14517
14518    /*
14519     * Get whether the @p item is selected or not.
14520     *
14521     * @param item The toolbar item.
14522     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14523     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14524     *
14525     * @see elm_toolbar_selected_item_set() for details.
14526     * @see elm_toolbar_item_selected_get()
14527     *
14528     * @ingroup Toolbar
14529     */
14530    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14531
14532    /**
14533     * Set the selected state of an item.
14534     *
14535     * @param item The toolbar item
14536     * @param selected The selected state
14537     *
14538     * This sets the selected state of the given item @p it.
14539     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14540     *
14541     * If a new item is selected the previosly selected will be unselected.
14542     * Previoulsy selected item can be get with function
14543     * elm_toolbar_selected_item_get().
14544     *
14545     * Selected items will be highlighted.
14546     *
14547     * @see elm_toolbar_item_selected_get()
14548     * @see elm_toolbar_selected_item_get()
14549     *
14550     * @ingroup Toolbar
14551     */
14552    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14553
14554    /**
14555     * Get the selected item.
14556     *
14557     * @param obj The toolbar object.
14558     * @return The selected toolbar item.
14559     *
14560     * The selected item can be unselected with function
14561     * elm_toolbar_item_selected_set().
14562     *
14563     * The selected item always will be highlighted on toolbar.
14564     *
14565     * @see elm_toolbar_selected_items_get()
14566     *
14567     * @ingroup Toolbar
14568     */
14569    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14570
14571    /**
14572     * Set the icon associated with @p item.
14573     *
14574     * @param obj The parent of this item.
14575     * @param item The toolbar item.
14576     * @param icon A string with icon name or the absolute path of an image file.
14577     *
14578     * Toolbar will load icon image from fdo or current theme.
14579     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14580     * If an absolute path is provided it will load it direct from a file.
14581     *
14582     * @see elm_toolbar_icon_order_lookup_set()
14583     * @see elm_toolbar_icon_order_lookup_get()
14584     *
14585     * @ingroup Toolbar
14586     */
14587    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14588
14589    /**
14590     * Get the string used to set the icon of @p item.
14591     *
14592     * @param item The toolbar item.
14593     * @return The string associated with the icon object.
14594     *
14595     * @see elm_toolbar_item_icon_set() for details.
14596     *
14597     * @ingroup Toolbar
14598     */
14599    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14600
14601    /**
14602     * Get the object of @p item.
14603     *
14604     * @param item The toolbar item.
14605     * @return The object
14606     *
14607     * @ingroup Toolbar
14608     */
14609    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14610
14611    /**
14612     * Get the icon object of @p item.
14613     *
14614     * @param item The toolbar item.
14615     * @return The icon object
14616     *
14617     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14618     *
14619     * @ingroup Toolbar
14620     */
14621    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14622
14623    /**
14624     * Set the icon associated with @p item to an image in a binary buffer.
14625     *
14626     * @param item The toolbar item.
14627     * @param img The binary data that will be used as an image
14628     * @param size The size of binary data @p img
14629     * @param format Optional format of @p img to pass to the image loader
14630     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14631     *
14632     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14633     *
14634     * @note The icon image set by this function can be changed by
14635     * elm_toolbar_item_icon_set().
14636     * 
14637     * @ingroup Toolbar
14638     */
14639    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);
14640
14641    /**
14642     * Delete them item from the toolbar.
14643     *
14644     * @param item The item of toolbar to be deleted.
14645     *
14646     * @see elm_toolbar_item_append()
14647     * @see elm_toolbar_item_del_cb_set()
14648     *
14649     * @ingroup Toolbar
14650     */
14651    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14652
14653    /**
14654     * Set the function called when a toolbar item is freed.
14655     *
14656     * @param item The item to set the callback on.
14657     * @param func The function called.
14658     *
14659     * If there is a @p func, then it will be called prior item's memory release.
14660     * That will be called with the following arguments:
14661     * @li item's data;
14662     * @li item's Evas object;
14663     * @li item itself;
14664     *
14665     * This way, a data associated to a toolbar item could be properly freed.
14666     *
14667     * @ingroup Toolbar
14668     */
14669    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14670
14671    /**
14672     * Get a value whether toolbar item is disabled or not.
14673     *
14674     * @param item The item.
14675     * @return The disabled state.
14676     *
14677     * @see elm_toolbar_item_disabled_set() for more details.
14678     *
14679     * @ingroup Toolbar
14680     */
14681    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14682
14683    /**
14684     * Sets the disabled/enabled state of a toolbar item.
14685     *
14686     * @param item The item.
14687     * @param disabled The disabled state.
14688     *
14689     * A disabled item cannot be selected or unselected. It will also
14690     * change its appearance (generally greyed out). This sets the
14691     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14692     * enabled).
14693     *
14694     * @ingroup Toolbar
14695     */
14696    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14697
14698    /**
14699     * Set or unset item as a separator.
14700     *
14701     * @param item The toolbar item.
14702     * @param setting @c EINA_TRUE to set item @p item as separator or
14703     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14704     *
14705     * Items aren't set as separator by default.
14706     *
14707     * If set as separator it will display separator theme, so won't display
14708     * icons or label.
14709     *
14710     * @see elm_toolbar_item_separator_get()
14711     *
14712     * @ingroup Toolbar
14713     */
14714    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14715
14716    /**
14717     * Get a value whether item is a separator or not.
14718     *
14719     * @param item The toolbar item.
14720     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14721     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14722     *
14723     * @see elm_toolbar_item_separator_set() for details.
14724     *
14725     * @ingroup Toolbar
14726     */
14727    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14728
14729    /**
14730     * Set the shrink state of toolbar @p obj.
14731     *
14732     * @param obj The toolbar object.
14733     * @param shrink_mode Toolbar's items display behavior.
14734     *
14735     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14736     * but will enforce a minimun size so all the items will fit, won't scroll
14737     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14738     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14739     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14740     *
14741     * @ingroup Toolbar
14742     */
14743    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14744
14745    /**
14746     * Get the shrink mode of toolbar @p obj.
14747     *
14748     * @param obj The toolbar object.
14749     * @return Toolbar's items display behavior.
14750     *
14751     * @see elm_toolbar_mode_shrink_set() for details.
14752     *
14753     * @ingroup Toolbar
14754     */
14755    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14756
14757    /**
14758     * Enable/disable homogenous mode.
14759     *
14760     * @param obj The toolbar object
14761     * @param homogeneous Assume the items within the toolbar are of the
14762     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14763     *
14764     * This will enable the homogeneous mode where items are of the same size.
14765     * @see elm_toolbar_homogeneous_get()
14766     *
14767     * @ingroup Toolbar
14768     */
14769    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14770
14771    /**
14772     * Get whether the homogenous mode is enabled.
14773     *
14774     * @param obj The toolbar object.
14775     * @return Assume the items within the toolbar are of the same height
14776     * and width (EINA_TRUE = on, EINA_FALSE = off).
14777     *
14778     * @see elm_toolbar_homogeneous_set()
14779     *
14780     * @ingroup Toolbar
14781     */
14782    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14783
14784    /**
14785     * Enable/disable homogenous mode.
14786     *
14787     * @param obj The toolbar object
14788     * @param homogeneous Assume the items within the toolbar are of the
14789     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14790     *
14791     * This will enable the homogeneous mode where items are of the same size.
14792     * @see elm_toolbar_homogeneous_get()
14793     *
14794     * @deprecated use elm_toolbar_homogeneous_set() instead.
14795     *
14796     * @ingroup Toolbar
14797     */
14798    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14799
14800    /**
14801     * Get whether the homogenous mode is enabled.
14802     *
14803     * @param obj The toolbar object.
14804     * @return Assume the items within the toolbar are of the same height
14805     * and width (EINA_TRUE = on, EINA_FALSE = off).
14806     *
14807     * @see elm_toolbar_homogeneous_set()
14808     * @deprecated use elm_toolbar_homogeneous_get() instead.
14809     *
14810     * @ingroup Toolbar
14811     */
14812    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14813
14814    /**
14815     * Set the parent object of the toolbar items' menus.
14816     *
14817     * @param obj The toolbar object.
14818     * @param parent The parent of the menu objects.
14819     *
14820     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14821     *
14822     * For more details about setting the parent for toolbar menus, see
14823     * elm_menu_parent_set().
14824     *
14825     * @see elm_menu_parent_set() for details.
14826     * @see elm_toolbar_item_menu_set() for details.
14827     *
14828     * @ingroup Toolbar
14829     */
14830    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14831
14832    /**
14833     * Get the parent object of the toolbar items' menus.
14834     *
14835     * @param obj The toolbar object.
14836     * @return The parent of the menu objects.
14837     *
14838     * @see elm_toolbar_menu_parent_set() for details.
14839     *
14840     * @ingroup Toolbar
14841     */
14842    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14843
14844    /**
14845     * Set the alignment of the items.
14846     *
14847     * @param obj The toolbar object.
14848     * @param align The new alignment, a float between <tt> 0.0 </tt>
14849     * and <tt> 1.0 </tt>.
14850     *
14851     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14852     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14853     * items.
14854     *
14855     * Centered items by default.
14856     *
14857     * @see elm_toolbar_align_get()
14858     *
14859     * @ingroup Toolbar
14860     */
14861    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14862
14863    /**
14864     * Get the alignment of the items.
14865     *
14866     * @param obj The toolbar object.
14867     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14868     * <tt> 1.0 </tt>.
14869     *
14870     * @see elm_toolbar_align_set() for details.
14871     *
14872     * @ingroup Toolbar
14873     */
14874    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14875
14876    /**
14877     * Set whether the toolbar item opens a menu.
14878     *
14879     * @param item The toolbar item.
14880     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14881     *
14882     * A toolbar item can be set to be a menu, using this function.
14883     *
14884     * Once it is set to be a menu, it can be manipulated through the
14885     * menu-like function elm_toolbar_menu_parent_set() and the other
14886     * elm_menu functions, using the Evas_Object @c menu returned by
14887     * elm_toolbar_item_menu_get().
14888     *
14889     * So, items to be displayed in this item's menu should be added with
14890     * elm_menu_item_add().
14891     *
14892     * The following code exemplifies the most basic usage:
14893     * @code
14894     * tb = elm_toolbar_add(win)
14895     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14896     * elm_toolbar_item_menu_set(item, EINA_TRUE);
14897     * elm_toolbar_menu_parent_set(tb, win);
14898     * menu = elm_toolbar_item_menu_get(item);
14899     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14900     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14901     * NULL);
14902     * @endcode
14903     *
14904     * @see elm_toolbar_item_menu_get()
14905     *
14906     * @ingroup Toolbar
14907     */
14908    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14909
14910    /**
14911     * Get toolbar item's menu.
14912     *
14913     * @param item The toolbar item.
14914     * @return Item's menu object or @c NULL on failure.
14915     *
14916     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14917     * this function will set it.
14918     *
14919     * @see elm_toolbar_item_menu_set() for details.
14920     *
14921     * @ingroup Toolbar
14922     */
14923    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14924
14925    /**
14926     * Add a new state to @p item.
14927     *
14928     * @param item The item.
14929     * @param icon A string with icon name or the absolute path of an image file.
14930     * @param label The label of the new state.
14931     * @param func The function to call when the item is clicked when this
14932     * state is selected.
14933     * @param data The data to associate with the state.
14934     * @return The toolbar item state, or @c NULL upon failure.
14935     *
14936     * Toolbar will load icon image from fdo or current theme.
14937     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14938     * If an absolute path is provided it will load it direct from a file.
14939     *
14940     * States created with this function can be removed with
14941     * elm_toolbar_item_state_del().
14942     *
14943     * @see elm_toolbar_item_state_del()
14944     * @see elm_toolbar_item_state_sel()
14945     * @see elm_toolbar_item_state_get()
14946     *
14947     * @ingroup Toolbar
14948     */
14949    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);
14950
14951    /**
14952     * Delete a previoulsy added state to @p item.
14953     *
14954     * @param item The toolbar item.
14955     * @param state The state to be deleted.
14956     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14957     *
14958     * @see elm_toolbar_item_state_add()
14959     */
14960    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14961
14962    /**
14963     * Set @p state as the current state of @p it.
14964     *
14965     * @param it The item.
14966     * @param state The state to use.
14967     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14968     *
14969     * If @p state is @c NULL, it won't select any state and the default item's
14970     * icon and label will be used. It's the same behaviour than
14971     * elm_toolbar_item_state_unser().
14972     *
14973     * @see elm_toolbar_item_state_unset()
14974     *
14975     * @ingroup Toolbar
14976     */
14977    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14978
14979    /**
14980     * Unset the state of @p it.
14981     *
14982     * @param it The item.
14983     *
14984     * The default icon and label from this item will be displayed.
14985     *
14986     * @see elm_toolbar_item_state_set() for more details.
14987     *
14988     * @ingroup Toolbar
14989     */
14990    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14991
14992    /**
14993     * Get the current state of @p it.
14994     *
14995     * @param item The item.
14996     * @return The selected state or @c NULL if none is selected or on failure.
14997     *
14998     * @see elm_toolbar_item_state_set() for details.
14999     * @see elm_toolbar_item_state_unset()
15000     * @see elm_toolbar_item_state_add()
15001     *
15002     * @ingroup Toolbar
15003     */
15004    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15005
15006    /**
15007     * Get the state after selected state in toolbar's @p item.
15008     *
15009     * @param it The toolbar item to change state.
15010     * @return The state after current state, or @c NULL on failure.
15011     *
15012     * If last state is selected, this function will return first state.
15013     *
15014     * @see elm_toolbar_item_state_set()
15015     * @see elm_toolbar_item_state_add()
15016     *
15017     * @ingroup Toolbar
15018     */
15019    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15020
15021    /**
15022     * Get the state before selected state in toolbar's @p item.
15023     *
15024     * @param it The toolbar item to change state.
15025     * @return The state before current state, or @c NULL on failure.
15026     *
15027     * If first state is selected, this function will return last state.
15028     *
15029     * @see elm_toolbar_item_state_set()
15030     * @see elm_toolbar_item_state_add()
15031     *
15032     * @ingroup Toolbar
15033     */
15034    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15035
15036    /**
15037     * Set the text to be shown in a given toolbar item's tooltips.
15038     *
15039     * @param item Target item.
15040     * @param text The text to set in the content.
15041     *
15042     * Setup the text as tooltip to object. The item can have only one tooltip,
15043     * so any previous tooltip data - set with this function or
15044     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15045     *
15046     * @see elm_object_tooltip_text_set() for more details.
15047     *
15048     * @ingroup Toolbar
15049     */
15050    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15051
15052    /**
15053     * Set the content to be shown in the tooltip item.
15054     *
15055     * Setup the tooltip to item. The item can have only one tooltip,
15056     * so any previous tooltip data is removed. @p func(with @p data) will
15057     * be called every time that need show the tooltip and it should
15058     * return a valid Evas_Object. This object is then managed fully by
15059     * tooltip system and is deleted when the tooltip is gone.
15060     *
15061     * @param item the toolbar item being attached a tooltip.
15062     * @param func the function used to create the tooltip contents.
15063     * @param data what to provide to @a func as callback data/context.
15064     * @param del_cb called when data is not needed anymore, either when
15065     *        another callback replaces @a func, the tooltip is unset with
15066     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15067     *        dies. This callback receives as the first parameter the
15068     *        given @a data, and @c event_info is the item.
15069     *
15070     * @see elm_object_tooltip_content_cb_set() for more details.
15071     *
15072     * @ingroup Toolbar
15073     */
15074    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);
15075
15076    /**
15077     * Unset tooltip from item.
15078     *
15079     * @param item toolbar item to remove previously set tooltip.
15080     *
15081     * Remove tooltip from item. The callback provided as del_cb to
15082     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15083     * it is not used anymore.
15084     *
15085     * @see elm_object_tooltip_unset() for more details.
15086     * @see elm_toolbar_item_tooltip_content_cb_set()
15087     *
15088     * @ingroup Toolbar
15089     */
15090    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15091
15092    /**
15093     * Sets a different style for this item tooltip.
15094     *
15095     * @note before you set a style you should define a tooltip with
15096     *       elm_toolbar_item_tooltip_content_cb_set() or
15097     *       elm_toolbar_item_tooltip_text_set()
15098     *
15099     * @param item toolbar item with tooltip already set.
15100     * @param style the theme style to use (default, transparent, ...)
15101     *
15102     * @see elm_object_tooltip_style_set() for more details.
15103     *
15104     * @ingroup Toolbar
15105     */
15106    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15107
15108    /**
15109     * Get the style for this item tooltip.
15110     *
15111     * @param item toolbar item with tooltip already set.
15112     * @return style the theme style in use, defaults to "default". If the
15113     *         object does not have a tooltip set, then NULL is returned.
15114     *
15115     * @see elm_object_tooltip_style_get() for more details.
15116     * @see elm_toolbar_item_tooltip_style_set()
15117     *
15118     * @ingroup Toolbar
15119     */
15120    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15121
15122    /**
15123     * Set the type of mouse pointer/cursor decoration to be shown,
15124     * when the mouse pointer is over the given toolbar widget item
15125     *
15126     * @param item toolbar item to customize cursor on
15127     * @param cursor the cursor type's name
15128     *
15129     * This function works analogously as elm_object_cursor_set(), but
15130     * here the cursor's changing area is restricted to the item's
15131     * area, and not the whole widget's. Note that that item cursors
15132     * have precedence over widget cursors, so that a mouse over an
15133     * item with custom cursor set will always show @b that cursor.
15134     *
15135     * If this function is called twice for an object, a previously set
15136     * cursor will be unset on the second call.
15137     *
15138     * @see elm_object_cursor_set()
15139     * @see elm_toolbar_item_cursor_get()
15140     * @see elm_toolbar_item_cursor_unset()
15141     *
15142     * @ingroup Toolbar
15143     */
15144    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15145
15146    /*
15147     * Get the type of mouse pointer/cursor decoration set to be shown,
15148     * when the mouse pointer is over the given toolbar widget item
15149     *
15150     * @param item toolbar item with custom cursor set
15151     * @return the cursor type's name or @c NULL, if no custom cursors
15152     * were set to @p item (and on errors)
15153     *
15154     * @see elm_object_cursor_get()
15155     * @see elm_toolbar_item_cursor_set()
15156     * @see elm_toolbar_item_cursor_unset()
15157     *
15158     * @ingroup Toolbar
15159     */
15160    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15161
15162    /**
15163     * Unset any custom mouse pointer/cursor decoration set to be
15164     * shown, when the mouse pointer is over the given toolbar widget
15165     * item, thus making it show the @b default cursor again.
15166     *
15167     * @param item a toolbar item
15168     *
15169     * Use this call to undo any custom settings on this item's cursor
15170     * decoration, bringing it back to defaults (no custom style set).
15171     *
15172     * @see elm_object_cursor_unset()
15173     * @see elm_toolbar_item_cursor_set()
15174     *
15175     * @ingroup Toolbar
15176     */
15177    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15178
15179    /**
15180     * Set a different @b style for a given custom cursor set for a
15181     * toolbar item.
15182     *
15183     * @param item toolbar item with custom cursor set
15184     * @param style the <b>theme style</b> to use (e.g. @c "default",
15185     * @c "transparent", etc)
15186     *
15187     * This function only makes sense when one is using custom mouse
15188     * cursor decorations <b>defined in a theme file</b>, which can have,
15189     * given a cursor name/type, <b>alternate styles</b> on it. It
15190     * works analogously as elm_object_cursor_style_set(), but here
15191     * applyed only to toolbar item objects.
15192     *
15193     * @warning Before you set a cursor style you should have definen a
15194     *       custom cursor previously on the item, with
15195     *       elm_toolbar_item_cursor_set()
15196     *
15197     * @see elm_toolbar_item_cursor_engine_only_set()
15198     * @see elm_toolbar_item_cursor_style_get()
15199     *
15200     * @ingroup Toolbar
15201     */
15202    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15203
15204    /**
15205     * Get the current @b style set for a given toolbar item's custom
15206     * cursor
15207     *
15208     * @param item toolbar item with custom cursor set.
15209     * @return style the cursor style in use. If the object does not
15210     *         have a cursor set, then @c NULL is returned.
15211     *
15212     * @see elm_toolbar_item_cursor_style_set() for more details
15213     *
15214     * @ingroup Toolbar
15215     */
15216    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15217
15218    /**
15219     * Set if the (custom)cursor for a given toolbar item should be
15220     * searched in its theme, also, or should only rely on the
15221     * rendering engine.
15222     *
15223     * @param item item with custom (custom) cursor already set on
15224     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15225     * only on those provided by the rendering engine, @c EINA_FALSE to
15226     * have them searched on the widget's theme, as well.
15227     *
15228     * @note This call is of use only if you've set a custom cursor
15229     * for toolbar items, with elm_toolbar_item_cursor_set().
15230     *
15231     * @note By default, cursors will only be looked for between those
15232     * provided by the rendering engine.
15233     *
15234     * @ingroup Toolbar
15235     */
15236    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15237
15238    /**
15239     * Get if the (custom) cursor for a given toolbar item is being
15240     * searched in its theme, also, or is only relying on the rendering
15241     * engine.
15242     *
15243     * @param item a toolbar item
15244     * @return @c EINA_TRUE, if cursors are being looked for only on
15245     * those provided by the rendering engine, @c EINA_FALSE if they
15246     * are being searched on the widget's theme, as well.
15247     *
15248     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15249     *
15250     * @ingroup Toolbar
15251     */
15252    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15253
15254    /**
15255     * Change a toolbar's orientation
15256     * @param obj The toolbar object
15257     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15258     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15259     * @ingroup Toolbar
15260     */
15261    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15262
15263    /**
15264     * Get a toolbar's orientation
15265     * @param obj The toolbar object
15266     * @return If @c EINA_TRUE, the toolbar is vertical
15267     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15268     * @ingroup Toolbar
15269     */
15270    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15271
15272    /**
15273     * @}
15274     */
15275
15276    /**
15277     * @defgroup Tooltips Tooltips
15278     *
15279     * The Tooltip is an (internal, for now) smart object used to show a
15280     * content in a frame on mouse hover of objects(or widgets), with
15281     * tips/information about them.
15282     *
15283     * @{
15284     */
15285
15286    EAPI double       elm_tooltip_delay_get(void);
15287    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15288    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15289    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15290    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15291    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);
15292    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15293    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15294    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15295    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15296    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15297
15298    /**
15299     * @}
15300     */
15301
15302    /**
15303     * @defgroup Cursors Cursors
15304     *
15305     * The Elementary cursor is an internal smart object used to
15306     * customize the mouse cursor displayed over objects (or
15307     * widgets). In the most common scenario, the cursor decoration
15308     * comes from the graphical @b engine Elementary is running
15309     * on. Those engines may provide different decorations for cursors,
15310     * and Elementary provides functions to choose them (think of X11
15311     * cursors, as an example).
15312     *
15313     * There's also the possibility of, besides using engine provided
15314     * cursors, also use ones coming from Edje theming files. Both
15315     * globally and per widget, Elementary makes it possible for one to
15316     * make the cursors lookup to be held on engines only or on
15317     * Elementary's theme file, too.
15318     *
15319     * @{
15320     */
15321
15322    /**
15323     * Set the cursor to be shown when mouse is over the object
15324     *
15325     * Set the cursor that will be displayed when mouse is over the
15326     * object. The object can have only one cursor set to it, so if
15327     * this function is called twice for an object, the previous set
15328     * will be unset.
15329     * If using X cursors, a definition of all the valid cursor names
15330     * is listed on Elementary_Cursors.h. If an invalid name is set
15331     * the default cursor will be used.
15332     *
15333     * @param obj the object being set a cursor.
15334     * @param cursor the cursor name to be used.
15335     *
15336     * @ingroup Cursors
15337     */
15338    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15339
15340    /**
15341     * Get the cursor to be shown when mouse is over the object
15342     *
15343     * @param obj an object with cursor already set.
15344     * @return the cursor name.
15345     *
15346     * @ingroup Cursors
15347     */
15348    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15349
15350    /**
15351     * Unset cursor for object
15352     *
15353     * Unset cursor for object, and set the cursor to default if the mouse
15354     * was over this object.
15355     *
15356     * @param obj Target object
15357     * @see elm_object_cursor_set()
15358     *
15359     * @ingroup Cursors
15360     */
15361    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15362
15363    /**
15364     * Sets a different style for this object cursor.
15365     *
15366     * @note before you set a style you should define a cursor with
15367     *       elm_object_cursor_set()
15368     *
15369     * @param obj an object with cursor already set.
15370     * @param style the theme style to use (default, transparent, ...)
15371     *
15372     * @ingroup Cursors
15373     */
15374    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15375
15376    /**
15377     * Get the style for this object cursor.
15378     *
15379     * @param obj an object with cursor already set.
15380     * @return style the theme style in use, defaults to "default". If the
15381     *         object does not have a cursor set, then NULL is returned.
15382     *
15383     * @ingroup Cursors
15384     */
15385    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15386
15387    /**
15388     * Set if the cursor set should be searched on the theme or should use
15389     * the provided by the engine, only.
15390     *
15391     * @note before you set if should look on theme you should define a cursor
15392     * with elm_object_cursor_set(). By default it will only look for cursors
15393     * provided by the engine.
15394     *
15395     * @param obj an object with cursor already set.
15396     * @param engine_only boolean to define it cursors should be looked only
15397     * between the provided by the engine or searched on widget's theme as well.
15398     *
15399     * @ingroup Cursors
15400     */
15401    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15402
15403    /**
15404     * Get the cursor engine only usage for this object cursor.
15405     *
15406     * @param obj an object with cursor already set.
15407     * @return engine_only boolean to define it cursors should be
15408     * looked only between the provided by the engine or searched on
15409     * widget's theme as well. If the object does not have a cursor
15410     * set, then EINA_FALSE is returned.
15411     *
15412     * @ingroup Cursors
15413     */
15414    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15415
15416    /**
15417     * Get the configured cursor engine only usage
15418     *
15419     * This gets the globally configured exclusive usage of engine cursors.
15420     *
15421     * @return 1 if only engine cursors should be used
15422     * @ingroup Cursors
15423     */
15424    EAPI int          elm_cursor_engine_only_get(void);
15425
15426    /**
15427     * Set the configured cursor engine only usage
15428     *
15429     * This sets the globally configured exclusive usage of engine cursors.
15430     * It won't affect cursors set before changing this value.
15431     *
15432     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15433     * look for them on theme before.
15434     * @return EINA_TRUE if value is valid and setted (0 or 1)
15435     * @ingroup Cursors
15436     */
15437    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15438
15439    /**
15440     * @}
15441     */
15442
15443    /**
15444     * @defgroup Menu Menu
15445     *
15446     * @image html img/widget/menu/preview-00.png
15447     * @image latex img/widget/menu/preview-00.eps
15448     *
15449     * A menu is a list of items displayed above its parent. When the menu is
15450     * showing its parent is darkened. Each item can have a sub-menu. The menu
15451     * object can be used to display a menu on a right click event, in a toolbar,
15452     * anywhere.
15453     *
15454     * Signals that you can add callbacks for are:
15455     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15456     *             event_info is NULL.
15457     *
15458     * @see @ref tutorial_menu
15459     * @{
15460     */
15461    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15462    /**
15463     * @brief Add a new menu to the parent
15464     *
15465     * @param parent The parent object.
15466     * @return The new object or NULL if it cannot be created.
15467     */
15468    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15469    /**
15470     * @brief Set the parent for the given menu widget
15471     *
15472     * @param obj The menu object.
15473     * @param parent The new parent.
15474     */
15475    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15476    /**
15477     * @brief Get the parent for the given menu widget
15478     *
15479     * @param obj The menu object.
15480     * @return The parent.
15481     *
15482     * @see elm_menu_parent_set()
15483     */
15484    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15485    /**
15486     * @brief Move the menu to a new position
15487     *
15488     * @param obj The menu object.
15489     * @param x The new position.
15490     * @param y The new position.
15491     *
15492     * Sets the top-left position of the menu to (@p x,@p y).
15493     *
15494     * @note @p x and @p y coordinates are relative to parent.
15495     */
15496    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15497    /**
15498     * @brief Close a opened menu
15499     *
15500     * @param obj the menu object
15501     * @return void
15502     *
15503     * Hides the menu and all it's sub-menus.
15504     */
15505    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15506    /**
15507     * @brief Returns a list of @p item's items.
15508     *
15509     * @param obj The menu object
15510     * @return An Eina_List* of @p item's items
15511     */
15512    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15513    /**
15514     * @brief Get the Evas_Object of an Elm_Menu_Item
15515     *
15516     * @param item The menu item object.
15517     * @return The edje object containing the swallowed content
15518     *
15519     * @warning Don't manipulate this object!
15520     */
15521    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15522    /**
15523     * @brief Add an item at the end of the given menu widget
15524     *
15525     * @param obj The menu object.
15526     * @param parent The parent menu item (optional)
15527     * @param icon A icon display on the item. The icon will be destryed by the menu.
15528     * @param label The label of the item.
15529     * @param func Function called when the user select the item.
15530     * @param data Data sent by the callback.
15531     * @return Returns the new item.
15532     */
15533    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);
15534    /**
15535     * @brief Add an object swallowed in an item at the end of the given menu
15536     * widget
15537     *
15538     * @param obj The menu object.
15539     * @param parent The parent menu item (optional)
15540     * @param subobj The object to swallow
15541     * @param func Function called when the user select the item.
15542     * @param data Data sent by the callback.
15543     * @return Returns the new item.
15544     *
15545     * Add an evas object as an item to the menu.
15546     */
15547    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);
15548    /**
15549     * @brief Set the label of a menu item
15550     *
15551     * @param item The menu item object.
15552     * @param label The label to set for @p item
15553     *
15554     * @warning Don't use this funcion on items created with
15555     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15556     */
15557    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15558    /**
15559     * @brief Get the label of a menu item
15560     *
15561     * @param item The menu item object.
15562     * @return The label of @p item
15563     */
15564    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15565    /**
15566     * @brief Set the icon of a menu item to the standard icon with name @p icon
15567     *
15568     * @param item The menu item object.
15569     * @param icon The icon object to set for the content of @p item
15570     *
15571     * Once this icon is set, any previously set icon will be deleted.
15572     */
15573    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15574    /**
15575     * @brief Get the string representation from the icon of a menu item
15576     *
15577     * @param item The menu item object.
15578     * @return The string representation of @p item's icon or NULL
15579     *
15580     * @see elm_menu_item_object_icon_name_set()
15581     */
15582    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15583    /**
15584     * @brief Set the content object of a menu item
15585     *
15586     * @param item The menu item object
15587     * @param The content object or NULL
15588     * @return EINA_TRUE on success, else EINA_FALSE
15589     *
15590     * Use this function to change the object swallowed by a menu item, deleting
15591     * any previously swallowed object.
15592     */
15593    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15594    /**
15595     * @brief Get the content object of a menu item
15596     *
15597     * @param item The menu item object
15598     * @return The content object or NULL
15599     * @note If @p item was added with elm_menu_item_add_object, this
15600     * function will return the object passed, else it will return the
15601     * icon object.
15602     *
15603     * @see elm_menu_item_object_content_set()
15604     */
15605    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15606    /**
15607     * @brief Set the selected state of @p item.
15608     *
15609     * @param item The menu item object.
15610     * @param selected The selected/unselected state of the item
15611     */
15612    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15613    /**
15614     * @brief Get the selected state of @p item.
15615     *
15616     * @param item The menu item object.
15617     * @return The selected/unselected state of the item
15618     *
15619     * @see elm_menu_item_selected_set()
15620     */
15621    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15622    /**
15623     * @brief Set the disabled state of @p item.
15624     *
15625     * @param item The menu item object.
15626     * @param disabled The enabled/disabled state of the item
15627     */
15628    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15629    /**
15630     * @brief Get the disabled state of @p item.
15631     *
15632     * @param item The menu item object.
15633     * @return The enabled/disabled state of the item
15634     *
15635     * @see elm_menu_item_disabled_set()
15636     */
15637    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15638    /**
15639     * @brief Add a separator item to menu @p obj under @p parent.
15640     *
15641     * @param obj The menu object
15642     * @param parent The item to add the separator under
15643     * @return The created item or NULL on failure
15644     *
15645     * This is item is a @ref Separator.
15646     */
15647    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15648    /**
15649     * @brief Returns whether @p item is a separator.
15650     *
15651     * @param item The item to check
15652     * @return If true, @p item is a separator
15653     *
15654     * @see elm_menu_item_separator_add()
15655     */
15656    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15657    /**
15658     * @brief Deletes an item from the menu.
15659     *
15660     * @param item The item to delete.
15661     *
15662     * @see elm_menu_item_add()
15663     */
15664    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15665    /**
15666     * @brief Set the function called when a menu item is deleted.
15667     *
15668     * @param item The item to set the callback on
15669     * @param func The function called
15670     *
15671     * @see elm_menu_item_add()
15672     * @see elm_menu_item_del()
15673     */
15674    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15675    /**
15676     * @brief Returns the data associated with menu item @p item.
15677     *
15678     * @param item The item
15679     * @return The data associated with @p item or NULL if none was set.
15680     *
15681     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15682     */
15683    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15684    /**
15685     * @brief Sets the data to be associated with menu item @p item.
15686     *
15687     * @param item The item
15688     * @param data The data to be associated with @p item
15689     */
15690    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15691    /**
15692     * @brief Returns a list of @p item's subitems.
15693     *
15694     * @param item The item
15695     * @return An Eina_List* of @p item's subitems
15696     *
15697     * @see elm_menu_add()
15698     */
15699    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15700    /**
15701     * @brief Get the position of a menu item
15702     *
15703     * @param item The menu item
15704     * @return The item's index
15705     *
15706     * This function returns the index position of a menu item in a menu.
15707     * For a sub-menu, this number is relative to the first item in the sub-menu.
15708     *
15709     * @note Index values begin with 0
15710     */
15711    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15712    /**
15713     * @brief @brief Return a menu item's owner menu
15714     *
15715     * @param item The menu item
15716     * @return The menu object owning @p item, or NULL on failure
15717     *
15718     * Use this function to get the menu object owning an item.
15719     */
15720    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15721    /**
15722     * @brief Get the selected item in the menu
15723     *
15724     * @param obj The menu object
15725     * @return The selected item, or NULL if none
15726     *
15727     * @see elm_menu_item_selected_get()
15728     * @see elm_menu_item_selected_set()
15729     */
15730    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15731    /**
15732     * @brief Get the last item in the menu
15733     *
15734     * @param obj The menu object
15735     * @return The last item, or NULL if none
15736     */
15737    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15738    /**
15739     * @brief Get the first item in the menu
15740     *
15741     * @param obj The menu object
15742     * @return The first item, or NULL if none
15743     */
15744    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15745    /**
15746     * @brief Get the next item in the menu.
15747     *
15748     * @param item The menu item object.
15749     * @return The item after it, or NULL if none
15750     */
15751    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15752    /**
15753     * @brief Get the previous item in the menu.
15754     *
15755     * @param item The menu item object.
15756     * @return The item before it, or NULL if none
15757     */
15758    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15759    /**
15760     * @}
15761     */
15762
15763    /**
15764     * @defgroup List List
15765     * @ingroup Elementary
15766     *
15767     * @image html img/widget/list/preview-00.png
15768     * @image latex img/widget/list/preview-00.eps width=\textwidth
15769     *
15770     * @image html img/list.png
15771     * @image latex img/list.eps width=\textwidth
15772     *
15773     * A list widget is a container whose children are displayed vertically or
15774     * horizontally, in order, and can be selected.
15775     * The list can accept only one or multiple items selection. Also has many
15776     * modes of items displaying.
15777     *
15778     * A list is a very simple type of list widget.  For more robust
15779     * lists, @ref Genlist should probably be used.
15780     *
15781     * Smart callbacks one can listen to:
15782     * - @c "activated" - The user has double-clicked or pressed
15783     *   (enter|return|spacebar) on an item. The @c event_info parameter
15784     *   is the item that was activated.
15785     * - @c "clicked,double" - The user has double-clicked an item.
15786     *   The @c event_info parameter is the item that was double-clicked.
15787     * - "selected" - when the user selected an item
15788     * - "unselected" - when the user unselected an item
15789     * - "longpressed" - an item in the list is long-pressed
15790     * - "scroll,edge,top" - the list is scrolled until the top edge
15791     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
15792     * - "scroll,edge,left" - the list is scrolled until the left edge
15793     * - "scroll,edge,right" - the list is scrolled until the right edge
15794     *
15795     * Available styles for it:
15796     * - @c "default"
15797     *
15798     * List of examples:
15799     * @li @ref list_example_01
15800     * @li @ref list_example_02
15801     * @li @ref list_example_03
15802     */
15803
15804    /**
15805     * @addtogroup List
15806     * @{
15807     */
15808
15809    /**
15810     * @enum _Elm_List_Mode
15811     * @typedef Elm_List_Mode
15812     *
15813     * Set list's resize behavior, transverse axis scroll and
15814     * items cropping. See each mode's description for more details.
15815     *
15816     * @note Default value is #ELM_LIST_SCROLL.
15817     *
15818     * Values <b> don't </b> work as bitmask, only one can be choosen.
15819     *
15820     * @see elm_list_mode_set()
15821     * @see elm_list_mode_get()
15822     *
15823     * @ingroup List
15824     */
15825    typedef enum _Elm_List_Mode
15826      {
15827         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. */
15828         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). */
15829         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. */
15830         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. */
15831         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15832      } Elm_List_Mode;
15833
15834    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().  */
15835
15836    /**
15837     * Add a new list widget to the given parent Elementary
15838     * (container) object.
15839     *
15840     * @param parent The parent object.
15841     * @return a new list widget handle or @c NULL, on errors.
15842     *
15843     * This function inserts a new list widget on the canvas.
15844     *
15845     * @ingroup List
15846     */
15847    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15848
15849    /**
15850     * Starts the list.
15851     *
15852     * @param obj The list object
15853     *
15854     * @note Call before running show() on the list object.
15855     * @warning If not called, it won't display the list properly.
15856     *
15857     * @code
15858     * li = elm_list_add(win);
15859     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15860     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15861     * elm_list_go(li);
15862     * evas_object_show(li);
15863     * @endcode
15864     *
15865     * @ingroup List
15866     */
15867    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15868
15869    /**
15870     * Enable or disable multiple items selection on the list object.
15871     *
15872     * @param obj The list object
15873     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15874     * disable it.
15875     *
15876     * Disabled by default. If disabled, the user can select a single item of
15877     * the list each time. Selected items are highlighted on list.
15878     * If enabled, many items can be selected.
15879     *
15880     * If a selected item is selected again, it will be unselected.
15881     *
15882     * @see elm_list_multi_select_get()
15883     *
15884     * @ingroup List
15885     */
15886    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15887
15888    /**
15889     * Get a value whether multiple items selection is enabled or not.
15890     *
15891     * @see elm_list_multi_select_set() for details.
15892     *
15893     * @param obj The list object.
15894     * @return @c EINA_TRUE means multiple items selection is enabled.
15895     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15896     * @c EINA_FALSE is returned.
15897     *
15898     * @ingroup List
15899     */
15900    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15901
15902    /**
15903     * Set which mode to use for the list object.
15904     *
15905     * @param obj The list object
15906     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15907     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15908     *
15909     * Set list's resize behavior, transverse axis scroll and
15910     * items cropping. See each mode's description for more details.
15911     *
15912     * @note Default value is #ELM_LIST_SCROLL.
15913     *
15914     * Only one can be set, if a previous one was set, it will be changed
15915     * by the new mode set. Bitmask won't work as well.
15916     *
15917     * @see elm_list_mode_get()
15918     *
15919     * @ingroup List
15920     */
15921    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15922
15923    /**
15924     * Get the mode the list is at.
15925     *
15926     * @param obj The list object
15927     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15928     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15929     *
15930     * @note see elm_list_mode_set() for more information.
15931     *
15932     * @ingroup List
15933     */
15934    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15935
15936    /**
15937     * Enable or disable horizontal mode on the list object.
15938     *
15939     * @param obj The list object.
15940     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15941     * disable it, i.e., to enable vertical mode.
15942     *
15943     * @note Vertical mode is set by default.
15944     *
15945     * On horizontal mode items are displayed on list from left to right,
15946     * instead of from top to bottom. Also, the list will scroll horizontally.
15947     * Each item will presents left icon on top and right icon, or end, at
15948     * the bottom.
15949     *
15950     * @see elm_list_horizontal_get()
15951     *
15952     * @ingroup List
15953     */
15954    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15955
15956    /**
15957     * Get a value whether horizontal mode is enabled or not.
15958     *
15959     * @param obj The list object.
15960     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15961     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15962     * @c EINA_FALSE is returned.
15963     *
15964     * @see elm_list_horizontal_set() for details.
15965     *
15966     * @ingroup List
15967     */
15968    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15969
15970    /**
15971     * Enable or disable always select mode on the list object.
15972     *
15973     * @param obj The list object
15974     * @param always_select @c EINA_TRUE to enable always select mode or
15975     * @c EINA_FALSE to disable it.
15976     *
15977     * @note Always select mode is disabled by default.
15978     *
15979     * Default behavior of list items is to only call its callback function
15980     * the first time it's pressed, i.e., when it is selected. If a selected
15981     * item is pressed again, and multi-select is disabled, it won't call
15982     * this function (if multi-select is enabled it will unselect the item).
15983     *
15984     * If always select is enabled, it will call the callback function
15985     * everytime a item is pressed, so it will call when the item is selected,
15986     * and again when a selected item is pressed.
15987     *
15988     * @see elm_list_always_select_mode_get()
15989     * @see elm_list_multi_select_set()
15990     *
15991     * @ingroup List
15992     */
15993    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15994
15995    /**
15996     * Get a value whether always select mode is enabled or not, meaning that
15997     * an item will always call its callback function, even if already selected.
15998     *
15999     * @param obj The list object
16000     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16001     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16002     * @c EINA_FALSE is returned.
16003     *
16004     * @see elm_list_always_select_mode_set() for details.
16005     *
16006     * @ingroup List
16007     */
16008    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16009
16010    /**
16011     * Set bouncing behaviour when the scrolled content reaches an edge.
16012     *
16013     * Tell the internal scroller object whether it should bounce or not
16014     * when it reaches the respective edges for each axis.
16015     *
16016     * @param obj The list object
16017     * @param h_bounce Whether to bounce or not in the horizontal axis.
16018     * @param v_bounce Whether to bounce or not in the vertical axis.
16019     *
16020     * @see elm_scroller_bounce_set()
16021     *
16022     * @ingroup List
16023     */
16024    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16025
16026    /**
16027     * Get the bouncing behaviour of the internal scroller.
16028     *
16029     * Get whether the internal scroller should bounce when the edge of each
16030     * axis is reached scrolling.
16031     *
16032     * @param obj The list object.
16033     * @param h_bounce Pointer where to store the bounce state of the horizontal
16034     * axis.
16035     * @param v_bounce Pointer where to store the bounce state of the vertical
16036     * axis.
16037     *
16038     * @see elm_scroller_bounce_get()
16039     * @see elm_list_bounce_set()
16040     *
16041     * @ingroup List
16042     */
16043    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16044
16045    /**
16046     * Set the scrollbar policy.
16047     *
16048     * @param obj The list object
16049     * @param policy_h Horizontal scrollbar policy.
16050     * @param policy_v Vertical scrollbar policy.
16051     *
16052     * This sets the scrollbar visibility policy for the given scroller.
16053     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16054     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16055     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16056     * This applies respectively for the horizontal and vertical scrollbars.
16057     *
16058     * The both are disabled by default, i.e., are set to
16059     * #ELM_SCROLLER_POLICY_OFF.
16060     *
16061     * @ingroup List
16062     */
16063    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16064
16065    /**
16066     * Get the scrollbar policy.
16067     *
16068     * @see elm_list_scroller_policy_get() for details.
16069     *
16070     * @param obj The list object.
16071     * @param policy_h Pointer where to store horizontal scrollbar policy.
16072     * @param policy_v Pointer where to store vertical scrollbar policy.
16073     *
16074     * @ingroup List
16075     */
16076    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);
16077
16078    /**
16079     * Append a new item to the list object.
16080     *
16081     * @param obj The list object.
16082     * @param label The label of the list item.
16083     * @param icon The icon object to use for the left side of the item. An
16084     * icon can be any Evas object, but usually it is an icon created
16085     * with elm_icon_add().
16086     * @param end The icon object to use for the right side of the item. An
16087     * icon can be any Evas object.
16088     * @param func The function to call when the item is clicked.
16089     * @param data The data to associate with the item for related callbacks.
16090     *
16091     * @return The created item or @c NULL upon failure.
16092     *
16093     * A new item will be created and appended to the list, i.e., will
16094     * be set as @b last item.
16095     *
16096     * Items created with this method can be deleted with
16097     * elm_list_item_del().
16098     *
16099     * Associated @p data can be properly freed when item is deleted if a
16100     * callback function is set with elm_list_item_del_cb_set().
16101     *
16102     * If a function is passed as argument, it will be called everytime this item
16103     * is selected, i.e., the user clicks over an unselected item.
16104     * If always select is enabled it will call this function every time
16105     * user clicks over an item (already selected or not).
16106     * If such function isn't needed, just passing
16107     * @c NULL as @p func is enough. The same should be done for @p data.
16108     *
16109     * Simple example (with no function callback or data associated):
16110     * @code
16111     * li = elm_list_add(win);
16112     * ic = elm_icon_add(win);
16113     * elm_icon_file_set(ic, "path/to/image", NULL);
16114     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16115     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16116     * elm_list_go(li);
16117     * evas_object_show(li);
16118     * @endcode
16119     *
16120     * @see elm_list_always_select_mode_set()
16121     * @see elm_list_item_del()
16122     * @see elm_list_item_del_cb_set()
16123     * @see elm_list_clear()
16124     * @see elm_icon_add()
16125     *
16126     * @ingroup List
16127     */
16128    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);
16129
16130    /**
16131     * Prepend a new item to the list object.
16132     *
16133     * @param obj The list object.
16134     * @param label The label of the list item.
16135     * @param icon The icon object to use for the left side of the item. An
16136     * icon can be any Evas object, but usually it is an icon created
16137     * with elm_icon_add().
16138     * @param end The icon object to use for the right side of the item. An
16139     * icon can be any Evas object.
16140     * @param func The function to call when the item is clicked.
16141     * @param data The data to associate with the item for related callbacks.
16142     *
16143     * @return The created item or @c NULL upon failure.
16144     *
16145     * A new item will be created and prepended to the list, i.e., will
16146     * be set as @b first item.
16147     *
16148     * Items created with this method can be deleted with
16149     * elm_list_item_del().
16150     *
16151     * Associated @p data can be properly freed when item is deleted if a
16152     * callback function is set with elm_list_item_del_cb_set().
16153     *
16154     * If a function is passed as argument, it will be called everytime this item
16155     * is selected, i.e., the user clicks over an unselected item.
16156     * If always select is enabled it will call this function every time
16157     * user clicks over an item (already selected or not).
16158     * If such function isn't needed, just passing
16159     * @c NULL as @p func is enough. The same should be done for @p data.
16160     *
16161     * @see elm_list_item_append() for a simple code example.
16162     * @see elm_list_always_select_mode_set()
16163     * @see elm_list_item_del()
16164     * @see elm_list_item_del_cb_set()
16165     * @see elm_list_clear()
16166     * @see elm_icon_add()
16167     *
16168     * @ingroup List
16169     */
16170    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);
16171
16172    /**
16173     * Insert a new item into the list object before item @p before.
16174     *
16175     * @param obj The list object.
16176     * @param before The list item to insert before.
16177     * @param label The label of the list item.
16178     * @param icon The icon object to use for the left side of the item. An
16179     * icon can be any Evas object, but usually it is an icon created
16180     * with elm_icon_add().
16181     * @param end The icon object to use for the right side of the item. An
16182     * icon can be any Evas object.
16183     * @param func The function to call when the item is clicked.
16184     * @param data The data to associate with the item for related callbacks.
16185     *
16186     * @return The created item or @c NULL upon failure.
16187     *
16188     * A new item will be created and added to the list. Its position in
16189     * this list will be just before item @p before.
16190     *
16191     * Items created with this method can be deleted with
16192     * elm_list_item_del().
16193     *
16194     * Associated @p data can be properly freed when item is deleted if a
16195     * callback function is set with elm_list_item_del_cb_set().
16196     *
16197     * If a function is passed as argument, it will be called everytime this item
16198     * is selected, i.e., the user clicks over an unselected item.
16199     * If always select is enabled it will call this function every time
16200     * user clicks over an item (already selected or not).
16201     * If such function isn't needed, just passing
16202     * @c NULL as @p func is enough. The same should be done for @p data.
16203     *
16204     * @see elm_list_item_append() for a simple code example.
16205     * @see elm_list_always_select_mode_set()
16206     * @see elm_list_item_del()
16207     * @see elm_list_item_del_cb_set()
16208     * @see elm_list_clear()
16209     * @see elm_icon_add()
16210     *
16211     * @ingroup List
16212     */
16213    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);
16214
16215    /**
16216     * Insert a new item into the list object after item @p after.
16217     *
16218     * @param obj The list object.
16219     * @param after The list item to insert after.
16220     * @param label The label of the list item.
16221     * @param icon The icon object to use for the left side of the item. An
16222     * icon can be any Evas object, but usually it is an icon created
16223     * with elm_icon_add().
16224     * @param end The icon object to use for the right side of the item. An
16225     * icon can be any Evas object.
16226     * @param func The function to call when the item is clicked.
16227     * @param data The data to associate with the item for related callbacks.
16228     *
16229     * @return The created item or @c NULL upon failure.
16230     *
16231     * A new item will be created and added to the list. Its position in
16232     * this list will be just after item @p after.
16233     *
16234     * Items created with this method can be deleted with
16235     * elm_list_item_del().
16236     *
16237     * Associated @p data can be properly freed when item is deleted if a
16238     * callback function is set with elm_list_item_del_cb_set().
16239     *
16240     * If a function is passed as argument, it will be called everytime this item
16241     * is selected, i.e., the user clicks over an unselected item.
16242     * If always select is enabled it will call this function every time
16243     * user clicks over an item (already selected or not).
16244     * If such function isn't needed, just passing
16245     * @c NULL as @p func is enough. The same should be done for @p data.
16246     *
16247     * @see elm_list_item_append() for a simple code example.
16248     * @see elm_list_always_select_mode_set()
16249     * @see elm_list_item_del()
16250     * @see elm_list_item_del_cb_set()
16251     * @see elm_list_clear()
16252     * @see elm_icon_add()
16253     *
16254     * @ingroup List
16255     */
16256    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);
16257
16258    /**
16259     * Insert a new item into the sorted list object.
16260     *
16261     * @param obj The list object.
16262     * @param label The label of the list item.
16263     * @param icon The icon object to use for the left side of the item. An
16264     * icon can be any Evas object, but usually it is an icon created
16265     * with elm_icon_add().
16266     * @param end The icon object to use for the right side of the item. An
16267     * icon can be any Evas object.
16268     * @param func The function to call when the item is clicked.
16269     * @param data The data to associate with the item for related callbacks.
16270     * @param cmp_func The comparing function to be used to sort list
16271     * items <b>by #Elm_List_Item item handles</b>. This function will
16272     * receive two items and compare them, returning a non-negative integer
16273     * if the second item should be place after the first, or negative value
16274     * if should be placed before.
16275     *
16276     * @return The created item or @c NULL upon failure.
16277     *
16278     * @note This function inserts values into a list object assuming it was
16279     * sorted and the result will be sorted.
16280     *
16281     * A new item will be created and added to the list. Its position in
16282     * this list will be found comparing the new item with previously inserted
16283     * items using function @p cmp_func.
16284     *
16285     * Items created with this method can be deleted with
16286     * elm_list_item_del().
16287     *
16288     * Associated @p data can be properly freed when item is deleted if a
16289     * callback function is set with elm_list_item_del_cb_set().
16290     *
16291     * If a function is passed as argument, it will be called everytime this item
16292     * is selected, i.e., the user clicks over an unselected item.
16293     * If always select is enabled it will call this function every time
16294     * user clicks over an item (already selected or not).
16295     * If such function isn't needed, just passing
16296     * @c NULL as @p func is enough. The same should be done for @p data.
16297     *
16298     * @see elm_list_item_append() for a simple code example.
16299     * @see elm_list_always_select_mode_set()
16300     * @see elm_list_item_del()
16301     * @see elm_list_item_del_cb_set()
16302     * @see elm_list_clear()
16303     * @see elm_icon_add()
16304     *
16305     * @ingroup List
16306     */
16307    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);
16308
16309    /**
16310     * Remove all list's items.
16311     *
16312     * @param obj The list object
16313     *
16314     * @see elm_list_item_del()
16315     * @see elm_list_item_append()
16316     *
16317     * @ingroup List
16318     */
16319    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16320
16321    /**
16322     * Get a list of all the list items.
16323     *
16324     * @param obj The list object
16325     * @return An @c Eina_List of list items, #Elm_List_Item,
16326     * or @c NULL on failure.
16327     *
16328     * @see elm_list_item_append()
16329     * @see elm_list_item_del()
16330     * @see elm_list_clear()
16331     *
16332     * @ingroup List
16333     */
16334    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16335
16336    /**
16337     * Get the selected item.
16338     *
16339     * @param obj The list object.
16340     * @return The selected list item.
16341     *
16342     * The selected item can be unselected with function
16343     * elm_list_item_selected_set().
16344     *
16345     * The selected item always will be highlighted on list.
16346     *
16347     * @see elm_list_selected_items_get()
16348     *
16349     * @ingroup List
16350     */
16351    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16352
16353    /**
16354     * Return a list of the currently selected list items.
16355     *
16356     * @param obj The list object.
16357     * @return An @c Eina_List of list items, #Elm_List_Item,
16358     * or @c NULL on failure.
16359     *
16360     * Multiple items can be selected if multi select is enabled. It can be
16361     * done with elm_list_multi_select_set().
16362     *
16363     * @see elm_list_selected_item_get()
16364     * @see elm_list_multi_select_set()
16365     *
16366     * @ingroup List
16367     */
16368    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16369
16370    /**
16371     * Set the selected state of an item.
16372     *
16373     * @param item The list item
16374     * @param selected The selected state
16375     *
16376     * This sets the selected state of the given item @p it.
16377     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16378     *
16379     * If a new item is selected the previosly selected will be unselected,
16380     * unless multiple selection is enabled with elm_list_multi_select_set().
16381     * Previoulsy selected item can be get with function
16382     * elm_list_selected_item_get().
16383     *
16384     * Selected items will be highlighted.
16385     *
16386     * @see elm_list_item_selected_get()
16387     * @see elm_list_selected_item_get()
16388     * @see elm_list_multi_select_set()
16389     *
16390     * @ingroup List
16391     */
16392    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16393
16394    /*
16395     * Get whether the @p item is selected or not.
16396     *
16397     * @param item The list item.
16398     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16399     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16400     *
16401     * @see elm_list_selected_item_set() for details.
16402     * @see elm_list_item_selected_get()
16403     *
16404     * @ingroup List
16405     */
16406    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16407
16408    /**
16409     * Set or unset item as a separator.
16410     *
16411     * @param it The list item.
16412     * @param setting @c EINA_TRUE to set item @p it as separator or
16413     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16414     *
16415     * Items aren't set as separator by default.
16416     *
16417     * If set as separator it will display separator theme, so won't display
16418     * icons or label.
16419     *
16420     * @see elm_list_item_separator_get()
16421     *
16422     * @ingroup List
16423     */
16424    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16425
16426    /**
16427     * Get a value whether item is a separator or not.
16428     *
16429     * @see elm_list_item_separator_set() for details.
16430     *
16431     * @param it The list item.
16432     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16433     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16434     *
16435     * @ingroup List
16436     */
16437    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16438
16439    /**
16440     * Show @p item in the list view.
16441     *
16442     * @param item The list item to be shown.
16443     *
16444     * It won't animate list until item is visible. If such behavior is wanted,
16445     * use elm_list_bring_in() intead.
16446     *
16447     * @ingroup List
16448     */
16449    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16450
16451    /**
16452     * Bring in the given item to list view.
16453     *
16454     * @param item The item.
16455     *
16456     * This causes list to jump to the given item @p item and show it
16457     * (by scrolling), if it is not fully visible.
16458     *
16459     * This may use animation to do so and take a period of time.
16460     *
16461     * If animation isn't wanted, elm_list_item_show() can be used.
16462     *
16463     * @ingroup List
16464     */
16465    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16466
16467    /**
16468     * Delete them item from the list.
16469     *
16470     * @param item The item of list to be deleted.
16471     *
16472     * If deleting all list items is required, elm_list_clear()
16473     * should be used instead of getting items list and deleting each one.
16474     *
16475     * @see elm_list_clear()
16476     * @see elm_list_item_append()
16477     * @see elm_list_item_del_cb_set()
16478     *
16479     * @ingroup List
16480     */
16481    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16482
16483    /**
16484     * Set the function called when a list item is freed.
16485     *
16486     * @param item The item to set the callback on
16487     * @param func The function called
16488     *
16489     * If there is a @p func, then it will be called prior item's memory release.
16490     * That will be called with the following arguments:
16491     * @li item's data;
16492     * @li item's Evas object;
16493     * @li item itself;
16494     *
16495     * This way, a data associated to a list item could be properly freed.
16496     *
16497     * @ingroup List
16498     */
16499    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16500
16501    /**
16502     * Get the data associated to the item.
16503     *
16504     * @param item The list item
16505     * @return The data associated to @p item
16506     *
16507     * The return value is a pointer to data associated to @p item when it was
16508     * created, with function elm_list_item_append() or similar. If no data
16509     * was passed as argument, it will return @c NULL.
16510     *
16511     * @see elm_list_item_append()
16512     *
16513     * @ingroup List
16514     */
16515    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16516
16517    /**
16518     * Get the left side icon associated to the item.
16519     *
16520     * @param item The list item
16521     * @return The left side icon associated to @p item
16522     *
16523     * The return value is a pointer to the icon associated to @p item when
16524     * it was
16525     * created, with function elm_list_item_append() or similar, or later
16526     * with function elm_list_item_icon_set(). If no icon
16527     * was passed as argument, it will return @c NULL.
16528     *
16529     * @see elm_list_item_append()
16530     * @see elm_list_item_icon_set()
16531     *
16532     * @ingroup List
16533     */
16534    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16535
16536    /**
16537     * Set the left side icon associated to the item.
16538     *
16539     * @param item The list item
16540     * @param icon The left side icon object to associate with @p item
16541     *
16542     * The icon object to use at left side of the item. An
16543     * icon can be any Evas object, but usually it is an icon created
16544     * with elm_icon_add().
16545     *
16546     * Once the icon object is set, a previously set one will be deleted.
16547     * @warning Setting the same icon for two items will cause the icon to
16548     * dissapear from the first item.
16549     *
16550     * If an icon was passed as argument on item creation, with function
16551     * elm_list_item_append() or similar, it will be already
16552     * associated to the item.
16553     *
16554     * @see elm_list_item_append()
16555     * @see elm_list_item_icon_get()
16556     *
16557     * @ingroup List
16558     */
16559    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16560
16561    /**
16562     * Get the right side icon associated to the item.
16563     *
16564     * @param item The list item
16565     * @return The right side icon associated to @p item
16566     *
16567     * The return value is a pointer to the icon associated to @p item when
16568     * it was
16569     * created, with function elm_list_item_append() or similar, or later
16570     * with function elm_list_item_icon_set(). If no icon
16571     * was passed as argument, it will return @c NULL.
16572     *
16573     * @see elm_list_item_append()
16574     * @see elm_list_item_icon_set()
16575     *
16576     * @ingroup List
16577     */
16578    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16579
16580    /**
16581     * Set the right side icon associated to the item.
16582     *
16583     * @param item The list item
16584     * @param end The right side icon object to associate with @p item
16585     *
16586     * The icon object to use at right side of the item. An
16587     * icon can be any Evas object, but usually it is an icon created
16588     * with elm_icon_add().
16589     *
16590     * Once the icon object is set, a previously set one will be deleted.
16591     * @warning Setting the same icon for two items will cause the icon to
16592     * dissapear from the first item.
16593     *
16594     * If an icon was passed as argument on item creation, with function
16595     * elm_list_item_append() or similar, it will be already
16596     * associated to the item.
16597     *
16598     * @see elm_list_item_append()
16599     * @see elm_list_item_end_get()
16600     *
16601     * @ingroup List
16602     */
16603    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16604
16605    /**
16606     * Gets the base object of the item.
16607     *
16608     * @param item The list item
16609     * @return The base object associated with @p item
16610     *
16611     * Base object is the @c Evas_Object that represents that item.
16612     *
16613     * @ingroup List
16614     */
16615    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16616    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16617
16618    /**
16619     * Get the label of item.
16620     *
16621     * @param item The item of list.
16622     * @return The label of item.
16623     *
16624     * The return value is a pointer to the label associated to @p item when
16625     * it was created, with function elm_list_item_append(), or later
16626     * with function elm_list_item_label_set. If no label
16627     * was passed as argument, it will return @c NULL.
16628     *
16629     * @see elm_list_item_label_set() for more details.
16630     * @see elm_list_item_append()
16631     *
16632     * @ingroup List
16633     */
16634    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16635
16636    /**
16637     * Set the label of item.
16638     *
16639     * @param item The item of list.
16640     * @param text The label of item.
16641     *
16642     * The label to be displayed by the item.
16643     * Label will be placed between left and right side icons (if set).
16644     *
16645     * If a label was passed as argument on item creation, with function
16646     * elm_list_item_append() or similar, it will be already
16647     * displayed by the item.
16648     *
16649     * @see elm_list_item_label_get()
16650     * @see elm_list_item_append()
16651     *
16652     * @ingroup List
16653     */
16654    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16655
16656
16657    /**
16658     * Get the item before @p it in list.
16659     *
16660     * @param it The list item.
16661     * @return The item before @p it, or @c NULL if none or on failure.
16662     *
16663     * @note If it is the first item, @c NULL will be returned.
16664     *
16665     * @see elm_list_item_append()
16666     * @see elm_list_items_get()
16667     *
16668     * @ingroup List
16669     */
16670    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16671
16672    /**
16673     * Get the item after @p it in list.
16674     *
16675     * @param it The list item.
16676     * @return The item after @p it, or @c NULL if none or on failure.
16677     *
16678     * @note If it is the last item, @c NULL will be returned.
16679     *
16680     * @see elm_list_item_append()
16681     * @see elm_list_items_get()
16682     *
16683     * @ingroup List
16684     */
16685    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16686
16687    /**
16688     * Sets the disabled/enabled state of a list item.
16689     *
16690     * @param it The item.
16691     * @param disabled The disabled state.
16692     *
16693     * A disabled item cannot be selected or unselected. It will also
16694     * change its appearance (generally greyed out). This sets the
16695     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16696     * enabled).
16697     *
16698     * @ingroup List
16699     */
16700    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16701
16702    /**
16703     * Get a value whether list item is disabled or not.
16704     *
16705     * @param it The item.
16706     * @return The disabled state.
16707     *
16708     * @see elm_list_item_disabled_set() for more details.
16709     *
16710     * @ingroup List
16711     */
16712    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16713
16714    /**
16715     * Set the text to be shown in a given list item's tooltips.
16716     *
16717     * @param item Target item.
16718     * @param text The text to set in the content.
16719     *
16720     * Setup the text as tooltip to object. The item can have only one tooltip,
16721     * so any previous tooltip data - set with this function or
16722     * elm_list_item_tooltip_content_cb_set() - is removed.
16723     *
16724     * @see elm_object_tooltip_text_set() for more details.
16725     *
16726     * @ingroup List
16727     */
16728    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16729
16730
16731    /**
16732     * @brief Disable size restrictions on an object's tooltip
16733     * @param item The tooltip's anchor object
16734     * @param disable If EINA_TRUE, size restrictions are disabled
16735     * @return EINA_FALSE on failure, EINA_TRUE on success
16736     *
16737     * This function allows a tooltip to expand beyond its parant window's canvas.
16738     * It will instead be limited only by the size of the display.
16739     */
16740    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16741    /**
16742     * @brief Retrieve size restriction state of an object's tooltip
16743     * @param obj The tooltip's anchor object
16744     * @return If EINA_TRUE, size restrictions are disabled
16745     *
16746     * This function returns whether a tooltip is allowed to expand beyond
16747     * its parant window's canvas.
16748     * It will instead be limited only by the size of the display.
16749     */
16750    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16751
16752    /**
16753     * Set the content to be shown in the tooltip item.
16754     *
16755     * Setup the tooltip to item. The item can have only one tooltip,
16756     * so any previous tooltip data is removed. @p func(with @p data) will
16757     * be called every time that need show the tooltip and it should
16758     * return a valid Evas_Object. This object is then managed fully by
16759     * tooltip system and is deleted when the tooltip is gone.
16760     *
16761     * @param item the list item being attached a tooltip.
16762     * @param func the function used to create the tooltip contents.
16763     * @param data what to provide to @a func as callback data/context.
16764     * @param del_cb called when data is not needed anymore, either when
16765     *        another callback replaces @a func, the tooltip is unset with
16766     *        elm_list_item_tooltip_unset() or the owner @a item
16767     *        dies. This callback receives as the first parameter the
16768     *        given @a data, and @c event_info is the item.
16769     *
16770     * @see elm_object_tooltip_content_cb_set() for more details.
16771     *
16772     * @ingroup List
16773     */
16774    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);
16775
16776    /**
16777     * Unset tooltip from item.
16778     *
16779     * @param item list item to remove previously set tooltip.
16780     *
16781     * Remove tooltip from item. The callback provided as del_cb to
16782     * elm_list_item_tooltip_content_cb_set() will be called to notify
16783     * it is not used anymore.
16784     *
16785     * @see elm_object_tooltip_unset() for more details.
16786     * @see elm_list_item_tooltip_content_cb_set()
16787     *
16788     * @ingroup List
16789     */
16790    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16791
16792    /**
16793     * Sets a different style for this item tooltip.
16794     *
16795     * @note before you set a style you should define a tooltip with
16796     *       elm_list_item_tooltip_content_cb_set() or
16797     *       elm_list_item_tooltip_text_set()
16798     *
16799     * @param item list item with tooltip already set.
16800     * @param style the theme style to use (default, transparent, ...)
16801     *
16802     * @see elm_object_tooltip_style_set() for more details.
16803     *
16804     * @ingroup List
16805     */
16806    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16807
16808    /**
16809     * Get the style for this item tooltip.
16810     *
16811     * @param item list item with tooltip already set.
16812     * @return style the theme style in use, defaults to "default". If the
16813     *         object does not have a tooltip set, then NULL is returned.
16814     *
16815     * @see elm_object_tooltip_style_get() for more details.
16816     * @see elm_list_item_tooltip_style_set()
16817     *
16818     * @ingroup List
16819     */
16820    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16821
16822    /**
16823     * Set the type of mouse pointer/cursor decoration to be shown,
16824     * when the mouse pointer is over the given list widget item
16825     *
16826     * @param item list item to customize cursor on
16827     * @param cursor the cursor type's name
16828     *
16829     * This function works analogously as elm_object_cursor_set(), but
16830     * here the cursor's changing area is restricted to the item's
16831     * area, and not the whole widget's. Note that that item cursors
16832     * have precedence over widget cursors, so that a mouse over an
16833     * item with custom cursor set will always show @b that cursor.
16834     *
16835     * If this function is called twice for an object, a previously set
16836     * cursor will be unset on the second call.
16837     *
16838     * @see elm_object_cursor_set()
16839     * @see elm_list_item_cursor_get()
16840     * @see elm_list_item_cursor_unset()
16841     *
16842     * @ingroup List
16843     */
16844    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16845
16846    /*
16847     * Get the type of mouse pointer/cursor decoration set to be shown,
16848     * when the mouse pointer is over the given list widget item
16849     *
16850     * @param item list item with custom cursor set
16851     * @return the cursor type's name or @c NULL, if no custom cursors
16852     * were set to @p item (and on errors)
16853     *
16854     * @see elm_object_cursor_get()
16855     * @see elm_list_item_cursor_set()
16856     * @see elm_list_item_cursor_unset()
16857     *
16858     * @ingroup List
16859     */
16860    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16861
16862    /**
16863     * Unset any custom mouse pointer/cursor decoration set to be
16864     * shown, when the mouse pointer is over the given list widget
16865     * item, thus making it show the @b default cursor again.
16866     *
16867     * @param item a list item
16868     *
16869     * Use this call to undo any custom settings on this item's cursor
16870     * decoration, bringing it back to defaults (no custom style set).
16871     *
16872     * @see elm_object_cursor_unset()
16873     * @see elm_list_item_cursor_set()
16874     *
16875     * @ingroup List
16876     */
16877    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16878
16879    /**
16880     * Set a different @b style for a given custom cursor set for a
16881     * list item.
16882     *
16883     * @param item list item with custom cursor set
16884     * @param style the <b>theme style</b> to use (e.g. @c "default",
16885     * @c "transparent", etc)
16886     *
16887     * This function only makes sense when one is using custom mouse
16888     * cursor decorations <b>defined in a theme file</b>, which can have,
16889     * given a cursor name/type, <b>alternate styles</b> on it. It
16890     * works analogously as elm_object_cursor_style_set(), but here
16891     * applyed only to list item objects.
16892     *
16893     * @warning Before you set a cursor style you should have definen a
16894     *       custom cursor previously on the item, with
16895     *       elm_list_item_cursor_set()
16896     *
16897     * @see elm_list_item_cursor_engine_only_set()
16898     * @see elm_list_item_cursor_style_get()
16899     *
16900     * @ingroup List
16901     */
16902    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16903
16904    /**
16905     * Get the current @b style set for a given list item's custom
16906     * cursor
16907     *
16908     * @param item list item with custom cursor set.
16909     * @return style the cursor style in use. If the object does not
16910     *         have a cursor set, then @c NULL is returned.
16911     *
16912     * @see elm_list_item_cursor_style_set() for more details
16913     *
16914     * @ingroup List
16915     */
16916    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16917
16918    /**
16919     * Set if the (custom)cursor for a given list item should be
16920     * searched in its theme, also, or should only rely on the
16921     * rendering engine.
16922     *
16923     * @param item item with custom (custom) cursor already set on
16924     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16925     * only on those provided by the rendering engine, @c EINA_FALSE to
16926     * have them searched on the widget's theme, as well.
16927     *
16928     * @note This call is of use only if you've set a custom cursor
16929     * for list items, with elm_list_item_cursor_set().
16930     *
16931     * @note By default, cursors will only be looked for between those
16932     * provided by the rendering engine.
16933     *
16934     * @ingroup List
16935     */
16936    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16937
16938    /**
16939     * Get if the (custom) cursor for a given list item is being
16940     * searched in its theme, also, or is only relying on the rendering
16941     * engine.
16942     *
16943     * @param item a list item
16944     * @return @c EINA_TRUE, if cursors are being looked for only on
16945     * those provided by the rendering engine, @c EINA_FALSE if they
16946     * are being searched on the widget's theme, as well.
16947     *
16948     * @see elm_list_item_cursor_engine_only_set(), for more details
16949     *
16950     * @ingroup List
16951     */
16952    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16953
16954    /**
16955     * @}
16956     */
16957
16958    /**
16959     * @defgroup Slider Slider
16960     * @ingroup Elementary
16961     *
16962     * @image html img/widget/slider/preview-00.png
16963     * @image latex img/widget/slider/preview-00.eps width=\textwidth
16964     *
16965     * The slider adds a dragable “slider” widget for selecting the value of
16966     * something within a range.
16967     *
16968     * A slider can be horizontal or vertical. It can contain an Icon and has a
16969     * primary label as well as a units label (that is formatted with floating
16970     * point values and thus accepts a printf-style format string, like
16971     * “%1.2f units”. There is also an indicator string that may be somewhere
16972     * else (like on the slider itself) that also accepts a format string like
16973     * units. Label, Icon Unit and Indicator strings/objects are optional.
16974     *
16975     * A slider may be inverted which means values invert, with high vales being
16976     * on the left or top and low values on the right or bottom (as opposed to
16977     * normally being low on the left or top and high on the bottom and right).
16978     *
16979     * The slider should have its minimum and maximum values set by the
16980     * application with  elm_slider_min_max_set() and value should also be set by
16981     * the application before use with  elm_slider_value_set(). The span of the
16982     * slider is its length (horizontally or vertically). This will be scaled by
16983     * the object or applications scaling factor. At any point code can query the
16984     * slider for its value with elm_slider_value_get().
16985     *
16986     * Smart callbacks one can listen to:
16987     * - "changed" - Whenever the slider value is changed by the user.
16988     * - "slider,drag,start" - dragging the slider indicator around has started.
16989     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16990     * - "delay,changed" - A short time after the value is changed by the user.
16991     * This will be called only when the user stops dragging for
16992     * a very short period or when they release their
16993     * finger/mouse, so it avoids possibly expensive reactions to
16994     * the value change.
16995     *
16996     * Available styles for it:
16997     * - @c "default"
16998     *
16999     * Here is an example on its usage:
17000     * @li @ref slider_example
17001     */
17002
17003    /**
17004     * @addtogroup Slider
17005     * @{
17006     */
17007
17008    /**
17009     * Add a new slider widget to the given parent Elementary
17010     * (container) object.
17011     *
17012     * @param parent The parent object.
17013     * @return a new slider widget handle or @c NULL, on errors.
17014     *
17015     * This function inserts a new slider widget on the canvas.
17016     *
17017     * @ingroup Slider
17018     */
17019    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17020
17021    /**
17022     * Set the label of a given slider widget
17023     *
17024     * @param obj The progress bar object
17025     * @param label The text label string, in UTF-8
17026     *
17027     * @ingroup Slider
17028     * @deprecated use elm_object_text_set() instead.
17029     */
17030    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17031
17032    /**
17033     * Get the label of a given slider widget
17034     *
17035     * @param obj The progressbar object
17036     * @return The text label string, in UTF-8
17037     *
17038     * @ingroup Slider
17039     * @deprecated use elm_object_text_get() instead.
17040     */
17041    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17042
17043    /**
17044     * Set the icon object of the slider object.
17045     *
17046     * @param obj The slider object.
17047     * @param icon The icon object.
17048     *
17049     * On horizontal mode, icon is placed at left, and on vertical mode,
17050     * placed at top.
17051     *
17052     * @note Once the icon object is set, a previously set one will be deleted.
17053     * If you want to keep that old content object, use the
17054     * elm_slider_icon_unset() function.
17055     *
17056     * @warning If the object being set does not have minimum size hints set,
17057     * it won't get properly displayed.
17058     *
17059     * @ingroup Slider
17060     */
17061    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17062
17063    /**
17064     * Unset an icon set on a given slider widget.
17065     *
17066     * @param obj The slider object.
17067     * @return The icon object that was being used, if any was set, or
17068     * @c NULL, otherwise (and on errors).
17069     *
17070     * On horizontal mode, icon is placed at left, and on vertical mode,
17071     * placed at top.
17072     *
17073     * This call will unparent and return the icon object which was set
17074     * for this widget, previously, on success.
17075     *
17076     * @see elm_slider_icon_set() for more details
17077     * @see elm_slider_icon_get()
17078     *
17079     * @ingroup Slider
17080     */
17081    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17082
17083    /**
17084     * Retrieve the icon object set for a given slider widget.
17085     *
17086     * @param obj The slider object.
17087     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17088     * otherwise (and on errors).
17089     *
17090     * On horizontal mode, icon is placed at left, and on vertical mode,
17091     * placed at top.
17092     *
17093     * @see elm_slider_icon_set() for more details
17094     * @see elm_slider_icon_unset()
17095     *
17096     * @ingroup Slider
17097     */
17098    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17099
17100    /**
17101     * Set the end object of the slider object.
17102     *
17103     * @param obj The slider object.
17104     * @param end The end object.
17105     *
17106     * On horizontal mode, end is placed at left, and on vertical mode,
17107     * placed at bottom.
17108     *
17109     * @note Once the icon object is set, a previously set one will be deleted.
17110     * If you want to keep that old content object, use the
17111     * elm_slider_end_unset() function.
17112     *
17113     * @warning If the object being set does not have minimum size hints set,
17114     * it won't get properly displayed.
17115     *
17116     * @ingroup Slider
17117     */
17118    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17119
17120    /**
17121     * Unset an end object set on a given slider widget.
17122     *
17123     * @param obj The slider object.
17124     * @return The end object that was being used, if any was set, or
17125     * @c NULL, otherwise (and on errors).
17126     *
17127     * On horizontal mode, end is placed at left, and on vertical mode,
17128     * placed at bottom.
17129     *
17130     * This call will unparent and return the icon object which was set
17131     * for this widget, previously, on success.
17132     *
17133     * @see elm_slider_end_set() for more details.
17134     * @see elm_slider_end_get()
17135     *
17136     * @ingroup Slider
17137     */
17138    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17139
17140    /**
17141     * Retrieve the end object set for a given slider widget.
17142     *
17143     * @param obj The slider object.
17144     * @return The end object's handle, if @p obj had one set, or @c NULL,
17145     * otherwise (and on errors).
17146     *
17147     * On horizontal mode, icon is placed at right, and on vertical mode,
17148     * placed at bottom.
17149     *
17150     * @see elm_slider_end_set() for more details.
17151     * @see elm_slider_end_unset()
17152     *
17153     * @ingroup Slider
17154     */
17155    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17156
17157    /**
17158     * Set the (exact) length of the bar region of a given slider widget.
17159     *
17160     * @param obj The slider object.
17161     * @param size The length of the slider's bar region.
17162     *
17163     * This sets the minimum width (when in horizontal mode) or height
17164     * (when in vertical mode) of the actual bar area of the slider
17165     * @p obj. This in turn affects the object's minimum size. Use
17166     * this when you're not setting other size hints expanding on the
17167     * given direction (like weight and alignment hints) and you would
17168     * like it to have a specific size.
17169     *
17170     * @note Icon, end, label, indicator and unit text around @p obj
17171     * will require their
17172     * own space, which will make @p obj to require more the @p size,
17173     * actually.
17174     *
17175     * @see elm_slider_span_size_get()
17176     *
17177     * @ingroup Slider
17178     */
17179    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17180
17181    /**
17182     * Get the length set for the bar region of a given slider widget
17183     *
17184     * @param obj The slider object.
17185     * @return The length of the slider's bar region.
17186     *
17187     * If that size was not set previously, with
17188     * elm_slider_span_size_set(), this call will return @c 0.
17189     *
17190     * @ingroup Slider
17191     */
17192    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17193
17194    /**
17195     * Set the format string for the unit label.
17196     *
17197     * @param obj The slider object.
17198     * @param format The format string for the unit display.
17199     *
17200     * Unit label is displayed all the time, if set, after slider's bar.
17201     * In horizontal mode, at right and in vertical mode, at bottom.
17202     *
17203     * If @c NULL, unit label won't be visible. If not it sets the format
17204     * string for the label text. To the label text is provided a floating point
17205     * value, so the label text can display up to 1 floating point value.
17206     * Note that this is optional.
17207     *
17208     * Use a format string such as "%1.2f meters" for example, and it will
17209     * display values like: "3.14 meters" for a value equal to 3.14159.
17210     *
17211     * Default is unit label disabled.
17212     *
17213     * @see elm_slider_indicator_format_get()
17214     *
17215     * @ingroup Slider
17216     */
17217    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17218
17219    /**
17220     * Get the unit label format of the slider.
17221     *
17222     * @param obj The slider object.
17223     * @return The unit label format string in UTF-8.
17224     *
17225     * Unit label is displayed all the time, if set, after slider's bar.
17226     * In horizontal mode, at right and in vertical mode, at bottom.
17227     *
17228     * @see elm_slider_unit_format_set() for more
17229     * information on how this works.
17230     *
17231     * @ingroup Slider
17232     */
17233    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17234
17235    /**
17236     * Set the format string for the indicator label.
17237     *
17238     * @param obj The slider object.
17239     * @param indicator The format string for the indicator display.
17240     *
17241     * The slider may display its value somewhere else then unit label,
17242     * for example, above the slider knob that is dragged around. This function
17243     * sets the format string used for this.
17244     *
17245     * If @c NULL, indicator label won't be visible. If not it sets the format
17246     * string for the label text. To the label text is provided a floating point
17247     * value, so the label text can display up to 1 floating point value.
17248     * Note that this is optional.
17249     *
17250     * Use a format string such as "%1.2f meters" for example, and it will
17251     * display values like: "3.14 meters" for a value equal to 3.14159.
17252     *
17253     * Default is indicator label disabled.
17254     *
17255     * @see elm_slider_indicator_format_get()
17256     *
17257     * @ingroup Slider
17258     */
17259    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17260
17261    /**
17262     * Get the indicator label format of the slider.
17263     *
17264     * @param obj The slider object.
17265     * @return The indicator label format string in UTF-8.
17266     *
17267     * The slider may display its value somewhere else then unit label,
17268     * for example, above the slider knob that is dragged around. This function
17269     * gets the format string used for this.
17270     *
17271     * @see elm_slider_indicator_format_set() for more
17272     * information on how this works.
17273     *
17274     * @ingroup Slider
17275     */
17276    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17277
17278    /**
17279     * Set the format function pointer for the indicator label
17280     *
17281     * @param obj The slider object.
17282     * @param func The indicator format function.
17283     * @param free_func The freeing function for the format string.
17284     *
17285     * Set the callback function to format the indicator string.
17286     *
17287     * @see elm_slider_indicator_format_set() for more info on how this works.
17288     *
17289     * @ingroup Slider
17290     */
17291   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);
17292
17293   /**
17294    * Set the format function pointer for the units label
17295    *
17296    * @param obj The slider object.
17297    * @param func The units format function.
17298    * @param free_func The freeing function for the format string.
17299    *
17300    * Set the callback function to format the indicator string.
17301    *
17302    * @see elm_slider_units_format_set() for more info on how this works.
17303    *
17304    * @ingroup Slider
17305    */
17306   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);
17307
17308   /**
17309    * Set the orientation of a given slider widget.
17310    *
17311    * @param obj The slider object.
17312    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17313    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17314    *
17315    * Use this function to change how your slider is to be
17316    * disposed: vertically or horizontally.
17317    *
17318    * By default it's displayed horizontally.
17319    *
17320    * @see elm_slider_horizontal_get()
17321    *
17322    * @ingroup Slider
17323    */
17324    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17325
17326    /**
17327     * Retrieve the orientation of a given slider widget
17328     *
17329     * @param obj The slider object.
17330     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17331     * @c EINA_FALSE if it's @b vertical (and on errors).
17332     *
17333     * @see elm_slider_horizontal_set() for more details.
17334     *
17335     * @ingroup Slider
17336     */
17337    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17338
17339    /**
17340     * Set the minimum and maximum values for the slider.
17341     *
17342     * @param obj The slider object.
17343     * @param min The minimum value.
17344     * @param max The maximum value.
17345     *
17346     * Define the allowed range of values to be selected by the user.
17347     *
17348     * If actual value is less than @p min, it will be updated to @p min. If it
17349     * is bigger then @p max, will be updated to @p max. Actual value can be
17350     * get with elm_slider_value_get().
17351     *
17352     * By default, min is equal to 0.0, and max is equal to 1.0.
17353     *
17354     * @warning Maximum must be greater than minimum, otherwise behavior
17355     * is undefined.
17356     *
17357     * @see elm_slider_min_max_get()
17358     *
17359     * @ingroup Slider
17360     */
17361    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17362
17363    /**
17364     * Get the minimum and maximum values of the slider.
17365     *
17366     * @param obj The slider object.
17367     * @param min Pointer where to store the minimum value.
17368     * @param max Pointer where to store the maximum value.
17369     *
17370     * @note If only one value is needed, the other pointer can be passed
17371     * as @c NULL.
17372     *
17373     * @see elm_slider_min_max_set() for details.
17374     *
17375     * @ingroup Slider
17376     */
17377    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17378
17379    /**
17380     * Set the value the slider displays.
17381     *
17382     * @param obj The slider object.
17383     * @param val The value to be displayed.
17384     *
17385     * Value will be presented on the unit label following format specified with
17386     * elm_slider_unit_format_set() and on indicator with
17387     * elm_slider_indicator_format_set().
17388     *
17389     * @warning The value must to be between min and max values. This values
17390     * are set by elm_slider_min_max_set().
17391     *
17392     * @see elm_slider_value_get()
17393     * @see elm_slider_unit_format_set()
17394     * @see elm_slider_indicator_format_set()
17395     * @see elm_slider_min_max_set()
17396     *
17397     * @ingroup Slider
17398     */
17399    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17400
17401    /**
17402     * Get the value displayed by the spinner.
17403     *
17404     * @param obj The spinner object.
17405     * @return The value displayed.
17406     *
17407     * @see elm_spinner_value_set() for details.
17408     *
17409     * @ingroup Slider
17410     */
17411    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17412
17413    /**
17414     * Invert a given slider widget's displaying values order
17415     *
17416     * @param obj The slider object.
17417     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17418     * @c EINA_FALSE to bring it back to default, non-inverted values.
17419     *
17420     * A slider may be @b inverted, in which state it gets its
17421     * values inverted, with high vales being on the left or top and
17422     * low values on the right or bottom, as opposed to normally have
17423     * the low values on the former and high values on the latter,
17424     * respectively, for horizontal and vertical modes.
17425     *
17426     * @see elm_slider_inverted_get()
17427     *
17428     * @ingroup Slider
17429     */
17430    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17431
17432    /**
17433     * Get whether a given slider widget's displaying values are
17434     * inverted or not.
17435     *
17436     * @param obj The slider object.
17437     * @return @c EINA_TRUE, if @p obj has inverted values,
17438     * @c EINA_FALSE otherwise (and on errors).
17439     *
17440     * @see elm_slider_inverted_set() for more details.
17441     *
17442     * @ingroup Slider
17443     */
17444    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17445
17446    /**
17447     * Set whether to enlarge slider indicator (augmented knob) or not.
17448     *
17449     * @param obj The slider object.
17450     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17451     * let the knob always at default size.
17452     *
17453     * By default, indicator will be bigger while dragged by the user.
17454     *
17455     * @warning It won't display values set with
17456     * elm_slider_indicator_format_set() if you disable indicator.
17457     *
17458     * @ingroup Slider
17459     */
17460    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17461
17462    /**
17463     * Get whether a given slider widget's enlarging indicator or not.
17464     *
17465     * @param obj The slider object.
17466     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17467     * @c EINA_FALSE otherwise (and on errors).
17468     *
17469     * @see elm_slider_indicator_show_set() for details.
17470     *
17471     * @ingroup Slider
17472     */
17473    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17474
17475    /**
17476     * @}
17477     */
17478
17479    /**
17480     * @addtogroup Actionslider Actionslider
17481     *
17482     * @image html img/widget/actionslider/preview-00.png
17483     * @image latex img/widget/actionslider/preview-00.eps
17484     *
17485     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17486     * properties. The indicator is the element the user drags to choose a label.
17487     * When the position is set with magnet, when released the indicator will be
17488     * moved to it if it's nearest the magnetized position.
17489     *
17490     * @note By default all positions are set as enabled.
17491     *
17492     * Signals that you can add callbacks for are:
17493     *
17494     * "selected" - when user selects an enabled position (the label is passed
17495     *              as event info)".
17496     * @n
17497     * "pos_changed" - when the indicator reaches any of the positions("left",
17498     *                 "right" or "center").
17499     *
17500     * See an example of actionslider usage @ref actionslider_example_page "here"
17501     * @{
17502     */
17503    typedef enum _Elm_Actionslider_Pos
17504      {
17505         ELM_ACTIONSLIDER_NONE = 0,
17506         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17507         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17508         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17509         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17510      } Elm_Actionslider_Pos;
17511
17512    /**
17513     * Add a new actionslider to the parent.
17514     *
17515     * @param parent The parent object
17516     * @return The new actionslider object or NULL if it cannot be created
17517     */
17518    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17519    /**
17520     * Set actionslider labels.
17521     *
17522     * @param obj The actionslider object
17523     * @param left_label The label to be set on the left.
17524     * @param center_label The label to be set on the center.
17525     * @param right_label The label to be set on the right.
17526     * @deprecated use elm_object_text_set() instead.
17527     */
17528    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);
17529    /**
17530     * Get actionslider labels.
17531     *
17532     * @param obj The actionslider object
17533     * @param left_label A char** to place the left_label of @p obj into.
17534     * @param center_label A char** to place the center_label of @p obj into.
17535     * @param right_label A char** to place the right_label of @p obj into.
17536     * @deprecated use elm_object_text_set() instead.
17537     */
17538    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);
17539    /**
17540     * Get actionslider selected label.
17541     *
17542     * @param obj The actionslider object
17543     * @return The selected label
17544     */
17545    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17546    /**
17547     * Set actionslider indicator position.
17548     *
17549     * @param obj The actionslider object.
17550     * @param pos The position of the indicator.
17551     */
17552    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17553    /**
17554     * Get actionslider indicator position.
17555     *
17556     * @param obj The actionslider object.
17557     * @return The position of the indicator.
17558     */
17559    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17560    /**
17561     * Set actionslider magnet position. To make multiple positions magnets @c or
17562     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17563     *
17564     * @param obj The actionslider object.
17565     * @param pos Bit mask indicating the magnet positions.
17566     */
17567    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17568    /**
17569     * Get actionslider magnet position.
17570     *
17571     * @param obj The actionslider object.
17572     * @return The positions with magnet property.
17573     */
17574    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17575    /**
17576     * Set actionslider enabled position. To set multiple positions as enabled @c or
17577     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17578     *
17579     * @note All the positions are enabled by default.
17580     *
17581     * @param obj The actionslider object.
17582     * @param pos Bit mask indicating the enabled positions.
17583     */
17584    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17585    /**
17586     * Get actionslider enabled position.
17587     *
17588     * @param obj The actionslider object.
17589     * @return The enabled positions.
17590     */
17591    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17592    /**
17593     * Set the label used on the indicator.
17594     *
17595     * @param obj The actionslider object
17596     * @param label The label to be set on the indicator.
17597     * @deprecated use elm_object_text_set() instead.
17598     */
17599    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17600    /**
17601     * Get the label used on the indicator object.
17602     *
17603     * @param obj The actionslider object
17604     * @return The indicator label
17605     * @deprecated use elm_object_text_get() instead.
17606     */
17607    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17608    /**
17609     * @}
17610     */
17611
17612    /**
17613     * @defgroup Genlist Genlist
17614     *
17615     * @image html img/widget/genlist/preview-00.png
17616     * @image latex img/widget/genlist/preview-00.eps
17617     * @image html img/genlist.png
17618     * @image latex img/genlist.eps
17619     *
17620     * This widget aims to have more expansive list than the simple list in
17621     * Elementary that could have more flexible items and allow many more entries
17622     * while still being fast and low on memory usage. At the same time it was
17623     * also made to be able to do tree structures. But the price to pay is more
17624     * complexity when it comes to usage. If all you want is a simple list with
17625     * icons and a single label, use the normal @ref List object.
17626     *
17627     * Genlist has a fairly large API, mostly because it's relatively complex,
17628     * trying to be both expansive, powerful and efficient. First we will begin
17629     * an overview on the theory behind genlist.
17630     *
17631     * @section Genlist_Item_Class Genlist item classes - creating items
17632     *
17633     * In order to have the ability to add and delete items on the fly, genlist
17634     * implements a class (callback) system where the application provides a
17635     * structure with information about that type of item (genlist may contain
17636     * multiple different items with different classes, states and styles).
17637     * Genlist will call the functions in this struct (methods) when an item is
17638     * "realized" (i.e., created dynamically, while the user is scrolling the
17639     * grid). All objects will simply be deleted when no longer needed with
17640     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17641     * following members:
17642     * - @c item_style - This is a constant string and simply defines the name
17643     *   of the item style. It @b must be specified and the default should be @c
17644     *   "default".
17645     * - @c mode_item_style - This is a constant string and simply defines the
17646     *   name of the style that will be used for mode animations. It can be left
17647     *   as @c NULL if you don't plan to use Genlist mode. See
17648     *   elm_genlist_item_mode_set() for more info.
17649     *
17650     * - @c func - A struct with pointers to functions that will be called when
17651     *   an item is going to be actually created. All of them receive a @c data
17652     *   parameter that will point to the same data passed to
17653     *   elm_genlist_item_append() and related item creation functions, and a @c
17654     *   obj parameter that points to the genlist object itself.
17655     *
17656     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17657     * state_get and @c del. The 3 first functions also receive a @c part
17658     * parameter described below. A brief description of these functions follows:
17659     *
17660     * - @c label_get - The @c part parameter is the name string of one of the
17661     *   existing text parts in the Edje group implementing the item's theme.
17662     *   This function @b must return a strdup'()ed string, as the caller will
17663     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17664     * - @c icon_get - The @c part parameter is the name string of one of the
17665     *   existing (icon) swallow parts in the Edje group implementing the item's
17666     *   theme. It must return @c NULL, when no icon is desired, or a valid
17667     *   object handle, otherwise.  The object will be deleted by the genlist on
17668     *   its deletion or when the item is "unrealized".  See
17669     *   #Elm_Genlist_Item_Icon_Get_Cb.
17670     * - @c func.state_get - The @c part parameter is the name string of one of
17671     *   the state parts in the Edje group implementing the item's theme. Return
17672     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17673     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17674     *   and @c "elm" as "emission" and "source" arguments, respectively, when
17675     *   the state is true (the default is false), where @c XXX is the name of
17676     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
17677     * - @c func.del - This is intended for use when genlist items are deleted,
17678     *   so any data attached to the item (e.g. its data parameter on creation)
17679     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
17680     *
17681     * available item styles:
17682     * - default
17683     * - default_style - The text part is a textblock
17684     *
17685     * @image html img/widget/genlist/preview-04.png
17686     * @image latex img/widget/genlist/preview-04.eps
17687     *
17688     * - double_label
17689     *
17690     * @image html img/widget/genlist/preview-01.png
17691     * @image latex img/widget/genlist/preview-01.eps
17692     *
17693     * - icon_top_text_bottom
17694     *
17695     * @image html img/widget/genlist/preview-02.png
17696     * @image latex img/widget/genlist/preview-02.eps
17697     *
17698     * - group_index
17699     *
17700     * @image html img/widget/genlist/preview-03.png
17701     * @image latex img/widget/genlist/preview-03.eps
17702     *
17703     * @section Genlist_Items Structure of items
17704     *
17705     * An item in a genlist can have 0 or more text labels (they can be regular
17706     * text or textblock Evas objects - that's up to the style to determine), 0
17707     * or more icons (which are simply objects swallowed into the genlist item's
17708     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17709     * behavior left to the user to define. The Edje part names for each of
17710     * these properties will be looked up, in the theme file for the genlist,
17711     * under the Edje (string) data items named @c "labels", @c "icons" and @c
17712     * "states", respectively. For each of those properties, if more than one
17713     * part is provided, they must have names listed separated by spaces in the
17714     * data fields. For the default genlist item theme, we have @b one label
17715     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17716     * "elm.swallow.end") and @b no state parts.
17717     *
17718     * A genlist item may be at one of several styles. Elementary provides one
17719     * by default - "default", but this can be extended by system or application
17720     * custom themes/overlays/extensions (see @ref Theme "themes" for more
17721     * details).
17722     *
17723     * @section Genlist_Manipulation Editing and Navigating
17724     *
17725     * Items can be added by several calls. All of them return a @ref
17726     * Elm_Genlist_Item handle that is an internal member inside the genlist.
17727     * They all take a data parameter that is meant to be used for a handle to
17728     * the applications internal data (eg the struct with the original item
17729     * data). The parent parameter is the parent genlist item this belongs to if
17730     * it is a tree or an indexed group, and NULL if there is no parent. The
17731     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17732     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17733     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17734     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
17735     * is set then this item is group index item that is displayed at the top
17736     * until the next group comes. The func parameter is a convenience callback
17737     * that is called when the item is selected and the data parameter will be
17738     * the func_data parameter, obj be the genlist object and event_info will be
17739     * the genlist item.
17740     *
17741     * elm_genlist_item_append() adds an item to the end of the list, or if
17742     * there is a parent, to the end of all the child items of the parent.
17743     * elm_genlist_item_prepend() is the same but adds to the beginning of
17744     * the list or children list. elm_genlist_item_insert_before() inserts at
17745     * item before another item and elm_genlist_item_insert_after() inserts after
17746     * the indicated item.
17747     *
17748     * The application can clear the list with elm_genlist_clear() which deletes
17749     * all the items in the list and elm_genlist_item_del() will delete a specific
17750     * item. elm_genlist_item_subitems_clear() will clear all items that are
17751     * children of the indicated parent item.
17752     *
17753     * To help inspect list items you can jump to the item at the top of the list
17754     * with elm_genlist_first_item_get() which will return the item pointer, and
17755     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17756     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17757     * and previous items respectively relative to the indicated item. Using
17758     * these calls you can walk the entire item list/tree. Note that as a tree
17759     * the items are flattened in the list, so elm_genlist_item_parent_get() will
17760     * let you know which item is the parent (and thus know how to skip them if
17761     * wanted).
17762     *
17763     * @section Genlist_Muti_Selection Multi-selection
17764     *
17765     * If the application wants multiple items to be able to be selected,
17766     * elm_genlist_multi_select_set() can enable this. If the list is
17767     * single-selection only (the default), then elm_genlist_selected_item_get()
17768     * will return the selected item, if any, or NULL I none is selected. If the
17769     * list is multi-select then elm_genlist_selected_items_get() will return a
17770     * list (that is only valid as long as no items are modified (added, deleted,
17771     * selected or unselected)).
17772     *
17773     * @section Genlist_Usage_Hints Usage hints
17774     *
17775     * There are also convenience functions. elm_genlist_item_genlist_get() will
17776     * return the genlist object the item belongs to. elm_genlist_item_show()
17777     * will make the scroller scroll to show that specific item so its visible.
17778     * elm_genlist_item_data_get() returns the data pointer set by the item
17779     * creation functions.
17780     *
17781     * If an item changes (state of boolean changes, label or icons change),
17782     * then use elm_genlist_item_update() to have genlist update the item with
17783     * the new state. Genlist will re-realize the item thus call the functions
17784     * in the _Elm_Genlist_Item_Class for that item.
17785     *
17786     * To programmatically (un)select an item use elm_genlist_item_selected_set().
17787     * To get its selected state use elm_genlist_item_selected_get(). Similarly
17788     * to expand/contract an item and get its expanded state, use
17789     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17790     * again to make an item disabled (unable to be selected and appear
17791     * differently) use elm_genlist_item_disabled_set() to set this and
17792     * elm_genlist_item_disabled_get() to get the disabled state.
17793     *
17794     * In general to indicate how the genlist should expand items horizontally to
17795     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17796     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17797     * mode means that if items are too wide to fit, the scroller will scroll
17798     * horizontally. Otherwise items are expanded to fill the width of the
17799     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17800     * to the viewport width and limited to that size. This can be combined with
17801     * a different style that uses edjes' ellipsis feature (cutting text off like
17802     * this: "tex...").
17803     *
17804     * Items will only call their selection func and callback when first becoming
17805     * selected. Any further clicks will do nothing, unless you enable always
17806     * select with elm_genlist_always_select_mode_set(). This means even if
17807     * selected, every click will make the selected callbacks be called.
17808     * elm_genlist_no_select_mode_set() will turn off the ability to select
17809     * items entirely and they will neither appear selected nor call selected
17810     * callback functions.
17811     *
17812     * Remember that you can create new styles and add your own theme augmentation
17813     * per application with elm_theme_extension_add(). If you absolutely must
17814     * have a specific style that overrides any theme the user or system sets up
17815     * you can use elm_theme_overlay_add() to add such a file.
17816     *
17817     * @section Genlist_Implementation Implementation
17818     *
17819     * Evas tracks every object you create. Every time it processes an event
17820     * (mouse move, down, up etc.) it needs to walk through objects and find out
17821     * what event that affects. Even worse every time it renders display updates,
17822     * in order to just calculate what to re-draw, it needs to walk through many
17823     * many many objects. Thus, the more objects you keep active, the more
17824     * overhead Evas has in just doing its work. It is advisable to keep your
17825     * active objects to the minimum working set you need. Also remember that
17826     * object creation and deletion carries an overhead, so there is a
17827     * middle-ground, which is not easily determined. But don't keep massive lists
17828     * of objects you can't see or use. Genlist does this with list objects. It
17829     * creates and destroys them dynamically as you scroll around. It groups them
17830     * into blocks so it can determine the visibility etc. of a whole block at
17831     * once as opposed to having to walk the whole list. This 2-level list allows
17832     * for very large numbers of items to be in the list (tests have used up to
17833     * 2,000,000 items). Also genlist employs a queue for adding items. As items
17834     * may be different sizes, every item added needs to be calculated as to its
17835     * size and thus this presents a lot of overhead on populating the list, this
17836     * genlist employs a queue. Any item added is queued and spooled off over
17837     * time, actually appearing some time later, so if your list has many members
17838     * you may find it takes a while for them to all appear, with your process
17839     * consuming a lot of CPU while it is busy spooling.
17840     *
17841     * Genlist also implements a tree structure, but it does so with callbacks to
17842     * the application, with the application filling in tree structures when
17843     * requested (allowing for efficient building of a very deep tree that could
17844     * even be used for file-management). See the above smart signal callbacks for
17845     * details.
17846     *
17847     * @section Genlist_Smart_Events Genlist smart events
17848     *
17849     * Signals that you can add callbacks for are:
17850     * - @c "activated" - The user has double-clicked or pressed
17851     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
17852     *   item that was activated.
17853     * - @c "clicked,double" - The user has double-clicked an item.  The @c
17854     *   event_info parameter is the item that was double-clicked.
17855     * - @c "selected" - This is called when a user has made an item selected.
17856     *   The event_info parameter is the genlist item that was selected.
17857     * - @c "unselected" - This is called when a user has made an item
17858     *   unselected. The event_info parameter is the genlist item that was
17859     *   unselected.
17860     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17861     *   called and the item is now meant to be expanded. The event_info
17862     *   parameter is the genlist item that was indicated to expand.  It is the
17863     *   job of this callback to then fill in the child items.
17864     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17865     *   called and the item is now meant to be contracted. The event_info
17866     *   parameter is the genlist item that was indicated to contract. It is the
17867     *   job of this callback to then delete the child items.
17868     * - @c "expand,request" - This is called when a user has indicated they want
17869     *   to expand a tree branch item. The callback should decide if the item can
17870     *   expand (has any children) and then call elm_genlist_item_expanded_set()
17871     *   appropriately to set the state. The event_info parameter is the genlist
17872     *   item that was indicated to expand.
17873     * - @c "contract,request" - This is called when a user has indicated they
17874     *   want to contract a tree branch item. The callback should decide if the
17875     *   item can contract (has any children) and then call
17876     *   elm_genlist_item_expanded_set() appropriately to set the state. The
17877     *   event_info parameter is the genlist item that was indicated to contract.
17878     * - @c "realized" - This is called when the item in the list is created as a
17879     *   real evas object. event_info parameter is the genlist item that was
17880     *   created. The object may be deleted at any time, so it is up to the
17881     *   caller to not use the object pointer from elm_genlist_item_object_get()
17882     *   in a way where it may point to freed objects.
17883     * - @c "unrealized" - This is called just before an item is unrealized.
17884     *   After this call icon objects provided will be deleted and the item
17885     *   object itself delete or be put into a floating cache.
17886     * - @c "drag,start,up" - This is called when the item in the list has been
17887     *   dragged (not scrolled) up.
17888     * - @c "drag,start,down" - This is called when the item in the list has been
17889     *   dragged (not scrolled) down.
17890     * - @c "drag,start,left" - This is called when the item in the list has been
17891     *   dragged (not scrolled) left.
17892     * - @c "drag,start,right" - This is called when the item in the list has
17893     *   been dragged (not scrolled) right.
17894     * - @c "drag,stop" - This is called when the item in the list has stopped
17895     *   being dragged.
17896     * - @c "drag" - This is called when the item in the list is being dragged.
17897     * - @c "longpressed" - This is called when the item is pressed for a certain
17898     *   amount of time. By default it's 1 second.
17899     * - @c "scroll,anim,start" - This is called when scrolling animation has
17900     *   started.
17901     * - @c "scroll,anim,stop" - This is called when scrolling animation has
17902     *   stopped.
17903     * - @c "scroll,drag,start" - This is called when dragging the content has
17904     *   started.
17905     * - @c "scroll,drag,stop" - This is called when dragging the content has
17906     *   stopped.
17907     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
17908     *   the top edge.
17909     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
17910     *   until the bottom edge.
17911     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
17912     *   until the left edge.
17913     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
17914     *   until the right edge.
17915     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17916     *   swiped left.
17917     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17918     *   swiped right.
17919     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17920     *   swiped up.
17921     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17922     *   swiped down.
17923     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17924     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
17925     *   multi-touch pinched in.
17926     * - @c "swipe" - This is called when the genlist is swiped.
17927     *
17928     * @section Genlist_Examples Examples
17929     *
17930     * Here is a list of examples that use the genlist, trying to show some of
17931     * its capabilities:
17932     * - @ref genlist_example_01
17933     * - @ref genlist_example_02
17934     * - @ref genlist_example_03
17935     * - @ref genlist_example_04
17936     * - @ref genlist_example_05
17937     */
17938
17939    /**
17940     * @addtogroup Genlist
17941     * @{
17942     */
17943
17944    /**
17945     * @enum _Elm_Genlist_Item_Flags
17946     * @typedef Elm_Genlist_Item_Flags
17947     *
17948     * Defines if the item is of any special type (has subitems or it's the
17949     * index of a group), or is just a simple item.
17950     *
17951     * @ingroup Genlist
17952     */
17953    typedef enum _Elm_Genlist_Item_Flags
17954      {
17955         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17956         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17957         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17958      } Elm_Genlist_Item_Flags;
17959    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
17960    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17961    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
17962    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
17963    typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
17964    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. */
17965    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
17966    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
17967
17968    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17969    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17970    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17971    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17972
17973    /**
17974     * @struct _Elm_Genlist_Item_Class
17975     *
17976     * Genlist item class definition structs.
17977     *
17978     * This struct contains the style and fetching functions that will define the
17979     * contents of each item.
17980     *
17981     * @see @ref Genlist_Item_Class
17982     */
17983    struct _Elm_Genlist_Item_Class
17984      {
17985         const char                *item_style; /**< style of this class. */
17986         struct
17987           {
17988              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
17989              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
17990              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
17991              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
17992              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
17993           } func;
17994         const char                *mode_item_style;
17995      };
17996
17997    /**
17998     * Add a new genlist widget to the given parent Elementary
17999     * (container) object
18000     *
18001     * @param parent The parent object
18002     * @return a new genlist widget handle or @c NULL, on errors
18003     *
18004     * This function inserts a new genlist widget on the canvas.
18005     *
18006     * @see elm_genlist_item_append()
18007     * @see elm_genlist_item_del()
18008     * @see elm_genlist_clear()
18009     *
18010     * @ingroup Genlist
18011     */
18012    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18013    /**
18014     * Remove all items from a given genlist widget.
18015     *
18016     * @param obj The genlist object
18017     *
18018     * This removes (and deletes) all items in @p obj, leaving it empty.
18019     *
18020     * @see elm_genlist_item_del(), to remove just one item.
18021     *
18022     * @ingroup Genlist
18023     */
18024    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18025    /**
18026     * Enable or disable multi-selection in the genlist
18027     *
18028     * @param obj The genlist object
18029     * @param multi Multi-select enable/disable. Default is disabled.
18030     *
18031     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18032     * the list. This allows more than 1 item to be selected. To retrieve the list
18033     * of selected items, use elm_genlist_selected_items_get().
18034     *
18035     * @see elm_genlist_selected_items_get()
18036     * @see elm_genlist_multi_select_get()
18037     *
18038     * @ingroup Genlist
18039     */
18040    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18041    /**
18042     * Gets if multi-selection in genlist is enabled or disabled.
18043     *
18044     * @param obj The genlist object
18045     * @return Multi-select enabled/disabled
18046     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18047     *
18048     * @see elm_genlist_multi_select_set()
18049     *
18050     * @ingroup Genlist
18051     */
18052    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18053    /**
18054     * This sets the horizontal stretching mode.
18055     *
18056     * @param obj The genlist object
18057     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18058     *
18059     * This sets the mode used for sizing items horizontally. Valid modes
18060     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18061     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18062     * the scroller will scroll horizontally. Otherwise items are expanded
18063     * to fill the width of the viewport of the scroller. If it is
18064     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18065     * limited to that size.
18066     *
18067     * @see elm_genlist_horizontal_get()
18068     *
18069     * @ingroup Genlist
18070     */
18071    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18072    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18073    /**
18074     * Gets the horizontal stretching mode.
18075     *
18076     * @param obj The genlist object
18077     * @return The mode to use
18078     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18079     *
18080     * @see elm_genlist_horizontal_set()
18081     *
18082     * @ingroup Genlist
18083     */
18084    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18085    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18086    /**
18087     * Set the always select mode.
18088     *
18089     * @param obj The genlist object
18090     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18091     * EINA_FALSE = off). Default is @c EINA_FALSE.
18092     *
18093     * Items will only call their selection func and callback when first
18094     * becoming selected. Any further clicks will do nothing, unless you
18095     * enable always select with elm_genlist_always_select_mode_set().
18096     * This means that, even if selected, every click will make the selected
18097     * callbacks be called.
18098     *
18099     * @see elm_genlist_always_select_mode_get()
18100     *
18101     * @ingroup Genlist
18102     */
18103    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18104    /**
18105     * Get the always select mode.
18106     *
18107     * @param obj The genlist object
18108     * @return The always select mode
18109     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18110     *
18111     * @see elm_genlist_always_select_mode_set()
18112     *
18113     * @ingroup Genlist
18114     */
18115    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18116    /**
18117     * Enable/disable the no select mode.
18118     *
18119     * @param obj The genlist object
18120     * @param no_select The no select mode
18121     * (EINA_TRUE = on, EINA_FALSE = off)
18122     *
18123     * This will turn off the ability to select items entirely and they
18124     * will neither appear selected nor call selected callback functions.
18125     *
18126     * @see elm_genlist_no_select_mode_get()
18127     *
18128     * @ingroup Genlist
18129     */
18130    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18131    /**
18132     * Gets whether the no select mode is enabled.
18133     *
18134     * @param obj The genlist object
18135     * @return The no select mode
18136     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18137     *
18138     * @see elm_genlist_no_select_mode_set()
18139     *
18140     * @ingroup Genlist
18141     */
18142    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18143    /**
18144     * Enable/disable compress mode.
18145     *
18146     * @param obj The genlist object
18147     * @param compress The compress mode
18148     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18149     *
18150     * This will enable the compress mode where items are "compressed"
18151     * horizontally to fit the genlist scrollable viewport width. This is
18152     * special for genlist.  Do not rely on
18153     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18154     * work as genlist needs to handle it specially.
18155     *
18156     * @see elm_genlist_compress_mode_get()
18157     *
18158     * @ingroup Genlist
18159     */
18160    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18161    /**
18162     * Get whether the compress mode is enabled.
18163     *
18164     * @param obj The genlist object
18165     * @return The compress mode
18166     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18167     *
18168     * @see elm_genlist_compress_mode_set()
18169     *
18170     * @ingroup Genlist
18171     */
18172    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18173    /**
18174     * Enable/disable height-for-width mode.
18175     *
18176     * @param obj The genlist object
18177     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18178     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18179     *
18180     * With height-for-width mode the item width will be fixed (restricted
18181     * to a minimum of) to the list width when calculating its size in
18182     * order to allow the height to be calculated based on it. This allows,
18183     * for instance, text block to wrap lines if the Edje part is
18184     * configured with "text.min: 0 1".
18185     *
18186     * @note This mode will make list resize slower as it will have to
18187     *       recalculate every item height again whenever the list width
18188     *       changes!
18189     *
18190     * @note When height-for-width mode is enabled, it also enables
18191     *       compress mode (see elm_genlist_compress_mode_set()) and
18192     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18193     *
18194     * @ingroup Genlist
18195     */
18196    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18197    /**
18198     * Get whether the height-for-width mode is enabled.
18199     *
18200     * @param obj The genlist object
18201     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18202     * off)
18203     *
18204     * @ingroup Genlist
18205     */
18206    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18207    /**
18208     * Enable/disable horizontal and vertical bouncing effect.
18209     *
18210     * @param obj The genlist object
18211     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18212     * EINA_FALSE = off). Default is @c EINA_FALSE.
18213     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18214     * EINA_FALSE = off). Default is @c EINA_TRUE.
18215     *
18216     * This will enable or disable the scroller bouncing effect for the
18217     * genlist. See elm_scroller_bounce_set() for details.
18218     *
18219     * @see elm_scroller_bounce_set()
18220     * @see elm_genlist_bounce_get()
18221     *
18222     * @ingroup Genlist
18223     */
18224    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18225    /**
18226     * Get whether the horizontal and vertical bouncing effect is enabled.
18227     *
18228     * @param obj The genlist object
18229     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18230     * option is set.
18231     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18232     * option is set.
18233     *
18234     * @see elm_genlist_bounce_set()
18235     *
18236     * @ingroup Genlist
18237     */
18238    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18239    /**
18240     * Enable/disable homogenous mode.
18241     *
18242     * @param obj The genlist object
18243     * @param homogeneous Assume the items within the genlist are of the
18244     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18245     * EINA_FALSE.
18246     *
18247     * This will enable the homogeneous mode where items are of the same
18248     * height and width so that genlist may do the lazy-loading at its
18249     * maximum (which increases the performance for scrolling the list). This
18250     * implies 'compressed' mode.
18251     *
18252     * @see elm_genlist_compress_mode_set()
18253     * @see elm_genlist_homogeneous_get()
18254     *
18255     * @ingroup Genlist
18256     */
18257    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18258    /**
18259     * Get whether the homogenous mode is enabled.
18260     *
18261     * @param obj The genlist object
18262     * @return Assume the items within the genlist are of the same height
18263     * and width (EINA_TRUE = on, EINA_FALSE = off)
18264     *
18265     * @see elm_genlist_homogeneous_set()
18266     *
18267     * @ingroup Genlist
18268     */
18269    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18270    /**
18271     * Set the maximum number of items within an item block
18272     *
18273     * @param obj The genlist object
18274     * @param n   Maximum number of items within an item block. Default is 32.
18275     *
18276     * This will configure the block count to tune to the target with
18277     * particular performance matrix.
18278     *
18279     * A block of objects will be used to reduce the number of operations due to
18280     * many objects in the screen. It can determine the visibility, or if the
18281     * object has changed, it theme needs to be updated, etc. doing this kind of
18282     * calculation to the entire block, instead of per object.
18283     *
18284     * The default value for the block count is enough for most lists, so unless
18285     * you know you will have a lot of objects visible in the screen at the same
18286     * time, don't try to change this.
18287     *
18288     * @see elm_genlist_block_count_get()
18289     * @see @ref Genlist_Implementation
18290     *
18291     * @ingroup Genlist
18292     */
18293    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18294    /**
18295     * Get the maximum number of items within an item block
18296     *
18297     * @param obj The genlist object
18298     * @return Maximum number of items within an item block
18299     *
18300     * @see elm_genlist_block_count_set()
18301     *
18302     * @ingroup Genlist
18303     */
18304    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18305    /**
18306     * Set the timeout in seconds for the longpress event.
18307     *
18308     * @param obj The genlist object
18309     * @param timeout timeout in seconds. Default is 1.
18310     *
18311     * This option will change how long it takes to send an event "longpressed"
18312     * after the mouse down signal is sent to the list. If this event occurs, no
18313     * "clicked" event will be sent.
18314     *
18315     * @see elm_genlist_longpress_timeout_set()
18316     *
18317     * @ingroup Genlist
18318     */
18319    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18320    /**
18321     * Get the timeout in seconds for the longpress event.
18322     *
18323     * @param obj The genlist object
18324     * @return timeout in seconds
18325     *
18326     * @see elm_genlist_longpress_timeout_get()
18327     *
18328     * @ingroup Genlist
18329     */
18330    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18331    /**
18332     * Append a new item in a given genlist widget.
18333     *
18334     * @param obj The genlist object
18335     * @param itc The item class for the item
18336     * @param data The item data
18337     * @param parent The parent item, or NULL if none
18338     * @param flags Item flags
18339     * @param func Convenience function called when the item is selected
18340     * @param func_data Data passed to @p func above.
18341     * @return A handle to the item added or @c NULL if not possible
18342     *
18343     * This adds the given item to the end of the list or the end of
18344     * the children list if the @p parent is given.
18345     *
18346     * @see elm_genlist_item_prepend()
18347     * @see elm_genlist_item_insert_before()
18348     * @see elm_genlist_item_insert_after()
18349     * @see elm_genlist_item_del()
18350     *
18351     * @ingroup Genlist
18352     */
18353    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);
18354    /**
18355     * Prepend a new item in a given genlist widget.
18356     *
18357     * @param obj The genlist object
18358     * @param itc The item class for the item
18359     * @param data The item data
18360     * @param parent The parent item, or NULL if none
18361     * @param flags Item flags
18362     * @param func Convenience function called when the item is selected
18363     * @param func_data Data passed to @p func above.
18364     * @return A handle to the item added or NULL if not possible
18365     *
18366     * This adds an item to the beginning of the list or beginning of the
18367     * children of the parent if given.
18368     *
18369     * @see elm_genlist_item_append()
18370     * @see elm_genlist_item_insert_before()
18371     * @see elm_genlist_item_insert_after()
18372     * @see elm_genlist_item_del()
18373     *
18374     * @ingroup Genlist
18375     */
18376    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);
18377    /**
18378     * Insert an item before another in a genlist widget
18379     *
18380     * @param obj The genlist object
18381     * @param itc The item class for the item
18382     * @param data The item data
18383     * @param before The item to place this new one before.
18384     * @param flags Item flags
18385     * @param func Convenience function called when the item is selected
18386     * @param func_data Data passed to @p func above.
18387     * @return A handle to the item added or @c NULL if not possible
18388     *
18389     * This inserts an item before another in the list. It will be in the
18390     * same tree level or group as the item it is inserted before.
18391     *
18392     * @see elm_genlist_item_append()
18393     * @see elm_genlist_item_prepend()
18394     * @see elm_genlist_item_insert_after()
18395     * @see elm_genlist_item_del()
18396     *
18397     * @ingroup Genlist
18398     */
18399    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);
18400    /**
18401     * Insert an item after another in a genlist widget
18402     *
18403     * @param obj The genlist object
18404     * @param itc The item class for the item
18405     * @param data The item data
18406     * @param after The item to place this new one after.
18407     * @param flags Item flags
18408     * @param func Convenience function called when the item is selected
18409     * @param func_data Data passed to @p func above.
18410     * @return A handle to the item added or @c NULL if not possible
18411     *
18412     * This inserts an item after another in the list. It will be in the
18413     * same tree level or group as the item it is inserted after.
18414     *
18415     * @see elm_genlist_item_append()
18416     * @see elm_genlist_item_prepend()
18417     * @see elm_genlist_item_insert_before()
18418     * @see elm_genlist_item_del()
18419     *
18420     * @ingroup Genlist
18421     */
18422    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);
18423    /**
18424     * Insert a new item into the sorted genlist object
18425     *
18426     * @param obj The genlist object
18427     * @param itc The item class for the item
18428     * @param data The item data
18429     * @param parent The parent item, or NULL if none
18430     * @param flags Item flags
18431     * @param comp The function called for the sort
18432     * @param func Convenience function called when item selected
18433     * @param func_data Data passed to @p func above.
18434     * @return A handle to the item added or NULL if not possible
18435     *
18436     * @ingroup Genlist
18437     */
18438    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);
18439    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);
18440    /* operations to retrieve existing items */
18441    /**
18442     * Get the selectd item in the genlist.
18443     *
18444     * @param obj The genlist object
18445     * @return The selected item, or NULL if none is selected.
18446     *
18447     * This gets the selected item in the list (if multi-selection is enabled, only
18448     * the item that was first selected in the list is returned - which is not very
18449     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18450     * used).
18451     *
18452     * If no item is selected, NULL is returned.
18453     *
18454     * @see elm_genlist_selected_items_get()
18455     *
18456     * @ingroup Genlist
18457     */
18458    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18459    /**
18460     * Get a list of selected items in the genlist.
18461     *
18462     * @param obj The genlist object
18463     * @return The list of selected items, or NULL if none are selected.
18464     *
18465     * It returns a list of the selected items. This list pointer is only valid so
18466     * long as the selection doesn't change (no items are selected or unselected, or
18467     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18468     * pointers. The order of the items in this list is the order which they were
18469     * selected, i.e. the first item in this list is the first item that was
18470     * selected, and so on.
18471     *
18472     * @note If not in multi-select mode, consider using function
18473     * elm_genlist_selected_item_get() instead.
18474     *
18475     * @see elm_genlist_multi_select_set()
18476     * @see elm_genlist_selected_item_get()
18477     *
18478     * @ingroup Genlist
18479     */
18480    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18481    /**
18482     * Get a list of realized items in genlist
18483     *
18484     * @param obj The genlist object
18485     * @return The list of realized items, nor NULL if none are realized.
18486     *
18487     * This returns a list of the realized items in the genlist. The list
18488     * contains Elm_Genlist_Item pointers. The list must be freed by the
18489     * caller when done with eina_list_free(). The item pointers in the
18490     * list are only valid so long as those items are not deleted or the
18491     * genlist is not deleted.
18492     *
18493     * @see elm_genlist_realized_items_update()
18494     *
18495     * @ingroup Genlist
18496     */
18497    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18498    /**
18499     * Get the item that is at the x, y canvas coords.
18500     *
18501     * @param obj The gelinst object.
18502     * @param x The input x coordinate
18503     * @param y The input y coordinate
18504     * @param posret The position relative to the item returned here
18505     * @return The item at the coordinates or NULL if none
18506     *
18507     * This returns the item at the given coordinates (which are canvas
18508     * relative, not object-relative). If an item is at that coordinate,
18509     * that item handle is returned, and if @p posret is not NULL, the
18510     * integer pointed to is set to a value of -1, 0 or 1, depending if
18511     * the coordinate is on the upper portion of that item (-1), on the
18512     * middle section (0) or on the lower part (1). If NULL is returned as
18513     * an item (no item found there), then posret may indicate -1 or 1
18514     * based if the coordinate is above or below all items respectively in
18515     * the genlist.
18516     *
18517     * @ingroup Genlist
18518     */
18519    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);
18520    /**
18521     * Get the first item in the genlist
18522     *
18523     * This returns the first item in the list.
18524     *
18525     * @param obj The genlist object
18526     * @return The first item, or NULL if none
18527     *
18528     * @ingroup Genlist
18529     */
18530    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18531    /**
18532     * Get the last item in the genlist
18533     *
18534     * This returns the last item in the list.
18535     *
18536     * @return The last item, or NULL if none
18537     *
18538     * @ingroup Genlist
18539     */
18540    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18541    /**
18542     * Set the scrollbar policy
18543     *
18544     * @param obj The genlist object
18545     * @param policy_h Horizontal scrollbar policy.
18546     * @param policy_v Vertical scrollbar policy.
18547     *
18548     * This sets the scrollbar visibility policy for the given genlist
18549     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18550     * made visible if it is needed, and otherwise kept hidden.
18551     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18552     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18553     * respectively for the horizontal and vertical scrollbars. Default is
18554     * #ELM_SMART_SCROLLER_POLICY_AUTO
18555     *
18556     * @see elm_genlist_scroller_policy_get()
18557     *
18558     * @ingroup Genlist
18559     */
18560    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18561    /**
18562     * Get the scrollbar policy
18563     *
18564     * @param obj The genlist object
18565     * @param policy_h Pointer to store the horizontal scrollbar policy.
18566     * @param policy_v Pointer to store the vertical scrollbar policy.
18567     *
18568     * @see elm_genlist_scroller_policy_set()
18569     *
18570     * @ingroup Genlist
18571     */
18572    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);
18573    /**
18574     * Get the @b next item in a genlist widget's internal list of items,
18575     * given a handle to one of those items.
18576     *
18577     * @param item The genlist item to fetch next from
18578     * @return The item after @p item, or @c NULL if there's none (and
18579     * on errors)
18580     *
18581     * This returns the item placed after the @p item, on the container
18582     * genlist.
18583     *
18584     * @see elm_genlist_item_prev_get()
18585     *
18586     * @ingroup Genlist
18587     */
18588    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18589    /**
18590     * Get the @b previous item in a genlist widget's internal list of items,
18591     * given a handle to one of those items.
18592     *
18593     * @param item The genlist item to fetch previous from
18594     * @return The item before @p item, or @c NULL if there's none (and
18595     * on errors)
18596     *
18597     * This returns the item placed before the @p item, on the container
18598     * genlist.
18599     *
18600     * @see elm_genlist_item_next_get()
18601     *
18602     * @ingroup Genlist
18603     */
18604    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18605    /**
18606     * Get the genlist object's handle which contains a given genlist
18607     * item
18608     *
18609     * @param item The item to fetch the container from
18610     * @return The genlist (parent) object
18611     *
18612     * This returns the genlist object itself that an item belongs to.
18613     *
18614     * @ingroup Genlist
18615     */
18616    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18617    /**
18618     * Get the parent item of the given item
18619     *
18620     * @param it The item
18621     * @return The parent of the item or @c NULL if it has no parent.
18622     *
18623     * This returns the item that was specified as parent of the item @p it on
18624     * elm_genlist_item_append() and insertion related functions.
18625     *
18626     * @ingroup Genlist
18627     */
18628    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18629    /**
18630     * Remove all sub-items (children) of the given item
18631     *
18632     * @param it The item
18633     *
18634     * This removes all items that are children (and their descendants) of the
18635     * given item @p it.
18636     *
18637     * @see elm_genlist_clear()
18638     * @see elm_genlist_item_del()
18639     *
18640     * @ingroup Genlist
18641     */
18642    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18643    /**
18644     * Set whether a given genlist item is selected or not
18645     *
18646     * @param it The item
18647     * @param selected Use @c EINA_TRUE, to make it selected, @c
18648     * EINA_FALSE to make it unselected
18649     *
18650     * This sets the selected state of an item. If multi selection is
18651     * not enabled on the containing genlist and @p selected is @c
18652     * EINA_TRUE, any other previously selected items will get
18653     * unselected in favor of this new one.
18654     *
18655     * @see elm_genlist_item_selected_get()
18656     *
18657     * @ingroup Genlist
18658     */
18659    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18660    /**
18661     * Get whether a given genlist item is selected or not
18662     *
18663     * @param it The item
18664     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18665     *
18666     * @see elm_genlist_item_selected_set() for more details
18667     *
18668     * @ingroup Genlist
18669     */
18670    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18671    /**
18672     * Sets the expanded state of an item.
18673     *
18674     * @param it The item
18675     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18676     *
18677     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18678     * expanded or not.
18679     *
18680     * The theme will respond to this change visually, and a signal "expanded" or
18681     * "contracted" will be sent from the genlist with a pointer to the item that
18682     * has been expanded/contracted.
18683     *
18684     * Calling this function won't show or hide any child of this item (if it is
18685     * a parent). You must manually delete and create them on the callbacks fo
18686     * the "expanded" or "contracted" signals.
18687     *
18688     * @see elm_genlist_item_expanded_get()
18689     *
18690     * @ingroup Genlist
18691     */
18692    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18693    /**
18694     * Get the expanded state of an item
18695     *
18696     * @param it The item
18697     * @return The expanded state
18698     *
18699     * This gets the expanded state of an item.
18700     *
18701     * @see elm_genlist_item_expanded_set()
18702     *
18703     * @ingroup Genlist
18704     */
18705    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18706    /**
18707     * Get the depth of expanded item
18708     *
18709     * @param it The genlist item object
18710     * @return The depth of expanded item
18711     *
18712     * @ingroup Genlist
18713     */
18714    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18715    /**
18716     * Set whether a given genlist item is disabled or not.
18717     *
18718     * @param it The item
18719     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18720     * to enable it back.
18721     *
18722     * A disabled item cannot be selected or unselected. It will also
18723     * change its appearance, to signal the user it's disabled.
18724     *
18725     * @see elm_genlist_item_disabled_get()
18726     *
18727     * @ingroup Genlist
18728     */
18729    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18730    /**
18731     * Get whether a given genlist item is disabled or not.
18732     *
18733     * @param it The item
18734     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18735     * (and on errors).
18736     *
18737     * @see elm_genlist_item_disabled_set() for more details
18738     *
18739     * @ingroup Genlist
18740     */
18741    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18742    /**
18743     * Sets the display only state of an item.
18744     *
18745     * @param it The item
18746     * @param display_only @c EINA_TRUE if the item is display only, @c
18747     * EINA_FALSE otherwise.
18748     *
18749     * A display only item cannot be selected or unselected. It is for
18750     * display only and not selecting or otherwise clicking, dragging
18751     * etc. by the user, thus finger size rules will not be applied to
18752     * this item.
18753     *
18754     * It's good to set group index items to display only state.
18755     *
18756     * @see elm_genlist_item_display_only_get()
18757     *
18758     * @ingroup Genlist
18759     */
18760    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18761    /**
18762     * Get the display only state of an item
18763     *
18764     * @param it The item
18765     * @return @c EINA_TRUE if the item is display only, @c
18766     * EINA_FALSE otherwise.
18767     *
18768     * @see elm_genlist_item_display_only_set()
18769     *
18770     * @ingroup Genlist
18771     */
18772    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18773    /**
18774     * Show the portion of a genlist's internal list containing a given
18775     * item, immediately.
18776     *
18777     * @param it The item to display
18778     *
18779     * This causes genlist to jump to the given item @p it and show it (by
18780     * immediately scrolling to that position), if it is not fully visible.
18781     *
18782     * @see elm_genlist_item_bring_in()
18783     * @see elm_genlist_item_top_show()
18784     * @see elm_genlist_item_middle_show()
18785     *
18786     * @ingroup Genlist
18787     */
18788    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18789    /**
18790     * Animatedly bring in, to the visible are of a genlist, a given
18791     * item on it.
18792     *
18793     * @param it The item to display
18794     *
18795     * This causes genlist to jump to the given item @p it and show it (by
18796     * animatedly scrolling), if it is not fully visible. This may use animation
18797     * to do so and take a period of time
18798     *
18799     * @see elm_genlist_item_show()
18800     * @see elm_genlist_item_top_bring_in()
18801     * @see elm_genlist_item_middle_bring_in()
18802     *
18803     * @ingroup Genlist
18804     */
18805    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18806    /**
18807     * Show the portion of a genlist's internal list containing a given
18808     * item, immediately.
18809     *
18810     * @param it The item to display
18811     *
18812     * This causes genlist to jump to the given item @p it and show it (by
18813     * immediately scrolling to that position), if it is not fully visible.
18814     *
18815     * The item will be positioned at the top of the genlist viewport.
18816     *
18817     * @see elm_genlist_item_show()
18818     * @see elm_genlist_item_top_bring_in()
18819     *
18820     * @ingroup Genlist
18821     */
18822    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18823    /**
18824     * Animatedly bring in, to the visible are of a genlist, a given
18825     * item on it.
18826     *
18827     * @param it The item
18828     *
18829     * This causes genlist to jump to the given item @p it and show it (by
18830     * animatedly scrolling), if it is not fully visible. This may use animation
18831     * to do so and take a period of time
18832     *
18833     * The item will be positioned at the top of the genlist viewport.
18834     *
18835     * @see elm_genlist_item_bring_in()
18836     * @see elm_genlist_item_top_show()
18837     *
18838     * @ingroup Genlist
18839     */
18840    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18841    /**
18842     * Show the portion of a genlist's internal list containing a given
18843     * item, immediately.
18844     *
18845     * @param it The item to display
18846     *
18847     * This causes genlist to jump to the given item @p it and show it (by
18848     * immediately scrolling to that position), if it is not fully visible.
18849     *
18850     * The item will be positioned at the middle of the genlist viewport.
18851     *
18852     * @see elm_genlist_item_show()
18853     * @see elm_genlist_item_middle_bring_in()
18854     *
18855     * @ingroup Genlist
18856     */
18857    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18858    /**
18859     * Animatedly bring in, to the visible are of a genlist, a given
18860     * item on it.
18861     *
18862     * @param it The item
18863     *
18864     * This causes genlist to jump to the given item @p it and show it (by
18865     * animatedly scrolling), if it is not fully visible. This may use animation
18866     * to do so and take a period of time
18867     *
18868     * The item will be positioned at the middle of the genlist viewport.
18869     *
18870     * @see elm_genlist_item_bring_in()
18871     * @see elm_genlist_item_middle_show()
18872     *
18873     * @ingroup Genlist
18874     */
18875    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18876    /**
18877     * Remove a genlist item from the its parent, deleting it.
18878     *
18879     * @param item The item to be removed.
18880     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18881     *
18882     * @see elm_genlist_clear(), to remove all items in a genlist at
18883     * once.
18884     *
18885     * @ingroup Genlist
18886     */
18887    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18888    /**
18889     * Return the data associated to a given genlist item
18890     *
18891     * @param item The genlist item.
18892     * @return the data associated to this item.
18893     *
18894     * This returns the @c data value passed on the
18895     * elm_genlist_item_append() and related item addition calls.
18896     *
18897     * @see elm_genlist_item_append()
18898     * @see elm_genlist_item_data_set()
18899     *
18900     * @ingroup Genlist
18901     */
18902    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18903    /**
18904     * Set the data associated to a given genlist item
18905     *
18906     * @param item The genlist item
18907     * @param data The new data pointer to set on it
18908     *
18909     * This @b overrides the @c data value passed on the
18910     * elm_genlist_item_append() and related item addition calls. This
18911     * function @b won't call elm_genlist_item_update() automatically,
18912     * so you'd issue it afterwards if you want to hove the item
18913     * updated to reflect the that new data.
18914     *
18915     * @see elm_genlist_item_data_get()
18916     *
18917     * @ingroup Genlist
18918     */
18919    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18920    /**
18921     * Tells genlist to "orphan" icons fetchs by the item class
18922     *
18923     * @param it The item
18924     *
18925     * This instructs genlist to release references to icons in the item,
18926     * meaning that they will no longer be managed by genlist and are
18927     * floating "orphans" that can be re-used elsewhere if the user wants
18928     * to.
18929     *
18930     * @ingroup Genlist
18931     */
18932    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18933    /**
18934     * Get the real Evas object created to implement the view of a
18935     * given genlist item
18936     *
18937     * @param item The genlist item.
18938     * @return the Evas object implementing this item's view.
18939     *
18940     * This returns the actual Evas object used to implement the
18941     * specified genlist item's view. This may be @c NULL, as it may
18942     * not have been created or may have been deleted, at any time, by
18943     * the genlist. <b>Do not modify this object</b> (move, resize,
18944     * show, hide, etc.), as the genlist is controlling it. This
18945     * function is for querying, emitting custom signals or hooking
18946     * lower level callbacks for events on that object. Do not delete
18947     * this object under any circumstances.
18948     *
18949     * @see elm_genlist_item_data_get()
18950     *
18951     * @ingroup Genlist
18952     */
18953    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18954    /**
18955     * Update the contents of an item
18956     *
18957     * @param it The item
18958     *
18959     * This updates an item by calling all the item class functions again
18960     * to get the icons, labels and states. Use this when the original
18961     * item data has changed and the changes are desired to be reflected.
18962     *
18963     * Use elm_genlist_realized_items_update() to update all already realized
18964     * items.
18965     *
18966     * @see elm_genlist_realized_items_update()
18967     *
18968     * @ingroup Genlist
18969     */
18970    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18971    /**
18972     * Update the item class of an item
18973     *
18974     * @param it The item
18975     * @param itc The item class for the item
18976     *
18977     * This sets another class fo the item, changing the way that it is
18978     * displayed. After changing the item class, elm_genlist_item_update() is
18979     * called on the item @p it.
18980     *
18981     * @ingroup Genlist
18982     */
18983    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18984    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18985    /**
18986     * Set the text to be shown in a given genlist item's tooltips.
18987     *
18988     * @param item The genlist item
18989     * @param text The text to set in the content
18990     *
18991     * This call will setup the text to be used as tooltip to that item
18992     * (analogous to elm_object_tooltip_text_set(), but being item
18993     * tooltips with higher precedence than object tooltips). It can
18994     * have only one tooltip at a time, so any previous tooltip data
18995     * will get removed.
18996     *
18997     * In order to set an icon or something else as a tooltip, look at
18998     * elm_genlist_item_tooltip_content_cb_set().
18999     *
19000     * @ingroup Genlist
19001     */
19002    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19003    /**
19004     * Set the content to be shown in a given genlist item's tooltips
19005     *
19006     * @param item The genlist item.
19007     * @param func The function returning the tooltip contents.
19008     * @param data What to provide to @a func as callback data/context.
19009     * @param del_cb Called when data is not needed anymore, either when
19010     *        another callback replaces @p func, the tooltip is unset with
19011     *        elm_genlist_item_tooltip_unset() or the owner @p item
19012     *        dies. This callback receives as its first parameter the
19013     *        given @p data, being @c event_info the item handle.
19014     *
19015     * This call will setup the tooltip's contents to @p item
19016     * (analogous to elm_object_tooltip_content_cb_set(), but being
19017     * item tooltips with higher precedence than object tooltips). It
19018     * can have only one tooltip at a time, so any previous tooltip
19019     * content will get removed. @p func (with @p data) will be called
19020     * every time Elementary needs to show the tooltip and it should
19021     * return a valid Evas object, which will be fully managed by the
19022     * tooltip system, getting deleted when the tooltip is gone.
19023     *
19024     * In order to set just a text as a tooltip, look at
19025     * elm_genlist_item_tooltip_text_set().
19026     *
19027     * @ingroup Genlist
19028     */
19029    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);
19030    /**
19031     * Unset a tooltip from a given genlist item
19032     *
19033     * @param item genlist item to remove a previously set tooltip from.
19034     *
19035     * This call removes any tooltip set on @p item. The callback
19036     * provided as @c del_cb to
19037     * elm_genlist_item_tooltip_content_cb_set() will be called to
19038     * notify it is not used anymore (and have resources cleaned, if
19039     * need be).
19040     *
19041     * @see elm_genlist_item_tooltip_content_cb_set()
19042     *
19043     * @ingroup Genlist
19044     */
19045    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19046    /**
19047     * Set a different @b style for a given genlist item's tooltip.
19048     *
19049     * @param item genlist item with tooltip set
19050     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19051     * "default", @c "transparent", etc)
19052     *
19053     * Tooltips can have <b>alternate styles</b> to be displayed on,
19054     * which are defined by the theme set on Elementary. This function
19055     * works analogously as elm_object_tooltip_style_set(), but here
19056     * applied only to genlist item objects. The default style for
19057     * tooltips is @c "default".
19058     *
19059     * @note before you set a style you should define a tooltip with
19060     *       elm_genlist_item_tooltip_content_cb_set() or
19061     *       elm_genlist_item_tooltip_text_set()
19062     *
19063     * @see elm_genlist_item_tooltip_style_get()
19064     *
19065     * @ingroup Genlist
19066     */
19067    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19068    /**
19069     * Get the style set a given genlist item's tooltip.
19070     *
19071     * @param item genlist item with tooltip already set on.
19072     * @return style the theme style in use, which defaults to
19073     *         "default". If the object does not have a tooltip set,
19074     *         then @c NULL is returned.
19075     *
19076     * @see elm_genlist_item_tooltip_style_set() for more details
19077     *
19078     * @ingroup Genlist
19079     */
19080    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19081    /**
19082     * @brief Disable size restrictions on an object's tooltip
19083     * @param item The tooltip's anchor object
19084     * @param disable If EINA_TRUE, size restrictions are disabled
19085     * @return EINA_FALSE on failure, EINA_TRUE on success
19086     *
19087     * This function allows a tooltip to expand beyond its parant window's canvas.
19088     * It will instead be limited only by the size of the display.
19089     */
19090    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19091    /**
19092     * @brief Retrieve size restriction state of an object's tooltip
19093     * @param item The tooltip's anchor object
19094     * @return If EINA_TRUE, size restrictions are disabled
19095     *
19096     * This function returns whether a tooltip is allowed to expand beyond
19097     * its parant window's canvas.
19098     * It will instead be limited only by the size of the display.
19099     */
19100    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19101    /**
19102     * Set the type of mouse pointer/cursor decoration to be shown,
19103     * when the mouse pointer is over the given genlist widget item
19104     *
19105     * @param item genlist item to customize cursor on
19106     * @param cursor the cursor type's name
19107     *
19108     * This function works analogously as elm_object_cursor_set(), but
19109     * here the cursor's changing area is restricted to the item's
19110     * area, and not the whole widget's. Note that that item cursors
19111     * have precedence over widget cursors, so that a mouse over @p
19112     * item will always show cursor @p type.
19113     *
19114     * If this function is called twice for an object, a previously set
19115     * cursor will be unset on the second call.
19116     *
19117     * @see elm_object_cursor_set()
19118     * @see elm_genlist_item_cursor_get()
19119     * @see elm_genlist_item_cursor_unset()
19120     *
19121     * @ingroup Genlist
19122     */
19123    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19124    /**
19125     * Get the type of mouse pointer/cursor decoration set to be shown,
19126     * when the mouse pointer is over the given genlist widget item
19127     *
19128     * @param item genlist item with custom cursor set
19129     * @return the cursor type's name or @c NULL, if no custom cursors
19130     * were set to @p item (and on errors)
19131     *
19132     * @see elm_object_cursor_get()
19133     * @see elm_genlist_item_cursor_set() for more details
19134     * @see elm_genlist_item_cursor_unset()
19135     *
19136     * @ingroup Genlist
19137     */
19138    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19139    /**
19140     * Unset any custom mouse pointer/cursor decoration set to be
19141     * shown, when the mouse pointer is over the given genlist widget
19142     * item, thus making it show the @b default cursor again.
19143     *
19144     * @param item a genlist item
19145     *
19146     * Use this call to undo any custom settings on this item's cursor
19147     * decoration, bringing it back to defaults (no custom style set).
19148     *
19149     * @see elm_object_cursor_unset()
19150     * @see elm_genlist_item_cursor_set() for more details
19151     *
19152     * @ingroup Genlist
19153     */
19154    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19155    /**
19156     * Set a different @b style for a given custom cursor set for a
19157     * genlist item.
19158     *
19159     * @param item genlist item with custom cursor set
19160     * @param style the <b>theme style</b> to use (e.g. @c "default",
19161     * @c "transparent", etc)
19162     *
19163     * This function only makes sense when one is using custom mouse
19164     * cursor decorations <b>defined in a theme file</b> , which can
19165     * have, given a cursor name/type, <b>alternate styles</b> on
19166     * it. It works analogously as elm_object_cursor_style_set(), but
19167     * here applied only to genlist item objects.
19168     *
19169     * @warning Before you set a cursor style you should have defined a
19170     *       custom cursor previously on the item, with
19171     *       elm_genlist_item_cursor_set()
19172     *
19173     * @see elm_genlist_item_cursor_engine_only_set()
19174     * @see elm_genlist_item_cursor_style_get()
19175     *
19176     * @ingroup Genlist
19177     */
19178    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19179    /**
19180     * Get the current @b style set for a given genlist item's custom
19181     * cursor
19182     *
19183     * @param item genlist item with custom cursor set.
19184     * @return style the cursor style in use. If the object does not
19185     *         have a cursor set, then @c NULL is returned.
19186     *
19187     * @see elm_genlist_item_cursor_style_set() for more details
19188     *
19189     * @ingroup Genlist
19190     */
19191    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19192    /**
19193     * Set if the (custom) cursor for a given genlist item should be
19194     * searched in its theme, also, or should only rely on the
19195     * rendering engine.
19196     *
19197     * @param item item with custom (custom) cursor already set on
19198     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19199     * only on those provided by the rendering engine, @c EINA_FALSE to
19200     * have them searched on the widget's theme, as well.
19201     *
19202     * @note This call is of use only if you've set a custom cursor
19203     * for genlist items, with elm_genlist_item_cursor_set().
19204     *
19205     * @note By default, cursors will only be looked for between those
19206     * provided by the rendering engine.
19207     *
19208     * @ingroup Genlist
19209     */
19210    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19211    /**
19212     * Get if the (custom) cursor for a given genlist item is being
19213     * searched in its theme, also, or is only relying on the rendering
19214     * engine.
19215     *
19216     * @param item a genlist item
19217     * @return @c EINA_TRUE, if cursors are being looked for only on
19218     * those provided by the rendering engine, @c EINA_FALSE if they
19219     * are being searched on the widget's theme, as well.
19220     *
19221     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19222     *
19223     * @ingroup Genlist
19224     */
19225    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19226    /**
19227     * Update the contents of all realized items.
19228     *
19229     * @param obj The genlist object.
19230     *
19231     * This updates all realized items by calling all the item class functions again
19232     * to get the icons, labels and states. Use this when the original
19233     * item data has changed and the changes are desired to be reflected.
19234     *
19235     * To update just one item, use elm_genlist_item_update().
19236     *
19237     * @see elm_genlist_realized_items_get()
19238     * @see elm_genlist_item_update()
19239     *
19240     * @ingroup Genlist
19241     */
19242    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19243    /**
19244     * Activate a genlist mode on an item
19245     *
19246     * @param item The genlist item
19247     * @param mode Mode name
19248     * @param mode_set Boolean to define set or unset mode.
19249     *
19250     * A genlist mode is a different way of selecting an item. Once a mode is
19251     * activated on an item, any other selected item is immediately unselected.
19252     * This feature provides an easy way of implementing a new kind of animation
19253     * for selecting an item, without having to entirely rewrite the item style
19254     * theme. However, the elm_genlist_selected_* API can't be used to get what
19255     * item is activate for a mode.
19256     *
19257     * The current item style will still be used, but applying a genlist mode to
19258     * an item will select it using a different kind of animation.
19259     *
19260     * The current active item for a mode can be found by
19261     * elm_genlist_mode_item_get().
19262     *
19263     * The characteristics of genlist mode are:
19264     * - Only one mode can be active at any time, and for only one item.
19265     * - Genlist handles deactivating other items when one item is activated.
19266     * - A mode is defined in the genlist theme (edc), and more modes can easily
19267     *   be added.
19268     * - A mode style and the genlist item style are different things. They
19269     *   can be combined to provide a default style to the item, with some kind
19270     *   of animation for that item when the mode is activated.
19271     *
19272     * When a mode is activated on an item, a new view for that item is created.
19273     * The theme of this mode defines the animation that will be used to transit
19274     * the item from the old view to the new view. This second (new) view will be
19275     * active for that item while the mode is active on the item, and will be
19276     * destroyed after the mode is totally deactivated from that item.
19277     *
19278     * @see elm_genlist_mode_get()
19279     * @see elm_genlist_mode_item_get()
19280     *
19281     * @ingroup Genlist
19282     */
19283    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19284    /**
19285     * Get the last (or current) genlist mode used.
19286     *
19287     * @param obj The genlist object
19288     *
19289     * This function just returns the name of the last used genlist mode. It will
19290     * be the current mode if it's still active.
19291     *
19292     * @see elm_genlist_item_mode_set()
19293     * @see elm_genlist_mode_item_get()
19294     *
19295     * @ingroup Genlist
19296     */
19297    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19298    /**
19299     * Get active genlist mode item
19300     *
19301     * @param obj The genlist object
19302     * @return The active item for that current mode. Or @c NULL if no item is
19303     * activated with any mode.
19304     *
19305     * This function returns the item that was activated with a mode, by the
19306     * function elm_genlist_item_mode_set().
19307     *
19308     * @see elm_genlist_item_mode_set()
19309     * @see elm_genlist_mode_get()
19310     *
19311     * @ingroup Genlist
19312     */
19313    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19314
19315    /**
19316     * Set reorder mode
19317     *
19318     * @param obj The genlist object
19319     * @param reorder_mode The reorder mode
19320     * (EINA_TRUE = on, EINA_FALSE = off)
19321     *
19322     * @ingroup Genlist
19323     */
19324    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19325
19326    /**
19327     * Get the reorder mode
19328     *
19329     * @param obj The genlist object
19330     * @return The reorder mode
19331     * (EINA_TRUE = on, EINA_FALSE = off)
19332     *
19333     * @ingroup Genlist
19334     */
19335    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19336
19337    /**
19338     * @}
19339     */
19340
19341    /**
19342     * @defgroup Check Check
19343     *
19344     * @image html img/widget/check/preview-00.png
19345     * @image latex img/widget/check/preview-00.eps
19346     * @image html img/widget/check/preview-01.png
19347     * @image latex img/widget/check/preview-01.eps
19348     * @image html img/widget/check/preview-02.png
19349     * @image latex img/widget/check/preview-02.eps
19350     *
19351     * @brief The check widget allows for toggling a value between true and
19352     * false.
19353     *
19354     * Check objects are a lot like radio objects in layout and functionality
19355     * except they do not work as a group, but independently and only toggle the
19356     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19357     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19358     * returns the current state. For convenience, like the radio objects, you
19359     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19360     * for it to modify.
19361     *
19362     * Signals that you can add callbacks for are:
19363     * "changed" - This is called whenever the user changes the state of one of
19364     *             the check object(event_info is NULL).
19365     *
19366     * @ref tutorial_check should give you a firm grasp of how to use this widget.
19367     * @{
19368     */
19369    /**
19370     * @brief Add a new Check object
19371     *
19372     * @param parent The parent object
19373     * @return The new object or NULL if it cannot be created
19374     */
19375    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19376    /**
19377     * @brief Set the text label of the check object
19378     *
19379     * @param obj The check object
19380     * @param label The text label string in UTF-8
19381     *
19382     * @deprecated use elm_object_text_set() instead.
19383     */
19384    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19385    /**
19386     * @brief Get the text label of the check object
19387     *
19388     * @param obj The check object
19389     * @return The text label string in UTF-8
19390     *
19391     * @deprecated use elm_object_text_get() instead.
19392     */
19393    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19394    /**
19395     * @brief Set the icon object of the check object
19396     *
19397     * @param obj The check object
19398     * @param icon The icon object
19399     *
19400     * Once the icon object is set, a previously set one will be deleted.
19401     * If you want to keep that old content object, use the
19402     * elm_check_icon_unset() function.
19403     */
19404    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19405    /**
19406     * @brief Get the icon object of the check object
19407     *
19408     * @param obj The check object
19409     * @return The icon object
19410     */
19411    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19412    /**
19413     * @brief Unset the icon used for the check object
19414     *
19415     * @param obj The check object
19416     * @return The icon object that was being used
19417     *
19418     * Unparent and return the icon object which was set for this widget.
19419     */
19420    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19421    /**
19422     * @brief Set the on/off state of the check object
19423     *
19424     * @param obj The check object
19425     * @param state The state to use (1 == on, 0 == off)
19426     *
19427     * This sets the state of the check. If set
19428     * with elm_check_state_pointer_set() the state of that variable is also
19429     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19430     */
19431    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19432    /**
19433     * @brief Get the state of the check object
19434     *
19435     * @param obj The check object
19436     * @return The boolean state
19437     */
19438    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19439    /**
19440     * @brief Set a convenience pointer to a boolean to change
19441     *
19442     * @param obj The check object
19443     * @param statep Pointer to the boolean to modify
19444     *
19445     * This sets a pointer to a boolean, that, in addition to the check objects
19446     * state will also be modified directly. To stop setting the object pointed
19447     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19448     * then when this is called, the check objects state will also be modified to
19449     * reflect the value of the boolean @p statep points to, just like calling
19450     * elm_check_state_set().
19451     */
19452    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19453    /**
19454     * @}
19455     */
19456
19457    /**
19458     * @defgroup Radio Radio
19459     *
19460     * @image html img/widget/radio/preview-00.png
19461     * @image latex img/widget/radio/preview-00.eps
19462     *
19463     * @brief Radio is a widget that allows for 1 or more options to be displayed
19464     * and have the user choose only 1 of them.
19465     *
19466     * A radio object contains an indicator, an optional Label and an optional
19467     * icon object. While it's possible to have a group of only one radio they,
19468     * are normally used in groups of 2 or more. To add a radio to a group use
19469     * elm_radio_group_add(). The radio object(s) will select from one of a set
19470     * of integer values, so any value they are configuring needs to be mapped to
19471     * a set of integers. To configure what value that radio object represents,
19472     * use  elm_radio_state_value_set() to set the integer it represents. To set
19473     * the value the whole group(which one is currently selected) is to indicate
19474     * use elm_radio_value_set() on any group member, and to get the groups value
19475     * use elm_radio_value_get(). For convenience the radio objects are also able
19476     * to directly set an integer(int) to the value that is selected. To specify
19477     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19478     * The radio objects will modify this directly. That implies the pointer must
19479     * point to valid memory for as long as the radio objects exist.
19480     *
19481     * Signals that you can add callbacks for are:
19482     * @li changed - This is called whenever the user changes the state of one of
19483     * the radio objects within the group of radio objects that work together.
19484     *
19485     * @ref tutorial_radio show most of this API in action.
19486     * @{
19487     */
19488    /**
19489     * @brief Add a new radio to the parent
19490     *
19491     * @param parent The parent object
19492     * @return The new object or NULL if it cannot be created
19493     */
19494    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19495    /**
19496     * @brief Set the text label of the radio object
19497     *
19498     * @param obj The radio object
19499     * @param label The text label string in UTF-8
19500     *
19501     * @deprecated use elm_object_text_set() instead.
19502     */
19503    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19504    /**
19505     * @brief Get the text label of the radio object
19506     *
19507     * @param obj The radio object
19508     * @return The text label string in UTF-8
19509     *
19510     * @deprecated use elm_object_text_set() instead.
19511     */
19512    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19513    /**
19514     * @brief Set the icon object of the radio object
19515     *
19516     * @param obj The radio object
19517     * @param icon The icon object
19518     *
19519     * Once the icon object is set, a previously set one will be deleted. If you
19520     * want to keep that old content object, use the elm_radio_icon_unset()
19521     * function.
19522     */
19523    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19524    /**
19525     * @brief Get the icon object of the radio object
19526     *
19527     * @param obj The radio object
19528     * @return The icon object
19529     *
19530     * @see elm_radio_icon_set()
19531     */
19532    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19533    /**
19534     * @brief Unset the icon used for the radio object
19535     *
19536     * @param obj The radio object
19537     * @return The icon object that was being used
19538     *
19539     * Unparent and return the icon object which was set for this widget.
19540     *
19541     * @see elm_radio_icon_set()
19542     */
19543    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19544    /**
19545     * @brief Add this radio to a group of other radio objects
19546     *
19547     * @param obj The radio object
19548     * @param group Any object whose group the @p obj is to join.
19549     *
19550     * Radio objects work in groups. Each member should have a different integer
19551     * value assigned. In order to have them work as a group, they need to know
19552     * about each other. This adds the given radio object to the group of which
19553     * the group object indicated is a member.
19554     */
19555    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19556    /**
19557     * @brief Set the integer value that this radio object represents
19558     *
19559     * @param obj The radio object
19560     * @param value The value to use if this radio object is selected
19561     *
19562     * This sets the value of the radio.
19563     */
19564    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19565    /**
19566     * @brief Get the integer value that this radio object represents
19567     *
19568     * @param obj The radio object
19569     * @return The value used if this radio object is selected
19570     *
19571     * This gets the value of the radio.
19572     *
19573     * @see elm_radio_value_set()
19574     */
19575    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19576    /**
19577     * @brief Set the value of the radio.
19578     *
19579     * @param obj The radio object
19580     * @param value The value to use for the group
19581     *
19582     * This sets the value of the radio group and will also set the value if
19583     * pointed to, to the value supplied, but will not call any callbacks.
19584     */
19585    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19586    /**
19587     * @brief Get the state of the radio object
19588     *
19589     * @param obj The radio object
19590     * @return The integer state
19591     */
19592    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19593    /**
19594     * @brief Set a convenience pointer to a integer to change
19595     *
19596     * @param obj The radio object
19597     * @param valuep Pointer to the integer to modify
19598     *
19599     * This sets a pointer to a integer, that, in addition to the radio objects
19600     * state will also be modified directly. To stop setting the object pointed
19601     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19602     * when this is called, the radio objects state will also be modified to
19603     * reflect the value of the integer valuep points to, just like calling
19604     * elm_radio_value_set().
19605     */
19606    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19607    /**
19608     * @}
19609     */
19610
19611    /**
19612     * @defgroup Pager Pager
19613     *
19614     * @image html img/widget/pager/preview-00.png
19615     * @image latex img/widget/pager/preview-00.eps
19616     *
19617     * @brief Widget that allows flipping between 1 or more “pages” of objects.
19618     *
19619     * The flipping between “pages” of objects is animated. All content in pager
19620     * is kept in a stack, the last content to be added will be on the top of the
19621     * stack(be visible).
19622     *
19623     * Objects can be pushed or popped from the stack or deleted as normal.
19624     * Pushes and pops will animate (and a pop will delete the object once the
19625     * animation is finished). Any object already in the pager can be promoted to
19626     * the top(from its current stacking position) through the use of
19627     * elm_pager_content_promote(). Objects are pushed to the top with
19628     * elm_pager_content_push() and when the top item is no longer wanted, simply
19629     * pop it with elm_pager_content_pop() and it will also be deleted. If an
19630     * object is no longer needed and is not the top item, just delete it as
19631     * normal. You can query which objects are the top and bottom with
19632     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19633     *
19634     * Signals that you can add callbacks for are:
19635     * "hide,finished" - when the previous page is hided
19636     *
19637     * This widget has the following styles available:
19638     * @li default
19639     * @li fade
19640     * @li fade_translucide
19641     * @li fade_invisible
19642     * @note This styles affect only the flipping animations, the appearance when
19643     * not animating is unaffected by styles.
19644     *
19645     * @ref tutorial_pager gives a good overview of the usage of the API.
19646     * @{
19647     */
19648    /**
19649     * Add a new pager to the parent
19650     *
19651     * @param parent The parent object
19652     * @return The new object or NULL if it cannot be created
19653     *
19654     * @ingroup Pager
19655     */
19656    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19657    /**
19658     * @brief Push an object to the top of the pager stack (and show it).
19659     *
19660     * @param obj The pager object
19661     * @param content The object to push
19662     *
19663     * The object pushed becomes a child of the pager, it will be controlled and
19664     * deleted when the pager is deleted.
19665     *
19666     * @note If the content is already in the stack use
19667     * elm_pager_content_promote().
19668     * @warning Using this function on @p content already in the stack results in
19669     * undefined behavior.
19670     */
19671    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19672    /**
19673     * @brief Pop the object that is on top of the stack
19674     *
19675     * @param obj The pager object
19676     *
19677     * This pops the object that is on the top(visible) of the pager, makes it
19678     * disappear, then deletes the object. The object that was underneath it on
19679     * the stack will become visible.
19680     */
19681    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19682    /**
19683     * @brief Moves an object already in the pager stack to the top of the stack.
19684     *
19685     * @param obj The pager object
19686     * @param content The object to promote
19687     *
19688     * This will take the @p content and move it to the top of the stack as
19689     * if it had been pushed there.
19690     *
19691     * @note If the content isn't already in the stack use
19692     * elm_pager_content_push().
19693     * @warning Using this function on @p content not already in the stack
19694     * results in undefined behavior.
19695     */
19696    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19697    /**
19698     * @brief Return the object at the bottom of the pager stack
19699     *
19700     * @param obj The pager object
19701     * @return The bottom object or NULL if none
19702     */
19703    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19704    /**
19705     * @brief  Return the object at the top of the pager stack
19706     *
19707     * @param obj The pager object
19708     * @return The top object or NULL if none
19709     */
19710    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19711
19712    /**
19713     * @}
19714     */
19715
19716    /**
19717     * @defgroup Slideshow Slideshow
19718     *
19719     * @image html img/widget/slideshow/preview-00.png
19720     * @image latex img/widget/slideshow/preview-00.eps
19721     *
19722     * This widget, as the name indicates, is a pre-made image
19723     * slideshow panel, with API functions acting on (child) image
19724     * items presentation. Between those actions, are:
19725     * - advance to next/previous image
19726     * - select the style of image transition animation
19727     * - set the exhibition time for each image
19728     * - start/stop the slideshow
19729     *
19730     * The transition animations are defined in the widget's theme,
19731     * consequently new animations can be added without having to
19732     * update the widget's code.
19733     *
19734     * @section Slideshow_Items Slideshow items
19735     *
19736     * For slideshow items, just like for @ref Genlist "genlist" ones,
19737     * the user defines a @b classes, specifying functions that will be
19738     * called on the item's creation and deletion times.
19739     *
19740     * The #Elm_Slideshow_Item_Class structure contains the following
19741     * members:
19742     *
19743     * - @c func.get - When an item is displayed, this function is
19744     *   called, and it's where one should create the item object, de
19745     *   facto. For example, the object can be a pure Evas image object
19746     *   or an Elementary @ref Photocam "photocam" widget. See
19747     *   #SlideshowItemGetFunc.
19748     * - @c func.del - When an item is no more displayed, this function
19749     *   is called, where the user must delete any data associated to
19750     *   the item. See #SlideshowItemDelFunc.
19751     *
19752     * @section Slideshow_Caching Slideshow caching
19753     *
19754     * The slideshow provides facilities to have items adjacent to the
19755     * one being displayed <b>already "realized"</b> (i.e. loaded) for
19756     * you, so that the system does not have to decode image data
19757     * anymore at the time it has to actually switch images on its
19758     * viewport. The user is able to set the numbers of items to be
19759     * cached @b before and @b after the current item, in the widget's
19760     * item list.
19761     *
19762     * Smart events one can add callbacks for are:
19763     *
19764     * - @c "changed" - when the slideshow switches its view to a new
19765     *   item
19766     *
19767     * List of examples for the slideshow widget:
19768     * @li @ref slideshow_example
19769     */
19770
19771    /**
19772     * @addtogroup Slideshow
19773     * @{
19774     */
19775
19776    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19777    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19778    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
19779    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19780    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19781
19782    /**
19783     * @struct _Elm_Slideshow_Item_Class
19784     *
19785     * Slideshow item class definition. See @ref Slideshow_Items for
19786     * field details.
19787     */
19788    struct _Elm_Slideshow_Item_Class
19789      {
19790         struct _Elm_Slideshow_Item_Class_Func
19791           {
19792              SlideshowItemGetFunc get;
19793              SlideshowItemDelFunc del;
19794           } func;
19795      }; /**< #Elm_Slideshow_Item_Class member definitions */
19796
19797    /**
19798     * Add a new slideshow widget to the given parent Elementary
19799     * (container) object
19800     *
19801     * @param parent The parent object
19802     * @return A new slideshow widget handle or @c NULL, on errors
19803     *
19804     * This function inserts a new slideshow widget on the canvas.
19805     *
19806     * @ingroup Slideshow
19807     */
19808    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19809
19810    /**
19811     * Add (append) a new item in a given slideshow widget.
19812     *
19813     * @param obj The slideshow object
19814     * @param itc The item class for the item
19815     * @param data The item's data
19816     * @return A handle to the item added or @c NULL, on errors
19817     *
19818     * Add a new item to @p obj's internal list of items, appending it.
19819     * The item's class must contain the function really fetching the
19820     * image object to show for this item, which could be an Evas image
19821     * object or an Elementary photo, for example. The @p data
19822     * parameter is going to be passed to both class functions of the
19823     * item.
19824     *
19825     * @see #Elm_Slideshow_Item_Class
19826     * @see elm_slideshow_item_sorted_insert()
19827     *
19828     * @ingroup Slideshow
19829     */
19830    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19831
19832    /**
19833     * Insert a new item into the given slideshow widget, using the @p func
19834     * function to sort items (by item handles).
19835     *
19836     * @param obj The slideshow object
19837     * @param itc The item class for the item
19838     * @param data The item's data
19839     * @param func The comparing function to be used to sort slideshow
19840     * items <b>by #Elm_Slideshow_Item item handles</b>
19841     * @return Returns The slideshow item handle, on success, or
19842     * @c NULL, on errors
19843     *
19844     * Add a new item to @p obj's internal list of items, in a position
19845     * determined by the @p func comparing function. The item's class
19846     * must contain the function really fetching the image object to
19847     * show for this item, which could be an Evas image object or an
19848     * Elementary photo, for example. The @p data parameter is going to
19849     * be passed to both class functions of the item.
19850     *
19851     * @see #Elm_Slideshow_Item_Class
19852     * @see elm_slideshow_item_add()
19853     *
19854     * @ingroup Slideshow
19855     */
19856    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);
19857
19858    /**
19859     * Display a given slideshow widget's item, programmatically.
19860     *
19861     * @param obj The slideshow object
19862     * @param item The item to display on @p obj's viewport
19863     *
19864     * The change between the current item and @p item will use the
19865     * transition @p obj is set to use (@see
19866     * elm_slideshow_transition_set()).
19867     *
19868     * @ingroup Slideshow
19869     */
19870    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19871
19872    /**
19873     * Slide to the @b next item, in a given slideshow widget
19874     *
19875     * @param obj The slideshow object
19876     *
19877     * The sliding animation @p obj is set to use will be the
19878     * transition effect used, after this call is issued.
19879     *
19880     * @note If the end of the slideshow's internal list of items is
19881     * reached, it'll wrap around to the list's beginning, again.
19882     *
19883     * @ingroup Slideshow
19884     */
19885    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19886
19887    /**
19888     * Slide to the @b previous item, in a given slideshow widget
19889     *
19890     * @param obj The slideshow object
19891     *
19892     * The sliding animation @p obj is set to use will be the
19893     * transition effect used, after this call is issued.
19894     *
19895     * @note If the beginning of the slideshow's internal list of items
19896     * is reached, it'll wrap around to the list's end, again.
19897     *
19898     * @ingroup Slideshow
19899     */
19900    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19901
19902    /**
19903     * Returns the list of sliding transition/effect names available, for a
19904     * given slideshow widget.
19905     *
19906     * @param obj The slideshow object
19907     * @return The list of transitions (list of @b stringshared strings
19908     * as data)
19909     *
19910     * The transitions, which come from @p obj's theme, must be an EDC
19911     * data item named @c "transitions" on the theme file, with (prefix)
19912     * names of EDC programs actually implementing them.
19913     *
19914     * The available transitions for slideshows on the default theme are:
19915     * - @c "fade" - the current item fades out, while the new one
19916     *   fades in to the slideshow's viewport.
19917     * - @c "black_fade" - the current item fades to black, and just
19918     *   then, the new item will fade in.
19919     * - @c "horizontal" - the current item slides horizontally, until
19920     *   it gets out of the slideshow's viewport, while the new item
19921     *   comes from the left to take its place.
19922     * - @c "vertical" - the current item slides vertically, until it
19923     *   gets out of the slideshow's viewport, while the new item comes
19924     *   from the bottom to take its place.
19925     * - @c "square" - the new item starts to appear from the middle of
19926     *   the current one, but with a tiny size, growing until its
19927     *   target (full) size and covering the old one.
19928     *
19929     * @warning The stringshared strings get no new references
19930     * exclusive to the user grabbing the list, here, so if you'd like
19931     * to use them out of this call's context, you'd better @c
19932     * eina_stringshare_ref() them.
19933     *
19934     * @see elm_slideshow_transition_set()
19935     *
19936     * @ingroup Slideshow
19937     */
19938    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19939
19940    /**
19941     * Set the current slide transition/effect in use for a given
19942     * slideshow widget
19943     *
19944     * @param obj The slideshow object
19945     * @param transition The new transition's name string
19946     *
19947     * If @p transition is implemented in @p obj's theme (i.e., is
19948     * contained in the list returned by
19949     * elm_slideshow_transitions_get()), this new sliding effect will
19950     * be used on the widget.
19951     *
19952     * @see elm_slideshow_transitions_get() for more details
19953     *
19954     * @ingroup Slideshow
19955     */
19956    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19957
19958    /**
19959     * Get the current slide transition/effect in use for a given
19960     * slideshow widget
19961     *
19962     * @param obj The slideshow object
19963     * @return The current transition's name
19964     *
19965     * @see elm_slideshow_transition_set() for more details
19966     *
19967     * @ingroup Slideshow
19968     */
19969    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19970
19971    /**
19972     * Set the interval between each image transition on a given
19973     * slideshow widget, <b>and start the slideshow, itself</b>
19974     *
19975     * @param obj The slideshow object
19976     * @param timeout The new displaying timeout for images
19977     *
19978     * After this call, the slideshow widget will start cycling its
19979     * view, sequentially and automatically, with the images of the
19980     * items it has. The time between each new image displayed is going
19981     * to be @p timeout, in @b seconds. If a different timeout was set
19982     * previously and an slideshow was in progress, it will continue
19983     * with the new time between transitions, after this call.
19984     *
19985     * @note A value less than or equal to 0 on @p timeout will disable
19986     * the widget's internal timer, thus halting any slideshow which
19987     * could be happening on @p obj.
19988     *
19989     * @see elm_slideshow_timeout_get()
19990     *
19991     * @ingroup Slideshow
19992     */
19993    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19994
19995    /**
19996     * Get the interval set for image transitions on a given slideshow
19997     * widget.
19998     *
19999     * @param obj The slideshow object
20000     * @return Returns the timeout set on it
20001     *
20002     * @see elm_slideshow_timeout_set() for more details
20003     *
20004     * @ingroup Slideshow
20005     */
20006    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20007
20008    /**
20009     * Set if, after a slideshow is started, for a given slideshow
20010     * widget, its items should be displayed cyclically or not.
20011     *
20012     * @param obj The slideshow object
20013     * @param loop Use @c EINA_TRUE to make it cycle through items or
20014     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20015     * list of items
20016     *
20017     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20018     * ignore what is set by this functions, i.e., they'll @b always
20019     * cycle through items. This affects only the "automatic"
20020     * slideshow, as set by elm_slideshow_timeout_set().
20021     *
20022     * @see elm_slideshow_loop_get()
20023     *
20024     * @ingroup Slideshow
20025     */
20026    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20027
20028    /**
20029     * Get if, after a slideshow is started, for a given slideshow
20030     * widget, its items are to be displayed cyclically or not.
20031     *
20032     * @param obj The slideshow object
20033     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20034     * through or @c EINA_FALSE, otherwise
20035     *
20036     * @see elm_slideshow_loop_set() for more details
20037     *
20038     * @ingroup Slideshow
20039     */
20040    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20041
20042    /**
20043     * Remove all items from a given slideshow widget
20044     *
20045     * @param obj The slideshow object
20046     *
20047     * This removes (and deletes) all items in @p obj, leaving it
20048     * empty.
20049     *
20050     * @see elm_slideshow_item_del(), to remove just one item.
20051     *
20052     * @ingroup Slideshow
20053     */
20054    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20055
20056    /**
20057     * Get the internal list of items in a given slideshow widget.
20058     *
20059     * @param obj The slideshow object
20060     * @return The list of items (#Elm_Slideshow_Item as data) or
20061     * @c NULL on errors.
20062     *
20063     * This list is @b not to be modified in any way and must not be
20064     * freed. Use the list members with functions like
20065     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20066     *
20067     * @warning This list is only valid until @p obj object's internal
20068     * items list is changed. It should be fetched again with another
20069     * call to this function when changes happen.
20070     *
20071     * @ingroup Slideshow
20072     */
20073    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20074
20075    /**
20076     * Delete a given item from a slideshow widget.
20077     *
20078     * @param item The slideshow item
20079     *
20080     * @ingroup Slideshow
20081     */
20082    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20083
20084    /**
20085     * Return the data associated with a given slideshow item
20086     *
20087     * @param item The slideshow item
20088     * @return Returns the data associated to this item
20089     *
20090     * @ingroup Slideshow
20091     */
20092    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20093
20094    /**
20095     * Returns the currently displayed item, in a given slideshow widget
20096     *
20097     * @param obj The slideshow object
20098     * @return A handle to the item being displayed in @p obj or
20099     * @c NULL, if none is (and on errors)
20100     *
20101     * @ingroup Slideshow
20102     */
20103    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20104
20105    /**
20106     * Get the real Evas object created to implement the view of a
20107     * given slideshow item
20108     *
20109     * @param item The slideshow item.
20110     * @return the Evas object implementing this item's view.
20111     *
20112     * This returns the actual Evas object used to implement the
20113     * specified slideshow item's view. This may be @c NULL, as it may
20114     * not have been created or may have been deleted, at any time, by
20115     * the slideshow. <b>Do not modify this object</b> (move, resize,
20116     * show, hide, etc.), as the slideshow is controlling it. This
20117     * function is for querying, emitting custom signals or hooking
20118     * lower level callbacks for events on that object. Do not delete
20119     * this object under any circumstances.
20120     *
20121     * @see elm_slideshow_item_data_get()
20122     *
20123     * @ingroup Slideshow
20124     */
20125    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20126
20127    /**
20128     * Get the the item, in a given slideshow widget, placed at
20129     * position @p nth, in its internal items list
20130     *
20131     * @param obj The slideshow object
20132     * @param nth The number of the item to grab a handle to (0 being
20133     * the first)
20134     * @return The item stored in @p obj at position @p nth or @c NULL,
20135     * if there's no item with that index (and on errors)
20136     *
20137     * @ingroup Slideshow
20138     */
20139    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20140
20141    /**
20142     * Set the current slide layout in use for a given slideshow widget
20143     *
20144     * @param obj The slideshow object
20145     * @param layout The new layout's name string
20146     *
20147     * If @p layout is implemented in @p obj's theme (i.e., is contained
20148     * in the list returned by elm_slideshow_layouts_get()), this new
20149     * images layout will be used on the widget.
20150     *
20151     * @see elm_slideshow_layouts_get() for more details
20152     *
20153     * @ingroup Slideshow
20154     */
20155    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20156
20157    /**
20158     * Get the current slide layout in use for a given slideshow widget
20159     *
20160     * @param obj The slideshow object
20161     * @return The current layout's name
20162     *
20163     * @see elm_slideshow_layout_set() for more details
20164     *
20165     * @ingroup Slideshow
20166     */
20167    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20168
20169    /**
20170     * Returns the list of @b layout names available, for a given
20171     * slideshow widget.
20172     *
20173     * @param obj The slideshow object
20174     * @return The list of layouts (list of @b stringshared strings
20175     * as data)
20176     *
20177     * Slideshow layouts will change how the widget is to dispose each
20178     * image item in its viewport, with regard to cropping, scaling,
20179     * etc.
20180     *
20181     * The layouts, which come from @p obj's theme, must be an EDC
20182     * data item name @c "layouts" on the theme file, with (prefix)
20183     * names of EDC programs actually implementing them.
20184     *
20185     * The available layouts for slideshows on the default theme are:
20186     * - @c "fullscreen" - item images with original aspect, scaled to
20187     *   touch top and down slideshow borders or, if the image's heigh
20188     *   is not enough, left and right slideshow borders.
20189     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20190     *   one, but always leaving 10% of the slideshow's dimensions of
20191     *   distance between the item image's borders and the slideshow
20192     *   borders, for each axis.
20193     *
20194     * @warning The stringshared strings get no new references
20195     * exclusive to the user grabbing the list, here, so if you'd like
20196     * to use them out of this call's context, you'd better @c
20197     * eina_stringshare_ref() them.
20198     *
20199     * @see elm_slideshow_layout_set()
20200     *
20201     * @ingroup Slideshow
20202     */
20203    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20204
20205    /**
20206     * Set the number of items to cache, on a given slideshow widget,
20207     * <b>before the current item</b>
20208     *
20209     * @param obj The slideshow object
20210     * @param count Number of items to cache before the current one
20211     *
20212     * The default value for this property is @c 2. See
20213     * @ref Slideshow_Caching "slideshow caching" for more details.
20214     *
20215     * @see elm_slideshow_cache_before_get()
20216     *
20217     * @ingroup Slideshow
20218     */
20219    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20220
20221    /**
20222     * Retrieve the number of items to cache, on a given slideshow widget,
20223     * <b>before the current item</b>
20224     *
20225     * @param obj The slideshow object
20226     * @return The number of items set to be cached before the current one
20227     *
20228     * @see elm_slideshow_cache_before_set() for more details
20229     *
20230     * @ingroup Slideshow
20231     */
20232    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20233
20234    /**
20235     * Set the number of items to cache, on a given slideshow widget,
20236     * <b>after the current item</b>
20237     *
20238     * @param obj The slideshow object
20239     * @param count Number of items to cache after the current one
20240     *
20241     * The default value for this property is @c 2. See
20242     * @ref Slideshow_Caching "slideshow caching" for more details.
20243     *
20244     * @see elm_slideshow_cache_after_get()
20245     *
20246     * @ingroup Slideshow
20247     */
20248    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20249
20250    /**
20251     * Retrieve the number of items to cache, on a given slideshow widget,
20252     * <b>after the current item</b>
20253     *
20254     * @param obj The slideshow object
20255     * @return The number of items set to be cached after the current one
20256     *
20257     * @see elm_slideshow_cache_after_set() for more details
20258     *
20259     * @ingroup Slideshow
20260     */
20261    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20262
20263    /**
20264     * Get the number of items stored in a given slideshow widget
20265     *
20266     * @param obj The slideshow object
20267     * @return The number of items on @p obj, at the moment of this call
20268     *
20269     * @ingroup Slideshow
20270     */
20271    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20272
20273    /**
20274     * @}
20275     */
20276
20277    /**
20278     * @defgroup Fileselector File Selector
20279     *
20280     * @image html img/widget/fileselector/preview-00.png
20281     * @image latex img/widget/fileselector/preview-00.eps
20282     *
20283     * A file selector is a widget that allows a user to navigate
20284     * through a file system, reporting file selections back via its
20285     * API.
20286     *
20287     * It contains shortcut buttons for home directory (@c ~) and to
20288     * jump one directory upwards (..), as well as cancel/ok buttons to
20289     * confirm/cancel a given selection. After either one of those two
20290     * former actions, the file selector will issue its @c "done" smart
20291     * callback.
20292     *
20293     * There's a text entry on it, too, showing the name of the current
20294     * selection. There's the possibility of making it editable, so it
20295     * is useful on file saving dialogs on applications, where one
20296     * gives a file name to save contents to, in a given directory in
20297     * the system. This custom file name will be reported on the @c
20298     * "done" smart callback (explained in sequence).
20299     *
20300     * Finally, it has a view to display file system items into in two
20301     * possible forms:
20302     * - list
20303     * - grid
20304     *
20305     * If Elementary is built with support of the Ethumb thumbnailing
20306     * library, the second form of view will display preview thumbnails
20307     * of files which it supports.
20308     *
20309     * Smart callbacks one can register to:
20310     *
20311     * - @c "selected" - the user has clicked on a file (when not in
20312     *      folders-only mode) or directory (when in folders-only mode)
20313     * - @c "directory,open" - the list has been populated with new
20314     *      content (@c event_info is a pointer to the directory's
20315     *      path, a @b stringshared string)
20316     * - @c "done" - the user has clicked on the "ok" or "cancel"
20317     *      buttons (@c event_info is a pointer to the selection's
20318     *      path, a @b stringshared string)
20319     *
20320     * Here is an example on its usage:
20321     * @li @ref fileselector_example
20322     */
20323
20324    /**
20325     * @addtogroup Fileselector
20326     * @{
20327     */
20328
20329    /**
20330     * Defines how a file selector widget is to layout its contents
20331     * (file system entries).
20332     */
20333    typedef enum _Elm_Fileselector_Mode
20334      {
20335         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20336         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20337         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20338      } Elm_Fileselector_Mode;
20339
20340    /**
20341     * Add a new file selector widget to the given parent Elementary
20342     * (container) object
20343     *
20344     * @param parent The parent object
20345     * @return a new file selector widget handle or @c NULL, on errors
20346     *
20347     * This function inserts a new file selector widget on the canvas.
20348     *
20349     * @ingroup Fileselector
20350     */
20351    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20352
20353    /**
20354     * Enable/disable the file name entry box where the user can type
20355     * in a name for a file, in a given file selector widget
20356     *
20357     * @param obj The file selector object
20358     * @param is_save @c EINA_TRUE to make the file selector a "saving
20359     * dialog", @c EINA_FALSE otherwise
20360     *
20361     * Having the entry editable is useful on file saving dialogs on
20362     * applications, where one gives a file name to save contents to,
20363     * in a given directory in the system. This custom file name will
20364     * be reported on the @c "done" smart callback.
20365     *
20366     * @see elm_fileselector_is_save_get()
20367     *
20368     * @ingroup Fileselector
20369     */
20370    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20371
20372    /**
20373     * Get whether the given file selector is in "saving dialog" mode
20374     *
20375     * @param obj The file selector object
20376     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20377     * mode, @c EINA_FALSE otherwise (and on errors)
20378     *
20379     * @see elm_fileselector_is_save_set() for more details
20380     *
20381     * @ingroup Fileselector
20382     */
20383    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20384
20385    /**
20386     * Enable/disable folder-only view for a given file selector widget
20387     *
20388     * @param obj The file selector object
20389     * @param only @c EINA_TRUE to make @p obj only display
20390     * directories, @c EINA_FALSE to make files to be displayed in it
20391     * too
20392     *
20393     * If enabled, the widget's view will only display folder items,
20394     * naturally.
20395     *
20396     * @see elm_fileselector_folder_only_get()
20397     *
20398     * @ingroup Fileselector
20399     */
20400    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20401
20402    /**
20403     * Get whether folder-only view is set for a given file selector
20404     * widget
20405     *
20406     * @param obj The file selector object
20407     * @return only @c EINA_TRUE if @p obj is only displaying
20408     * directories, @c EINA_FALSE if files are being displayed in it
20409     * too (and on errors)
20410     *
20411     * @see elm_fileselector_folder_only_get()
20412     *
20413     * @ingroup Fileselector
20414     */
20415    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20416
20417    /**
20418     * Enable/disable the "ok" and "cancel" buttons on a given file
20419     * selector widget
20420     *
20421     * @param obj The file selector object
20422     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20423     *
20424     * @note A file selector without those buttons will never emit the
20425     * @c "done" smart event, and is only usable if one is just hooking
20426     * to the other two events.
20427     *
20428     * @see elm_fileselector_buttons_ok_cancel_get()
20429     *
20430     * @ingroup Fileselector
20431     */
20432    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20433
20434    /**
20435     * Get whether the "ok" and "cancel" buttons on a given file
20436     * selector widget are being shown.
20437     *
20438     * @param obj The file selector object
20439     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20440     * otherwise (and on errors)
20441     *
20442     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20443     *
20444     * @ingroup Fileselector
20445     */
20446    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20447
20448    /**
20449     * Enable/disable a tree view in the given file selector widget,
20450     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20451     *
20452     * @param obj The file selector object
20453     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20454     * disable
20455     *
20456     * In a tree view, arrows are created on the sides of directories,
20457     * allowing them to expand in place.
20458     *
20459     * @note If it's in other mode, the changes made by this function
20460     * will only be visible when one switches back to "list" mode.
20461     *
20462     * @see elm_fileselector_expandable_get()
20463     *
20464     * @ingroup Fileselector
20465     */
20466    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20467
20468    /**
20469     * Get whether tree view is enabled for the given file selector
20470     * widget
20471     *
20472     * @param obj The file selector object
20473     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20474     * otherwise (and or errors)
20475     *
20476     * @see elm_fileselector_expandable_set() for more details
20477     *
20478     * @ingroup Fileselector
20479     */
20480    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20481
20482    /**
20483     * Set, programmatically, the @b directory that a given file
20484     * selector widget will display contents from
20485     *
20486     * @param obj The file selector object
20487     * @param path The path to display in @p obj
20488     *
20489     * This will change the @b directory that @p obj is displaying. It
20490     * will also clear the text entry area on the @p obj object, which
20491     * displays select files' names.
20492     *
20493     * @see elm_fileselector_path_get()
20494     *
20495     * @ingroup Fileselector
20496     */
20497    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20498
20499    /**
20500     * Get the parent directory's path that a given file selector
20501     * widget is displaying
20502     *
20503     * @param obj The file selector object
20504     * @return The (full) path of the directory the file selector is
20505     * displaying, a @b stringshared string
20506     *
20507     * @see elm_fileselector_path_set()
20508     *
20509     * @ingroup Fileselector
20510     */
20511    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20512
20513    /**
20514     * Set, programmatically, the currently selected file/directory in
20515     * the given file selector widget
20516     *
20517     * @param obj The file selector object
20518     * @param path The (full) path to a file or directory
20519     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20520     * latter case occurs if the directory or file pointed to do not
20521     * exist.
20522     *
20523     * @see elm_fileselector_selected_get()
20524     *
20525     * @ingroup Fileselector
20526     */
20527    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20528
20529    /**
20530     * Get the currently selected item's (full) path, in the given file
20531     * selector widget
20532     *
20533     * @param obj The file selector object
20534     * @return The absolute path of the selected item, a @b
20535     * stringshared string
20536     *
20537     * @note Custom editions on @p obj object's text entry, if made,
20538     * will appear on the return string of this function, naturally.
20539     *
20540     * @see elm_fileselector_selected_set() for more details
20541     *
20542     * @ingroup Fileselector
20543     */
20544    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20545
20546    /**
20547     * Set the mode in which a given file selector widget will display
20548     * (layout) file system entries in its view
20549     *
20550     * @param obj The file selector object
20551     * @param mode The mode of the fileselector, being it one of
20552     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20553     * first one, naturally, will display the files in a list. The
20554     * latter will make the widget to display its entries in a grid
20555     * form.
20556     *
20557     * @note By using elm_fileselector_expandable_set(), the user may
20558     * trigger a tree view for that list.
20559     *
20560     * @note If Elementary is built with support of the Ethumb
20561     * thumbnailing library, the second form of view will display
20562     * preview thumbnails of files which it supports. You must have
20563     * elm_need_ethumb() called in your Elementary for thumbnailing to
20564     * work, though.
20565     *
20566     * @see elm_fileselector_expandable_set().
20567     * @see elm_fileselector_mode_get().
20568     *
20569     * @ingroup Fileselector
20570     */
20571    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20572
20573    /**
20574     * Get the mode in which a given file selector widget is displaying
20575     * (layouting) file system entries in its view
20576     *
20577     * @param obj The fileselector object
20578     * @return The mode in which the fileselector is at
20579     *
20580     * @see elm_fileselector_mode_set() for more details
20581     *
20582     * @ingroup Fileselector
20583     */
20584    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20585
20586    /**
20587     * @}
20588     */
20589
20590    /**
20591     * @defgroup Progressbar Progress bar
20592     *
20593     * The progress bar is a widget for visually representing the
20594     * progress status of a given job/task.
20595     *
20596     * A progress bar may be horizontal or vertical. It may display an
20597     * icon besides it, as well as primary and @b units labels. The
20598     * former is meant to label the widget as a whole, while the
20599     * latter, which is formatted with floating point values (and thus
20600     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20601     * units"</c>), is meant to label the widget's <b>progress
20602     * value</b>. Label, icon and unit strings/objects are @b optional
20603     * for progress bars.
20604     *
20605     * A progress bar may be @b inverted, in which state it gets its
20606     * values inverted, with high values being on the left or top and
20607     * low values on the right or bottom, as opposed to normally have
20608     * the low values on the former and high values on the latter,
20609     * respectively, for horizontal and vertical modes.
20610     *
20611     * The @b span of the progress, as set by
20612     * elm_progressbar_span_size_set(), is its length (horizontally or
20613     * vertically), unless one puts size hints on the widget to expand
20614     * on desired directions, by any container. That length will be
20615     * scaled by the object or applications scaling factor. At any
20616     * point code can query the progress bar for its value with
20617     * elm_progressbar_value_get().
20618     *
20619     * Available widget styles for progress bars:
20620     * - @c "default"
20621     * - @c "wheel" (simple style, no text, no progression, only
20622     *      "pulse" effect is available)
20623     *
20624     * Here is an example on its usage:
20625     * @li @ref progressbar_example
20626     */
20627
20628    /**
20629     * Add a new progress bar widget to the given parent Elementary
20630     * (container) object
20631     *
20632     * @param parent The parent object
20633     * @return a new progress bar widget handle or @c NULL, on errors
20634     *
20635     * This function inserts a new progress bar widget on the canvas.
20636     *
20637     * @ingroup Progressbar
20638     */
20639    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20640
20641    /**
20642     * Set whether a given progress bar widget is at "pulsing mode" or
20643     * not.
20644     *
20645     * @param obj The progress bar object
20646     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20647     * @c EINA_FALSE to put it back to its default one
20648     *
20649     * By default, progress bars will display values from the low to
20650     * high value boundaries. There are, though, contexts in which the
20651     * state of progression of a given task is @b unknown.  For those,
20652     * one can set a progress bar widget to a "pulsing state", to give
20653     * the user an idea that some computation is being held, but
20654     * without exact progress values. In the default theme it will
20655     * animate its bar with the contents filling in constantly and back
20656     * to non-filled, in a loop. To start and stop this pulsing
20657     * animation, one has to explicitly call elm_progressbar_pulse().
20658     *
20659     * @see elm_progressbar_pulse_get()
20660     * @see elm_progressbar_pulse()
20661     *
20662     * @ingroup Progressbar
20663     */
20664    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20665
20666    /**
20667     * Get whether a given progress bar widget is at "pulsing mode" or
20668     * not.
20669     *
20670     * @param obj The progress bar object
20671     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20672     * if it's in the default one (and on errors)
20673     *
20674     * @ingroup Progressbar
20675     */
20676    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20677
20678    /**
20679     * Start/stop a given progress bar "pulsing" animation, if its
20680     * under that mode
20681     *
20682     * @param obj The progress bar object
20683     * @param state @c EINA_TRUE, to @b start the pulsing animation,
20684     * @c EINA_FALSE to @b stop it
20685     *
20686     * @note This call won't do anything if @p obj is not under "pulsing mode".
20687     *
20688     * @see elm_progressbar_pulse_set() for more details.
20689     *
20690     * @ingroup Progressbar
20691     */
20692    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20693
20694    /**
20695     * Set the progress value (in percentage) on a given progress bar
20696     * widget
20697     *
20698     * @param obj The progress bar object
20699     * @param val The progress value (@b must be between @c 0.0 and @c
20700     * 1.0)
20701     *
20702     * Use this call to set progress bar levels.
20703     *
20704     * @note If you passes a value out of the specified range for @p
20705     * val, it will be interpreted as the @b closest of the @b boundary
20706     * values in the range.
20707     *
20708     * @ingroup Progressbar
20709     */
20710    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20711
20712    /**
20713     * Get the progress value (in percentage) on a given progress bar
20714     * widget
20715     *
20716     * @param obj The progress bar object
20717     * @return The value of the progressbar
20718     *
20719     * @see elm_progressbar_value_set() for more details
20720     *
20721     * @ingroup Progressbar
20722     */
20723    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20724
20725    /**
20726     * Set the label of a given progress bar widget
20727     *
20728     * @param obj The progress bar object
20729     * @param label The text label string, in UTF-8
20730     *
20731     * @ingroup Progressbar
20732     * @deprecated use elm_object_text_set() instead.
20733     */
20734    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20735
20736    /**
20737     * Get the label of a given progress bar widget
20738     *
20739     * @param obj The progressbar object
20740     * @return The text label string, in UTF-8
20741     *
20742     * @ingroup Progressbar
20743     * @deprecated use elm_object_text_set() instead.
20744     */
20745    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20746
20747    /**
20748     * Set the icon object of a given progress bar widget
20749     *
20750     * @param obj The progress bar object
20751     * @param icon The icon object
20752     *
20753     * Use this call to decorate @p obj with an icon next to it.
20754     *
20755     * @note Once the icon object is set, a previously set one will be
20756     * deleted. If you want to keep that old content object, use the
20757     * elm_progressbar_icon_unset() function.
20758     *
20759     * @see elm_progressbar_icon_get()
20760     *
20761     * @ingroup Progressbar
20762     */
20763    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20764
20765    /**
20766     * Retrieve the icon object set for a given progress bar widget
20767     *
20768     * @param obj The progress bar object
20769     * @return The icon object's handle, if @p obj had one set, or @c NULL,
20770     * otherwise (and on errors)
20771     *
20772     * @see elm_progressbar_icon_set() for more details
20773     *
20774     * @ingroup Progressbar
20775     */
20776    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20777
20778    /**
20779     * Unset an icon set on a given progress bar widget
20780     *
20781     * @param obj The progress bar object
20782     * @return The icon object that was being used, if any was set, or
20783     * @c NULL, otherwise (and on errors)
20784     *
20785     * This call will unparent and return the icon object which was set
20786     * for this widget, previously, on success.
20787     *
20788     * @see elm_progressbar_icon_set() for more details
20789     *
20790     * @ingroup Progressbar
20791     */
20792    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20793
20794    /**
20795     * Set the (exact) length of the bar region of a given progress bar
20796     * widget
20797     *
20798     * @param obj The progress bar object
20799     * @param size The length of the progress bar's bar region
20800     *
20801     * This sets the minimum width (when in horizontal mode) or height
20802     * (when in vertical mode) of the actual bar area of the progress
20803     * bar @p obj. This in turn affects the object's minimum size. Use
20804     * this when you're not setting other size hints expanding on the
20805     * given direction (like weight and alignment hints) and you would
20806     * like it to have a specific size.
20807     *
20808     * @note Icon, label and unit text around @p obj will require their
20809     * own space, which will make @p obj to require more the @p size,
20810     * actually.
20811     *
20812     * @see elm_progressbar_span_size_get()
20813     *
20814     * @ingroup Progressbar
20815     */
20816    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20817
20818    /**
20819     * Get the length set for the bar region of a given progress bar
20820     * widget
20821     *
20822     * @param obj The progress bar object
20823     * @return The length of the progress bar's bar region
20824     *
20825     * If that size was not set previously, with
20826     * elm_progressbar_span_size_set(), this call will return @c 0.
20827     *
20828     * @ingroup Progressbar
20829     */
20830    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20831
20832    /**
20833     * Set the format string for a given progress bar widget's units
20834     * label
20835     *
20836     * @param obj The progress bar object
20837     * @param format The format string for @p obj's units label
20838     *
20839     * If @c NULL is passed on @p format, it will make @p obj's units
20840     * area to be hidden completely. If not, it'll set the <b>format
20841     * string</b> for the units label's @b text. The units label is
20842     * provided a floating point value, so the units text is up display
20843     * at most one floating point falue. Note that the units label is
20844     * optional. Use a format string such as "%1.2f meters" for
20845     * example.
20846     *
20847     * @note The default format string for a progress bar is an integer
20848     * percentage, as in @c "%.0f %%".
20849     *
20850     * @see elm_progressbar_unit_format_get()
20851     *
20852     * @ingroup Progressbar
20853     */
20854    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20855
20856    /**
20857     * Retrieve the format string set for a given progress bar widget's
20858     * units label
20859     *
20860     * @param obj The progress bar object
20861     * @return The format set string for @p obj's units label or
20862     * @c NULL, if none was set (and on errors)
20863     *
20864     * @see elm_progressbar_unit_format_set() for more details
20865     *
20866     * @ingroup Progressbar
20867     */
20868    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20869
20870    /**
20871     * Set the orientation of a given progress bar widget
20872     *
20873     * @param obj The progress bar object
20874     * @param horizontal Use @c EINA_TRUE to make @p obj to be
20875     * @b horizontal, @c EINA_FALSE to make it @b vertical
20876     *
20877     * Use this function to change how your progress bar is to be
20878     * disposed: vertically or horizontally.
20879     *
20880     * @see elm_progressbar_horizontal_get()
20881     *
20882     * @ingroup Progressbar
20883     */
20884    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20885
20886    /**
20887     * Retrieve the orientation of a given progress bar widget
20888     *
20889     * @param obj The progress bar object
20890     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20891     * @c EINA_FALSE if it's @b vertical (and on errors)
20892     *
20893     * @see elm_progressbar_horizontal_set() for more details
20894     *
20895     * @ingroup Progressbar
20896     */
20897    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20898
20899    /**
20900     * Invert a given progress bar widget's displaying values order
20901     *
20902     * @param obj The progress bar object
20903     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20904     * @c EINA_FALSE to bring it back to default, non-inverted values.
20905     *
20906     * A progress bar may be @b inverted, in which state it gets its
20907     * values inverted, with high values being on the left or top and
20908     * low values on the right or bottom, as opposed to normally have
20909     * the low values on the former and high values on the latter,
20910     * respectively, for horizontal and vertical modes.
20911     *
20912     * @see elm_progressbar_inverted_get()
20913     *
20914     * @ingroup Progressbar
20915     */
20916    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20917
20918    /**
20919     * Get whether a given progress bar widget's displaying values are
20920     * inverted or not
20921     *
20922     * @param obj The progress bar object
20923     * @return @c EINA_TRUE, if @p obj has inverted values,
20924     * @c EINA_FALSE otherwise (and on errors)
20925     *
20926     * @see elm_progressbar_inverted_set() for more details
20927     *
20928     * @ingroup Progressbar
20929     */
20930    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20931
20932    /**
20933     * @defgroup Separator Separator
20934     *
20935     * @brief Separator is a very thin object used to separate other objects.
20936     *
20937     * A separator can be vertical or horizontal.
20938     *
20939     * @ref tutorial_separator is a good example of how to use a separator.
20940     * @{
20941     */
20942    /**
20943     * @brief Add a separator object to @p parent
20944     *
20945     * @param parent The parent object
20946     *
20947     * @return The separator object, or NULL upon failure
20948     */
20949    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20950    /**
20951     * @brief Set the horizontal mode of a separator object
20952     *
20953     * @param obj The separator object
20954     * @param horizontal If true, the separator is horizontal
20955     */
20956    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20957    /**
20958     * @brief Get the horizontal mode of a separator object
20959     *
20960     * @param obj The separator object
20961     * @return If true, the separator is horizontal
20962     *
20963     * @see elm_separator_horizontal_set()
20964     */
20965    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20966    /**
20967     * @}
20968     */
20969
20970    /**
20971     * @defgroup Spinner Spinner
20972     * @ingroup Elementary
20973     *
20974     * @image html img/widget/spinner/preview-00.png
20975     * @image latex img/widget/spinner/preview-00.eps
20976     *
20977     * A spinner is a widget which allows the user to increase or decrease
20978     * numeric values using arrow buttons, or edit values directly, clicking
20979     * over it and typing the new value.
20980     *
20981     * By default the spinner will not wrap and has a label
20982     * of "%.0f" (just showing the integer value of the double).
20983     *
20984     * A spinner has a label that is formatted with floating
20985     * point values and thus accepts a printf-style format string, like
20986     * “%1.2f units”.
20987     *
20988     * It also allows specific values to be replaced by pre-defined labels.
20989     *
20990     * Smart callbacks one can register to:
20991     *
20992     * - "changed" - Whenever the spinner value is changed.
20993     * - "delay,changed" - A short time after the value is changed by the user.
20994     *    This will be called only when the user stops dragging for a very short
20995     *    period or when they release their finger/mouse, so it avoids possibly
20996     *    expensive reactions to the value change.
20997     *
20998     * Available styles for it:
20999     * - @c "default";
21000     * - @c "vertical": up/down buttons at the right side and text left aligned.
21001     *
21002     * Here is an example on its usage:
21003     * @ref spinner_example
21004     */
21005
21006    /**
21007     * @addtogroup Spinner
21008     * @{
21009     */
21010
21011    /**
21012     * Add a new spinner widget to the given parent Elementary
21013     * (container) object.
21014     *
21015     * @param parent The parent object.
21016     * @return a new spinner widget handle or @c NULL, on errors.
21017     *
21018     * This function inserts a new spinner widget on the canvas.
21019     *
21020     * @ingroup Spinner
21021     *
21022     */
21023    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21024
21025    /**
21026     * Set the format string of the displayed label.
21027     *
21028     * @param obj The spinner object.
21029     * @param fmt The format string for the label display.
21030     *
21031     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21032     * string for the label text. The label text is provided a floating point
21033     * value, so the label text can display up to 1 floating point value.
21034     * Note that this is optional.
21035     *
21036     * Use a format string such as "%1.2f meters" for example, and it will
21037     * display values like: "3.14 meters" for a value equal to 3.14159.
21038     *
21039     * Default is "%0.f".
21040     *
21041     * @see elm_spinner_label_format_get()
21042     *
21043     * @ingroup Spinner
21044     */
21045    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21046
21047    /**
21048     * Get the label format of the spinner.
21049     *
21050     * @param obj The spinner object.
21051     * @return The text label format string in UTF-8.
21052     *
21053     * @see elm_spinner_label_format_set() for details.
21054     *
21055     * @ingroup Spinner
21056     */
21057    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21058
21059    /**
21060     * Set the minimum and maximum values for the spinner.
21061     *
21062     * @param obj The spinner object.
21063     * @param min The minimum value.
21064     * @param max The maximum value.
21065     *
21066     * Define the allowed range of values to be selected by the user.
21067     *
21068     * If actual value is less than @p min, it will be updated to @p min. If it
21069     * is bigger then @p max, will be updated to @p max. Actual value can be
21070     * get with elm_spinner_value_get().
21071     *
21072     * By default, min is equal to 0, and max is equal to 100.
21073     *
21074     * @warning Maximum must be greater than minimum.
21075     *
21076     * @see elm_spinner_min_max_get()
21077     *
21078     * @ingroup Spinner
21079     */
21080    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21081
21082    /**
21083     * Get the minimum and maximum values of the spinner.
21084     *
21085     * @param obj The spinner object.
21086     * @param min Pointer where to store the minimum value.
21087     * @param max Pointer where to store the maximum value.
21088     *
21089     * @note If only one value is needed, the other pointer can be passed
21090     * as @c NULL.
21091     *
21092     * @see elm_spinner_min_max_set() for details.
21093     *
21094     * @ingroup Spinner
21095     */
21096    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21097
21098    /**
21099     * Set the step used to increment or decrement the spinner value.
21100     *
21101     * @param obj The spinner object.
21102     * @param step The step value.
21103     *
21104     * This value will be incremented or decremented to the displayed value.
21105     * It will be incremented while the user keep right or top arrow pressed,
21106     * and will be decremented while the user keep left or bottom arrow pressed.
21107     *
21108     * The interval to increment / decrement can be set with
21109     * elm_spinner_interval_set().
21110     *
21111     * By default step value is equal to 1.
21112     *
21113     * @see elm_spinner_step_get()
21114     *
21115     * @ingroup Spinner
21116     */
21117    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21118
21119    /**
21120     * Get the step used to increment or decrement the spinner value.
21121     *
21122     * @param obj The spinner object.
21123     * @return The step value.
21124     *
21125     * @see elm_spinner_step_get() for more details.
21126     *
21127     * @ingroup Spinner
21128     */
21129    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21130
21131    /**
21132     * Set the value the spinner displays.
21133     *
21134     * @param obj The spinner object.
21135     * @param val The value to be displayed.
21136     *
21137     * Value will be presented on the label following format specified with
21138     * elm_spinner_format_set().
21139     *
21140     * @warning The value must to be between min and max values. This values
21141     * are set by elm_spinner_min_max_set().
21142     *
21143     * @see elm_spinner_value_get().
21144     * @see elm_spinner_format_set().
21145     * @see elm_spinner_min_max_set().
21146     *
21147     * @ingroup Spinner
21148     */
21149    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21150
21151    /**
21152     * Get the value displayed by the spinner.
21153     *
21154     * @param obj The spinner object.
21155     * @return The value displayed.
21156     *
21157     * @see elm_spinner_value_set() for details.
21158     *
21159     * @ingroup Spinner
21160     */
21161    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21162
21163    /**
21164     * Set whether the spinner should wrap when it reaches its
21165     * minimum or maximum value.
21166     *
21167     * @param obj The spinner object.
21168     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21169     * disable it.
21170     *
21171     * Disabled by default. If disabled, when the user tries to increment the
21172     * value,
21173     * but displayed value plus step value is bigger than maximum value,
21174     * the spinner
21175     * won't allow it. The same happens when the user tries to decrement it,
21176     * but the value less step is less than minimum value.
21177     *
21178     * When wrap is enabled, in such situations it will allow these changes,
21179     * but will get the value that would be less than minimum and subtracts
21180     * from maximum. Or add the value that would be more than maximum to
21181     * the minimum.
21182     *
21183     * E.g.:
21184     * @li min value = 10
21185     * @li max value = 50
21186     * @li step value = 20
21187     * @li displayed value = 20
21188     *
21189     * When the user decrement value (using left or bottom arrow), it will
21190     * displays @c 40, because max - (min - (displayed - step)) is
21191     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21192     *
21193     * @see elm_spinner_wrap_get().
21194     *
21195     * @ingroup Spinner
21196     */
21197    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21198
21199    /**
21200     * Get whether the spinner should wrap when it reaches its
21201     * minimum or maximum value.
21202     *
21203     * @param obj The spinner object
21204     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21205     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21206     *
21207     * @see elm_spinner_wrap_set() for details.
21208     *
21209     * @ingroup Spinner
21210     */
21211    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21212
21213    /**
21214     * Set whether the spinner can be directly edited by the user or not.
21215     *
21216     * @param obj The spinner object.
21217     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21218     * don't allow users to edit it directly.
21219     *
21220     * Spinner objects can have edition @b disabled, in which state they will
21221     * be changed only by arrows.
21222     * Useful for contexts
21223     * where you don't want your users to interact with it writting the value.
21224     * Specially
21225     * when using special values, the user can see real value instead
21226     * of special label on edition.
21227     *
21228     * It's enabled by default.
21229     *
21230     * @see elm_spinner_editable_get()
21231     *
21232     * @ingroup Spinner
21233     */
21234    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21235
21236    /**
21237     * Get whether the spinner can be directly edited by the user or not.
21238     *
21239     * @param obj The spinner object.
21240     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21241     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21242     *
21243     * @see elm_spinner_editable_set() for details.
21244     *
21245     * @ingroup Spinner
21246     */
21247    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21248
21249    /**
21250     * Set a special string to display in the place of the numerical value.
21251     *
21252     * @param obj The spinner object.
21253     * @param value The value to be replaced.
21254     * @param label The label to be used.
21255     *
21256     * It's useful for cases when a user should select an item that is
21257     * better indicated by a label than a value. For example, weekdays or months.
21258     *
21259     * E.g.:
21260     * @code
21261     * sp = elm_spinner_add(win);
21262     * elm_spinner_min_max_set(sp, 1, 3);
21263     * elm_spinner_special_value_add(sp, 1, "January");
21264     * elm_spinner_special_value_add(sp, 2, "February");
21265     * elm_spinner_special_value_add(sp, 3, "March");
21266     * evas_object_show(sp);
21267     * @endcode
21268     *
21269     * @ingroup Spinner
21270     */
21271    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21272
21273    /**
21274     * Set the interval on time updates for an user mouse button hold
21275     * on spinner widgets' arrows.
21276     *
21277     * @param obj The spinner object.
21278     * @param interval The (first) interval value in seconds.
21279     *
21280     * This interval value is @b decreased while the user holds the
21281     * mouse pointer either incrementing or decrementing spinner's value.
21282     *
21283     * This helps the user to get to a given value distant from the
21284     * current one easier/faster, as it will start to change quicker and
21285     * quicker on mouse button holds.
21286     *
21287     * The calculation for the next change interval value, starting from
21288     * the one set with this call, is the previous interval divided by
21289     * @c 1.05, so it decreases a little bit.
21290     *
21291     * The default starting interval value for automatic changes is
21292     * @c 0.85 seconds.
21293     *
21294     * @see elm_spinner_interval_get()
21295     *
21296     * @ingroup Spinner
21297     */
21298    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21299
21300    /**
21301     * Get the interval on time updates for an user mouse button hold
21302     * on spinner widgets' arrows.
21303     *
21304     * @param obj The spinner object.
21305     * @return The (first) interval value, in seconds, set on it.
21306     *
21307     * @see elm_spinner_interval_set() for more details.
21308     *
21309     * @ingroup Spinner
21310     */
21311    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21312
21313    /**
21314     * @}
21315     */
21316
21317    /**
21318     * @defgroup Index Index
21319     *
21320     * @image html img/widget/index/preview-00.png
21321     * @image latex img/widget/index/preview-00.eps
21322     *
21323     * An index widget gives you an index for fast access to whichever
21324     * group of other UI items one might have. It's a list of text
21325     * items (usually letters, for alphabetically ordered access).
21326     *
21327     * Index widgets are by default hidden and just appear when the
21328     * user clicks over it's reserved area in the canvas. In its
21329     * default theme, it's an area one @ref Fingers "finger" wide on
21330     * the right side of the index widget's container.
21331     *
21332     * When items on the index are selected, smart callbacks get
21333     * called, so that its user can make other container objects to
21334     * show a given area or child object depending on the index item
21335     * selected. You'd probably be using an index together with @ref
21336     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21337     * "general grids".
21338     *
21339     * Smart events one  can add callbacks for are:
21340     * - @c "changed" - When the selected index item changes. @c
21341     *      event_info is the selected item's data pointer.
21342     * - @c "delay,changed" - When the selected index item changes, but
21343     *      after a small idling period. @c event_info is the selected
21344     *      item's data pointer.
21345     * - @c "selected" - When the user releases a mouse button and
21346     *      selects an item. @c event_info is the selected item's data
21347     *      pointer.
21348     * - @c "level,up" - when the user moves a finger from the first
21349     *      level to the second level
21350     * - @c "level,down" - when the user moves a finger from the second
21351     *      level to the first level
21352     *
21353     * The @c "delay,changed" event is so that it'll wait a small time
21354     * before actually reporting those events and, moreover, just the
21355     * last event happening on those time frames will actually be
21356     * reported.
21357     *
21358     * Here are some examples on its usage:
21359     * @li @ref index_example_01
21360     * @li @ref index_example_02
21361     */
21362
21363    /**
21364     * @addtogroup Index
21365     * @{
21366     */
21367
21368    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21369
21370    /**
21371     * Add a new index widget to the given parent Elementary
21372     * (container) object
21373     *
21374     * @param parent The parent object
21375     * @return a new index widget handle or @c NULL, on errors
21376     *
21377     * This function inserts a new index widget on the canvas.
21378     *
21379     * @ingroup Index
21380     */
21381    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21382
21383    /**
21384     * Set whether a given index widget is or not visible,
21385     * programatically.
21386     *
21387     * @param obj The index object
21388     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21389     *
21390     * Not to be confused with visible as in @c evas_object_show() --
21391     * visible with regard to the widget's auto hiding feature.
21392     *
21393     * @see elm_index_active_get()
21394     *
21395     * @ingroup Index
21396     */
21397    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21398
21399    /**
21400     * Get whether a given index widget is currently visible or not.
21401     *
21402     * @param obj The index object
21403     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21404     *
21405     * @see elm_index_active_set() for more details
21406     *
21407     * @ingroup Index
21408     */
21409    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21410
21411    /**
21412     * Set the items level for a given index widget.
21413     *
21414     * @param obj The index object.
21415     * @param level @c 0 or @c 1, the currently implemented levels.
21416     *
21417     * @see elm_index_item_level_get()
21418     *
21419     * @ingroup Index
21420     */
21421    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21422
21423    /**
21424     * Get the items level set for a given index widget.
21425     *
21426     * @param obj The index object.
21427     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21428     *
21429     * @see elm_index_item_level_set() for more information
21430     *
21431     * @ingroup Index
21432     */
21433    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21434
21435    /**
21436     * Returns the last selected item's data, for a given index widget.
21437     *
21438     * @param obj The index object.
21439     * @return The item @b data associated to the last selected item on
21440     * @p obj (or @c NULL, on errors).
21441     *
21442     * @warning The returned value is @b not an #Elm_Index_Item item
21443     * handle, but the data associated to it (see the @c item parameter
21444     * in elm_index_item_append(), as an example).
21445     *
21446     * @ingroup Index
21447     */
21448    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21449
21450    /**
21451     * Append a new item on a given index widget.
21452     *
21453     * @param obj The index object.
21454     * @param letter Letter under which the item should be indexed
21455     * @param item The item data to set for the index's item
21456     *
21457     * Despite the most common usage of the @p letter argument is for
21458     * single char strings, one could use arbitrary strings as index
21459     * entries.
21460     *
21461     * @c item will be the pointer returned back on @c "changed", @c
21462     * "delay,changed" and @c "selected" smart events.
21463     *
21464     * @ingroup Index
21465     */
21466    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21467
21468    /**
21469     * Prepend a new item on a given index widget.
21470     *
21471     * @param obj The index object.
21472     * @param letter Letter under which the item should be indexed
21473     * @param item The item data to set for the index's item
21474     *
21475     * Despite the most common usage of the @p letter argument is for
21476     * single char strings, one could use arbitrary strings as index
21477     * entries.
21478     *
21479     * @c item will be the pointer returned back on @c "changed", @c
21480     * "delay,changed" and @c "selected" smart events.
21481     *
21482     * @ingroup Index
21483     */
21484    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21485
21486    /**
21487     * Append a new item, on a given index widget, <b>after the item
21488     * having @p relative as data</b>.
21489     *
21490     * @param obj The index object.
21491     * @param letter Letter under which the item should be indexed
21492     * @param item The item data to set for the index's item
21493     * @param relative The item data of the index item to be the
21494     * predecessor of this new one
21495     *
21496     * Despite the most common usage of the @p letter argument is for
21497     * single char strings, one could use arbitrary strings as index
21498     * entries.
21499     *
21500     * @c item will be the pointer returned back on @c "changed", @c
21501     * "delay,changed" and @c "selected" smart events.
21502     *
21503     * @note If @p relative is @c NULL or if it's not found to be data
21504     * set on any previous item on @p obj, this function will behave as
21505     * elm_index_item_append().
21506     *
21507     * @ingroup Index
21508     */
21509    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21510
21511    /**
21512     * Prepend a new item, on a given index widget, <b>after the item
21513     * having @p relative as data</b>.
21514     *
21515     * @param obj The index object.
21516     * @param letter Letter under which the item should be indexed
21517     * @param item The item data to set for the index's item
21518     * @param relative The item data of the index item to be the
21519     * successor of this new one
21520     *
21521     * Despite the most common usage of the @p letter argument is for
21522     * single char strings, one could use arbitrary strings as index
21523     * entries.
21524     *
21525     * @c item will be the pointer returned back on @c "changed", @c
21526     * "delay,changed" and @c "selected" smart events.
21527     *
21528     * @note If @p relative is @c NULL or if it's not found to be data
21529     * set on any previous item on @p obj, this function will behave as
21530     * elm_index_item_prepend().
21531     *
21532     * @ingroup Index
21533     */
21534    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21535
21536    /**
21537     * Insert a new item into the given index widget, using @p cmp_func
21538     * function to sort items (by item handles).
21539     *
21540     * @param obj The index object.
21541     * @param letter Letter under which the item should be indexed
21542     * @param item The item data to set for the index's item
21543     * @param cmp_func The comparing function to be used to sort index
21544     * items <b>by #Elm_Index_Item item handles</b>
21545     * @param cmp_data_func A @b fallback function to be called for the
21546     * sorting of index items <b>by item data</b>). It will be used
21547     * when @p cmp_func returns @c 0 (equality), which means an index
21548     * item with provided item data already exists. To decide which
21549     * data item should be pointed to by the index item in question, @p
21550     * cmp_data_func will be used. If @p cmp_data_func returns a
21551     * non-negative value, the previous index item data will be
21552     * replaced by the given @p item pointer. If the previous data need
21553     * to be freed, it should be done by the @p cmp_data_func function,
21554     * because all references to it will be lost. If this function is
21555     * not provided (@c NULL is given), index items will be @b
21556     * duplicated, if @p cmp_func returns @c 0.
21557     *
21558     * Despite the most common usage of the @p letter argument is for
21559     * single char strings, one could use arbitrary strings as index
21560     * entries.
21561     *
21562     * @c item will be the pointer returned back on @c "changed", @c
21563     * "delay,changed" and @c "selected" smart events.
21564     *
21565     * @ingroup Index
21566     */
21567    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);
21568
21569    /**
21570     * Remove an item from a given index widget, <b>to be referenced by
21571     * it's data value</b>.
21572     *
21573     * @param obj The index object
21574     * @param item The item's data pointer for the item to be removed
21575     * from @p obj
21576     *
21577     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21578     * that callback function will be called by this one.
21579     *
21580     * @warning The item to be removed from @p obj will be found via
21581     * its item data pointer, and not by an #Elm_Index_Item handle.
21582     *
21583     * @ingroup Index
21584     */
21585    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21586
21587    /**
21588     * Find a given index widget's item, <b>using item data</b>.
21589     *
21590     * @param obj The index object
21591     * @param item The item data pointed to by the desired index item
21592     * @return The index item handle, if found, or @c NULL otherwise
21593     *
21594     * @ingroup Index
21595     */
21596    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21597
21598    /**
21599     * Removes @b all items from a given index widget.
21600     *
21601     * @param obj The index object.
21602     *
21603     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21604     * that callback function will be called for each item in @p obj.
21605     *
21606     * @ingroup Index
21607     */
21608    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21609
21610    /**
21611     * Go to a given items level on a index widget
21612     *
21613     * @param obj The index object
21614     * @param level The index level (one of @c 0 or @c 1)
21615     *
21616     * @ingroup Index
21617     */
21618    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21619
21620    /**
21621     * Return the data associated with a given index widget item
21622     *
21623     * @param it The index widget item handle
21624     * @return The data associated with @p it
21625     *
21626     * @see elm_index_item_data_set()
21627     *
21628     * @ingroup Index
21629     */
21630    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21631
21632    /**
21633     * Set the data associated with a given index widget item
21634     *
21635     * @param it The index widget item handle
21636     * @param data The new data pointer to set to @p it
21637     *
21638     * This sets new item data on @p it.
21639     *
21640     * @warning The old data pointer won't be touched by this function, so
21641     * the user had better to free that old data himself/herself.
21642     *
21643     * @ingroup Index
21644     */
21645    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21646
21647    /**
21648     * Set the function to be called when a given index widget item is freed.
21649     *
21650     * @param it The item to set the callback on
21651     * @param func The function to call on the item's deletion
21652     *
21653     * When called, @p func will have both @c data and @c event_info
21654     * arguments with the @p it item's data value and, naturally, the
21655     * @c obj argument with a handle to the parent index widget.
21656     *
21657     * @ingroup Index
21658     */
21659    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21660
21661    /**
21662     * Get the letter (string) set on a given index widget item.
21663     *
21664     * @param it The index item handle
21665     * @return The letter string set on @p it
21666     *
21667     * @ingroup Index
21668     */
21669    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21670
21671    /**
21672     * @}
21673     */
21674
21675    /**
21676     * @defgroup Photocam Photocam
21677     *
21678     * @image html img/widget/photocam/preview-00.png
21679     * @image latex img/widget/photocam/preview-00.eps
21680     *
21681     * This is a widget specifically for displaying high-resolution digital
21682     * camera photos giving speedy feedback (fast load), low memory footprint
21683     * and zooming and panning as well as fitting logic. It is entirely focused
21684     * on jpeg images, and takes advantage of properties of the jpeg format (via
21685     * evas loader features in the jpeg loader).
21686     *
21687     * Signals that you can add callbacks for are:
21688     * @li "clicked" - This is called when a user has clicked the photo without
21689     *                 dragging around.
21690     * @li "press" - This is called when a user has pressed down on the photo.
21691     * @li "longpressed" - This is called when a user has pressed down on the
21692     *                     photo for a long time without dragging around.
21693     * @li "clicked,double" - This is called when a user has double-clicked the
21694     *                        photo.
21695     * @li "load" - Photo load begins.
21696     * @li "loaded" - This is called when the image file load is complete for the
21697     *                first view (low resolution blurry version).
21698     * @li "load,detail" - Photo detailed data load begins.
21699     * @li "loaded,detail" - This is called when the image file load is complete
21700     *                      for the detailed image data (full resolution needed).
21701     * @li "zoom,start" - Zoom animation started.
21702     * @li "zoom,stop" - Zoom animation stopped.
21703     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21704     * @li "scroll" - the content has been scrolled (moved)
21705     * @li "scroll,anim,start" - scrolling animation has started
21706     * @li "scroll,anim,stop" - scrolling animation has stopped
21707     * @li "scroll,drag,start" - dragging the contents around has started
21708     * @li "scroll,drag,stop" - dragging the contents around has stopped
21709     *
21710     * @ref tutorial_photocam shows the API in action.
21711     * @{
21712     */
21713    /**
21714     * @brief Types of zoom available.
21715     */
21716    typedef enum _Elm_Photocam_Zoom_Mode
21717      {
21718         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21719         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21720         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21721         ELM_PHOTOCAM_ZOOM_MODE_LAST
21722      } Elm_Photocam_Zoom_Mode;
21723    /**
21724     * @brief Add a new Photocam object
21725     *
21726     * @param parent The parent object
21727     * @return The new object or NULL if it cannot be created
21728     */
21729    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21730    /**
21731     * @brief Set the photo file to be shown
21732     *
21733     * @param obj The photocam object
21734     * @param file The photo file
21735     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21736     *
21737     * This sets (and shows) the specified file (with a relative or absolute
21738     * path) and will return a load error (same error that
21739     * evas_object_image_load_error_get() will return). The image will change and
21740     * adjust its size at this point and begin a background load process for this
21741     * photo that at some time in the future will be displayed at the full
21742     * quality needed.
21743     */
21744    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21745    /**
21746     * @brief Returns the path of the current image file
21747     *
21748     * @param obj The photocam object
21749     * @return Returns the path
21750     *
21751     * @see elm_photocam_file_set()
21752     */
21753    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21754    /**
21755     * @brief Set the zoom level of the photo
21756     *
21757     * @param obj The photocam object
21758     * @param zoom The zoom level to set
21759     *
21760     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21761     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21762     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21763     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21764     * 16, 32, etc.).
21765     */
21766    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21767    /**
21768     * @brief Get the zoom level of the photo
21769     *
21770     * @param obj The photocam object
21771     * @return The current zoom level
21772     *
21773     * This returns the current zoom level of the photocam object. Note that if
21774     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21775     * (which is the default), the zoom level may be changed at any time by the
21776     * photocam object itself to account for photo size and photocam viewpoer
21777     * size.
21778     *
21779     * @see elm_photocam_zoom_set()
21780     * @see elm_photocam_zoom_mode_set()
21781     */
21782    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21783    /**
21784     * @brief Set the zoom mode
21785     *
21786     * @param obj The photocam object
21787     * @param mode The desired mode
21788     *
21789     * This sets the zoom mode to manual or one of several automatic levels.
21790     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21791     * elm_photocam_zoom_set() and will stay at that level until changed by code
21792     * or until zoom mode is changed. This is the default mode. The Automatic
21793     * modes will allow the photocam object to automatically adjust zoom mode
21794     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21795     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21796     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21797     * pixels within the frame are left unfilled.
21798     */
21799    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21800    /**
21801     * @brief Get the zoom mode
21802     *
21803     * @param obj The photocam object
21804     * @return The current zoom mode
21805     *
21806     * This gets the current zoom mode of the photocam object.
21807     *
21808     * @see elm_photocam_zoom_mode_set()
21809     */
21810    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21811    /**
21812     * @brief Get the current image pixel width and height
21813     *
21814     * @param obj The photocam object
21815     * @param w A pointer to the width return
21816     * @param h A pointer to the height return
21817     *
21818     * This gets the current photo pixel width and height (for the original).
21819     * The size will be returned in the integers @p w and @p h that are pointed
21820     * to.
21821     */
21822    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21823    /**
21824     * @brief Get the area of the image that is currently shown
21825     *
21826     * @param obj
21827     * @param x A pointer to the X-coordinate of region
21828     * @param y A pointer to the Y-coordinate of region
21829     * @param w A pointer to the width
21830     * @param h A pointer to the height
21831     *
21832     * @see elm_photocam_image_region_show()
21833     * @see elm_photocam_image_region_bring_in()
21834     */
21835    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21836    /**
21837     * @brief Set the viewed portion of the image
21838     *
21839     * @param obj The photocam object
21840     * @param x X-coordinate of region in image original pixels
21841     * @param y Y-coordinate of region in image original pixels
21842     * @param w Width of region in image original pixels
21843     * @param h Height of region in image original pixels
21844     *
21845     * This shows the region of the image without using animation.
21846     */
21847    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21848    /**
21849     * @brief Bring in the viewed portion of the image
21850     *
21851     * @param obj The photocam object
21852     * @param x X-coordinate of region in image original pixels
21853     * @param y Y-coordinate of region in image original pixels
21854     * @param w Width of region in image original pixels
21855     * @param h Height of region in image original pixels
21856     *
21857     * This shows the region of the image using animation.
21858     */
21859    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21860    /**
21861     * @brief Set the paused state for photocam
21862     *
21863     * @param obj The photocam object
21864     * @param paused The pause state to set
21865     *
21866     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21867     * photocam. The default is off. This will stop zooming using animation on
21868     * zoom levels changes and change instantly. This will stop any existing
21869     * animations that are running.
21870     */
21871    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21872    /**
21873     * @brief Get the paused state for photocam
21874     *
21875     * @param obj The photocam object
21876     * @return The current paused state
21877     *
21878     * This gets the current paused state for the photocam object.
21879     *
21880     * @see elm_photocam_paused_set()
21881     */
21882    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21883    /**
21884     * @brief Get the internal low-res image used for photocam
21885     *
21886     * @param obj The photocam object
21887     * @return The internal image object handle, or NULL if none exists
21888     *
21889     * This gets the internal image object inside photocam. Do not modify it. It
21890     * is for inspection only, and hooking callbacks to. Nothing else. It may be
21891     * deleted at any time as well.
21892     */
21893    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21894    /**
21895     * @brief Set the photocam scrolling bouncing.
21896     *
21897     * @param obj The photocam object
21898     * @param h_bounce bouncing for horizontal
21899     * @param v_bounce bouncing for vertical
21900     */
21901    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21902    /**
21903     * @brief Get the photocam scrolling bouncing.
21904     *
21905     * @param obj The photocam object
21906     * @param h_bounce bouncing for horizontal
21907     * @param v_bounce bouncing for vertical
21908     *
21909     * @see elm_photocam_bounce_set()
21910     */
21911    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21912    /**
21913     * @}
21914     */
21915
21916    /**
21917     * @defgroup Map Map
21918     * @ingroup Elementary
21919     *
21920     * @image html img/widget/map/preview-00.png
21921     * @image latex img/widget/map/preview-00.eps
21922     *
21923     * This is a widget specifically for displaying a map. It uses basically
21924     * OpenStreetMap provider http://www.openstreetmap.org/,
21925     * but custom providers can be added.
21926     *
21927     * It supports some basic but yet nice features:
21928     * @li zoom and scroll
21929     * @li markers with content to be displayed when user clicks over it
21930     * @li group of markers
21931     * @li routes
21932     *
21933     * Smart callbacks one can listen to:
21934     *
21935     * - "clicked" - This is called when a user has clicked the map without
21936     *   dragging around.
21937     * - "press" - This is called when a user has pressed down on the map.
21938     * - "longpressed" - This is called when a user has pressed down on the map
21939     *   for a long time without dragging around.
21940     * - "clicked,double" - This is called when a user has double-clicked
21941     *   the map.
21942     * - "load,detail" - Map detailed data load begins.
21943     * - "loaded,detail" - This is called when all currently visible parts of
21944     *   the map are loaded.
21945     * - "zoom,start" - Zoom animation started.
21946     * - "zoom,stop" - Zoom animation stopped.
21947     * - "zoom,change" - Zoom changed when using an auto zoom mode.
21948     * - "scroll" - the content has been scrolled (moved).
21949     * - "scroll,anim,start" - scrolling animation has started.
21950     * - "scroll,anim,stop" - scrolling animation has stopped.
21951     * - "scroll,drag,start" - dragging the contents around has started.
21952     * - "scroll,drag,stop" - dragging the contents around has stopped.
21953     * - "downloaded" - This is called when all currently required map images
21954     *   are downloaded.
21955     * - "route,load" - This is called when route request begins.
21956     * - "route,loaded" - This is called when route request ends.
21957     * - "name,load" - This is called when name request begins.
21958     * - "name,loaded- This is called when name request ends.
21959     *
21960     * Available style for map widget:
21961     * - @c "default"
21962     *
21963     * Available style for markers:
21964     * - @c "radio"
21965     * - @c "radio2"
21966     * - @c "empty"
21967     *
21968     * Available style for marker bubble:
21969     * - @c "default"
21970     *
21971     * List of examples:
21972     * @li @ref map_example_01
21973     * @li @ref map_example_02
21974     * @li @ref map_example_03
21975     */
21976
21977    /**
21978     * @addtogroup Map
21979     * @{
21980     */
21981
21982    /**
21983     * @enum _Elm_Map_Zoom_Mode
21984     * @typedef Elm_Map_Zoom_Mode
21985     *
21986     * Set map's zoom behavior. It can be set to manual or automatic.
21987     *
21988     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21989     *
21990     * Values <b> don't </b> work as bitmask, only one can be choosen.
21991     *
21992     * @note Valid sizes are 2^zoom, consequently the map may be smaller
21993     * than the scroller view.
21994     *
21995     * @see elm_map_zoom_mode_set()
21996     * @see elm_map_zoom_mode_get()
21997     *
21998     * @ingroup Map
21999     */
22000    typedef enum _Elm_Map_Zoom_Mode
22001      {
22002         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22003         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22004         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22005         ELM_MAP_ZOOM_MODE_LAST
22006      } Elm_Map_Zoom_Mode;
22007
22008    /**
22009     * @enum _Elm_Map_Route_Sources
22010     * @typedef Elm_Map_Route_Sources
22011     *
22012     * Set route service to be used. By default used source is
22013     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22014     *
22015     * @see elm_map_route_source_set()
22016     * @see elm_map_route_source_get()
22017     *
22018     * @ingroup Map
22019     */
22020    typedef enum _Elm_Map_Route_Sources
22021      {
22022         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22023         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. */
22024         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22025         ELM_MAP_ROUTE_SOURCE_LAST
22026      } Elm_Map_Route_Sources;
22027
22028    typedef enum _Elm_Map_Name_Sources
22029      {
22030         ELM_MAP_NAME_SOURCE_NOMINATIM,
22031         ELM_MAP_NAME_SOURCE_LAST
22032      } Elm_Map_Name_Sources;
22033
22034    /**
22035     * @enum _Elm_Map_Route_Type
22036     * @typedef Elm_Map_Route_Type
22037     *
22038     * Set type of transport used on route.
22039     *
22040     * @see elm_map_route_add()
22041     *
22042     * @ingroup Map
22043     */
22044    typedef enum _Elm_Map_Route_Type
22045      {
22046         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22047         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22048         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22049         ELM_MAP_ROUTE_TYPE_LAST
22050      } Elm_Map_Route_Type;
22051
22052    /**
22053     * @enum _Elm_Map_Route_Method
22054     * @typedef Elm_Map_Route_Method
22055     *
22056     * Set the routing method, what should be priorized, time or distance.
22057     *
22058     * @see elm_map_route_add()
22059     *
22060     * @ingroup Map
22061     */
22062    typedef enum _Elm_Map_Route_Method
22063      {
22064         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22065         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22066         ELM_MAP_ROUTE_METHOD_LAST
22067      } Elm_Map_Route_Method;
22068
22069    typedef enum _Elm_Map_Name_Method
22070      {
22071         ELM_MAP_NAME_METHOD_SEARCH,
22072         ELM_MAP_NAME_METHOD_REVERSE,
22073         ELM_MAP_NAME_METHOD_LAST
22074      } Elm_Map_Name_Method;
22075
22076    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(). */
22077    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(). */
22078    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(). */
22079    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(). */
22080    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22081    typedef struct _Elm_Map_Track           Elm_Map_Track;
22082
22083    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. */
22084    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22085    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22086    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22087
22088    typedef char        *(*ElmMapModuleSourceFunc) (void);
22089    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22090    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22091    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22092    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22093    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22094    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22095    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22096    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22097
22098    /**
22099     * Add a new map widget to the given parent Elementary (container) object.
22100     *
22101     * @param parent The parent object.
22102     * @return a new map widget handle or @c NULL, on errors.
22103     *
22104     * This function inserts a new map widget on the canvas.
22105     *
22106     * @ingroup Map
22107     */
22108    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22109
22110    /**
22111     * Set the zoom level of the map.
22112     *
22113     * @param obj The map object.
22114     * @param zoom The zoom level to set.
22115     *
22116     * This sets the zoom level.
22117     *
22118     * It will respect limits defined by elm_map_source_zoom_min_set() and
22119     * elm_map_source_zoom_max_set().
22120     *
22121     * By default these values are 0 (world map) and 18 (maximum zoom).
22122     *
22123     * This function should be used when zoom mode is set to
22124     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22125     * with elm_map_zoom_mode_set().
22126     *
22127     * @see elm_map_zoom_mode_set().
22128     * @see elm_map_zoom_get().
22129     *
22130     * @ingroup Map
22131     */
22132    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22133
22134    /**
22135     * Get the zoom level of the map.
22136     *
22137     * @param obj The map object.
22138     * @return The current zoom level.
22139     *
22140     * This returns the current zoom level of the map object.
22141     *
22142     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22143     * (which is the default), the zoom level may be changed at any time by the
22144     * map object itself to account for map size and map viewport size.
22145     *
22146     * @see elm_map_zoom_set() for details.
22147     *
22148     * @ingroup Map
22149     */
22150    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22151
22152    /**
22153     * Set the zoom mode used by the map object.
22154     *
22155     * @param obj The map object.
22156     * @param mode The zoom mode of the map, being it one of
22157     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22158     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22159     *
22160     * This sets the zoom mode to manual or one of the automatic levels.
22161     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22162     * elm_map_zoom_set() and will stay at that level until changed by code
22163     * or until zoom mode is changed. This is the default mode.
22164     *
22165     * The Automatic modes will allow the map object to automatically
22166     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22167     * adjust zoom so the map fits inside the scroll frame with no pixels
22168     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22169     * ensure no pixels within the frame are left unfilled. Do not forget that
22170     * the valid sizes are 2^zoom, consequently the map may be smaller than
22171     * the scroller view.
22172     *
22173     * @see elm_map_zoom_set()
22174     *
22175     * @ingroup Map
22176     */
22177    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22178
22179    /**
22180     * Get the zoom mode used by the map object.
22181     *
22182     * @param obj The map object.
22183     * @return The zoom mode of the map, being it one of
22184     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22185     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22186     *
22187     * This function returns the current zoom mode used by the map object.
22188     *
22189     * @see elm_map_zoom_mode_set() for more details.
22190     *
22191     * @ingroup Map
22192     */
22193    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22194
22195    /**
22196     * Get the current coordinates of the map.
22197     *
22198     * @param obj The map object.
22199     * @param lon Pointer where to store longitude.
22200     * @param lat Pointer where to store latitude.
22201     *
22202     * This gets the current center coordinates of the map object. It can be
22203     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22204     *
22205     * @see elm_map_geo_region_bring_in()
22206     * @see elm_map_geo_region_show()
22207     *
22208     * @ingroup Map
22209     */
22210    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22211
22212    /**
22213     * Animatedly bring in given coordinates to the center of the map.
22214     *
22215     * @param obj The map object.
22216     * @param lon Longitude to center at.
22217     * @param lat Latitude to center at.
22218     *
22219     * This causes map to jump to the given @p lat and @p lon coordinates
22220     * and show it (by scrolling) in the center of the viewport, if it is not
22221     * already centered. This will use animation to do so and take a period
22222     * of time to complete.
22223     *
22224     * @see elm_map_geo_region_show() for a function to avoid animation.
22225     * @see elm_map_geo_region_get()
22226     *
22227     * @ingroup Map
22228     */
22229    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22230
22231    /**
22232     * Show the given coordinates at the center of the map, @b immediately.
22233     *
22234     * @param obj The map object.
22235     * @param lon Longitude to center at.
22236     * @param lat Latitude to center at.
22237     *
22238     * This causes map to @b redraw its viewport's contents to the
22239     * region contining the given @p lat and @p lon, that will be moved to the
22240     * center of the map.
22241     *
22242     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22243     * @see elm_map_geo_region_get()
22244     *
22245     * @ingroup Map
22246     */
22247    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22248
22249    /**
22250     * Pause or unpause the map.
22251     *
22252     * @param obj The map object.
22253     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22254     * to unpause it.
22255     *
22256     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22257     * for map.
22258     *
22259     * The default is off.
22260     *
22261     * This will stop zooming using animation, changing zoom levels will
22262     * change instantly. This will stop any existing animations that are running.
22263     *
22264     * @see elm_map_paused_get()
22265     *
22266     * @ingroup Map
22267     */
22268    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22269
22270    /**
22271     * Get a value whether map is paused or not.
22272     *
22273     * @param obj The map object.
22274     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22275     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22276     *
22277     * This gets the current paused state for the map object.
22278     *
22279     * @see elm_map_paused_set() for details.
22280     *
22281     * @ingroup Map
22282     */
22283    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22284
22285    /**
22286     * Set to show markers during zoom level changes or not.
22287     *
22288     * @param obj The map object.
22289     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22290     * to show them.
22291     *
22292     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22293     * for map.
22294     *
22295     * The default is off.
22296     *
22297     * This will stop zooming using animation, changing zoom levels will
22298     * change instantly. This will stop any existing animations that are running.
22299     *
22300     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22301     * for the markers.
22302     *
22303     * The default  is off.
22304     *
22305     * Enabling it will force the map to stop displaying the markers during
22306     * zoom level changes. Set to on if you have a large number of markers.
22307     *
22308     * @see elm_map_paused_markers_get()
22309     *
22310     * @ingroup Map
22311     */
22312    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22313
22314    /**
22315     * Get a value whether markers will be displayed on zoom level changes or not
22316     *
22317     * @param obj The map object.
22318     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22319     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22320     *
22321     * This gets the current markers paused state for the map object.
22322     *
22323     * @see elm_map_paused_markers_set() for details.
22324     *
22325     * @ingroup Map
22326     */
22327    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22328
22329    /**
22330     * Get the information of downloading status.
22331     *
22332     * @param obj The map object.
22333     * @param try_num Pointer where to store number of tiles being downloaded.
22334     * @param finish_num Pointer where to store number of tiles successfully
22335     * downloaded.
22336     *
22337     * This gets the current downloading status for the map object, the number
22338     * of tiles being downloaded and the number of tiles already downloaded.
22339     *
22340     * @ingroup Map
22341     */
22342    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22343
22344    /**
22345     * Convert a pixel coordinate (x,y) into a geographic coordinate
22346     * (longitude, latitude).
22347     *
22348     * @param obj The map object.
22349     * @param x the coordinate.
22350     * @param y the coordinate.
22351     * @param size the size in pixels of the map.
22352     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22353     * @param lon Pointer where to store the longitude that correspond to x.
22354     * @param lat Pointer where to store the latitude that correspond to y.
22355     *
22356     * @note Origin pixel point is the top left corner of the viewport.
22357     * Map zoom and size are taken on account.
22358     *
22359     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22360     *
22361     * @ingroup Map
22362     */
22363    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);
22364
22365    /**
22366     * Convert a geographic coordinate (longitude, latitude) into a pixel
22367     * coordinate (x, y).
22368     *
22369     * @param obj The map object.
22370     * @param lon the longitude.
22371     * @param lat the latitude.
22372     * @param size the size in pixels of the map. The map is a square
22373     * and generally his size is : pow(2.0, zoom)*256.
22374     * @param x Pointer where to store the horizontal pixel coordinate that
22375     * correspond to the longitude.
22376     * @param y Pointer where to store the vertical pixel coordinate that
22377     * correspond to the latitude.
22378     *
22379     * @note Origin pixel point is the top left corner of the viewport.
22380     * Map zoom and size are taken on account.
22381     *
22382     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22383     *
22384     * @ingroup Map
22385     */
22386    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);
22387
22388    /**
22389     * Convert a geographic coordinate (longitude, latitude) into a name
22390     * (address).
22391     *
22392     * @param obj The map object.
22393     * @param lon the longitude.
22394     * @param lat the latitude.
22395     * @return name A #Elm_Map_Name handle for this coordinate.
22396     *
22397     * To get the string for this address, elm_map_name_address_get()
22398     * should be used.
22399     *
22400     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22401     *
22402     * @ingroup Map
22403     */
22404    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22405
22406    /**
22407     * Convert a name (address) into a geographic coordinate
22408     * (longitude, latitude).
22409     *
22410     * @param obj The map object.
22411     * @param name The address.
22412     * @return name A #Elm_Map_Name handle for this address.
22413     *
22414     * To get the longitude and latitude, elm_map_name_region_get()
22415     * should be used.
22416     *
22417     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22418     *
22419     * @ingroup Map
22420     */
22421    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22422
22423    /**
22424     * Convert a pixel coordinate into a rotated pixel coordinate.
22425     *
22426     * @param obj The map object.
22427     * @param x horizontal coordinate of the point to rotate.
22428     * @param y vertical coordinate of the point to rotate.
22429     * @param cx rotation's center horizontal position.
22430     * @param cy rotation's center vertical position.
22431     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22432     * @param xx Pointer where to store rotated x.
22433     * @param yy Pointer where to store rotated y.
22434     *
22435     * @ingroup Map
22436     */
22437    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);
22438
22439    /**
22440     * Add a new marker to the map object.
22441     *
22442     * @param obj The map object.
22443     * @param lon The longitude of the marker.
22444     * @param lat The latitude of the marker.
22445     * @param clas The class, to use when marker @b isn't grouped to others.
22446     * @param clas_group The class group, to use when marker is grouped to others
22447     * @param data The data passed to the callbacks.
22448     *
22449     * @return The created marker or @c NULL upon failure.
22450     *
22451     * A marker will be created and shown in a specific point of the map, defined
22452     * by @p lon and @p lat.
22453     *
22454     * It will be displayed using style defined by @p class when this marker
22455     * is displayed alone (not grouped). A new class can be created with
22456     * elm_map_marker_class_new().
22457     *
22458     * If the marker is grouped to other markers, it will be displayed with
22459     * style defined by @p class_group. Markers with the same group are grouped
22460     * if they are close. A new group class can be created with
22461     * elm_map_marker_group_class_new().
22462     *
22463     * Markers created with this method can be deleted with
22464     * elm_map_marker_remove().
22465     *
22466     * A marker can have associated content to be displayed by a bubble,
22467     * when a user click over it, as well as an icon. These objects will
22468     * be fetch using class' callback functions.
22469     *
22470     * @see elm_map_marker_class_new()
22471     * @see elm_map_marker_group_class_new()
22472     * @see elm_map_marker_remove()
22473     *
22474     * @ingroup Map
22475     */
22476    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);
22477
22478    /**
22479     * Set the maximum numbers of markers' content to be displayed in a group.
22480     *
22481     * @param obj The map object.
22482     * @param max The maximum numbers of items displayed in a bubble.
22483     *
22484     * A bubble will be displayed when the user clicks over the group,
22485     * and will place the content of markers that belong to this group
22486     * inside it.
22487     *
22488     * A group can have a long list of markers, consequently the creation
22489     * of the content of the bubble can be very slow.
22490     *
22491     * In order to avoid this, a maximum number of items is displayed
22492     * in a bubble.
22493     *
22494     * By default this number is 30.
22495     *
22496     * Marker with the same group class are grouped if they are close.
22497     *
22498     * @see elm_map_marker_add()
22499     *
22500     * @ingroup Map
22501     */
22502    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22503
22504    /**
22505     * Remove a marker from the map.
22506     *
22507     * @param marker The marker to remove.
22508     *
22509     * @see elm_map_marker_add()
22510     *
22511     * @ingroup Map
22512     */
22513    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22514
22515    /**
22516     * Get the current coordinates of the marker.
22517     *
22518     * @param marker marker.
22519     * @param lat Pointer where to store the marker's latitude.
22520     * @param lon Pointer where to store the marker's longitude.
22521     *
22522     * These values are set when adding markers, with function
22523     * elm_map_marker_add().
22524     *
22525     * @see elm_map_marker_add()
22526     *
22527     * @ingroup Map
22528     */
22529    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22530
22531    /**
22532     * Animatedly bring in given marker to the center of the map.
22533     *
22534     * @param marker The marker to center at.
22535     *
22536     * This causes map to jump to the given @p marker's coordinates
22537     * and show it (by scrolling) in the center of the viewport, if it is not
22538     * already centered. This will use animation to do so and take a period
22539     * of time to complete.
22540     *
22541     * @see elm_map_marker_show() for a function to avoid animation.
22542     * @see elm_map_marker_region_get()
22543     *
22544     * @ingroup Map
22545     */
22546    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22547
22548    /**
22549     * Show the given marker at the center of the map, @b immediately.
22550     *
22551     * @param marker The marker to center at.
22552     *
22553     * This causes map to @b redraw its viewport's contents to the
22554     * region contining the given @p marker's coordinates, that will be
22555     * moved to the center of the map.
22556     *
22557     * @see elm_map_marker_bring_in() for a function to move with animation.
22558     * @see elm_map_markers_list_show() if more than one marker need to be
22559     * displayed.
22560     * @see elm_map_marker_region_get()
22561     *
22562     * @ingroup Map
22563     */
22564    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22565
22566    /**
22567     * Move and zoom the map to display a list of markers.
22568     *
22569     * @param markers A list of #Elm_Map_Marker handles.
22570     *
22571     * The map will be centered on the center point of the markers in the list.
22572     * Then the map will be zoomed in order to fit the markers using the maximum
22573     * zoom which allows display of all the markers.
22574     *
22575     * @warning All the markers should belong to the same map object.
22576     *
22577     * @see elm_map_marker_show() to show a single marker.
22578     * @see elm_map_marker_bring_in()
22579     *
22580     * @ingroup Map
22581     */
22582    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22583
22584    /**
22585     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22586     *
22587     * @param marker The marker wich content should be returned.
22588     * @return Return the evas object if it exists, else @c NULL.
22589     *
22590     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22591     * elm_map_marker_class_get_cb_set() should be used.
22592     *
22593     * This content is what will be inside the bubble that will be displayed
22594     * when an user clicks over the marker.
22595     *
22596     * This returns the actual Evas object used to be placed inside
22597     * the bubble. This may be @c NULL, as it may
22598     * not have been created or may have been deleted, at any time, by
22599     * the map. <b>Do not modify this object</b> (move, resize,
22600     * show, hide, etc.), as the map is controlling it. This
22601     * function is for querying, emitting custom signals or hooking
22602     * lower level callbacks for events on that object. Do not delete
22603     * this object under any circumstances.
22604     *
22605     * @ingroup Map
22606     */
22607    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22608
22609    /**
22610     * Update the marker
22611     *
22612     * @param marker The marker to be updated.
22613     *
22614     * If a content is set to this marker, it will call function to delete it,
22615     * #ElmMapMarkerDelFunc, and then will fetch the content again with
22616     * #ElmMapMarkerGetFunc.
22617     *
22618     * These functions are set for the marker class with
22619     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22620     *
22621     * @ingroup Map
22622     */
22623    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22624
22625    /**
22626     * Close all the bubbles opened by the user.
22627     *
22628     * @param obj The map object.
22629     *
22630     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22631     * when the user clicks on a marker.
22632     *
22633     * This functions is set for the marker class with
22634     * elm_map_marker_class_get_cb_set().
22635     *
22636     * @ingroup Map
22637     */
22638    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22639
22640    /**
22641     * Create a new group class.
22642     *
22643     * @param obj The map object.
22644     * @return Returns the new group class.
22645     *
22646     * Each marker must be associated to a group class. Markers in the same
22647     * group are grouped if they are close.
22648     *
22649     * The group class defines the style of the marker when a marker is grouped
22650     * to others markers. When it is alone, another class will be used.
22651     *
22652     * A group class will need to be provided when creating a marker with
22653     * elm_map_marker_add().
22654     *
22655     * Some properties and functions can be set by class, as:
22656     * - style, with elm_map_group_class_style_set()
22657     * - data - to be associated to the group class. It can be set using
22658     *   elm_map_group_class_data_set().
22659     * - min zoom to display markers, set with
22660     *   elm_map_group_class_zoom_displayed_set().
22661     * - max zoom to group markers, set using
22662     *   elm_map_group_class_zoom_grouped_set().
22663     * - visibility - set if markers will be visible or not, set with
22664     *   elm_map_group_class_hide_set().
22665     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22666     *   It can be set using elm_map_group_class_icon_cb_set().
22667     *
22668     * @see elm_map_marker_add()
22669     * @see elm_map_group_class_style_set()
22670     * @see elm_map_group_class_data_set()
22671     * @see elm_map_group_class_zoom_displayed_set()
22672     * @see elm_map_group_class_zoom_grouped_set()
22673     * @see elm_map_group_class_hide_set()
22674     * @see elm_map_group_class_icon_cb_set()
22675     *
22676     * @ingroup Map
22677     */
22678    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22679
22680    /**
22681     * Set the marker's style of a group class.
22682     *
22683     * @param clas The group class.
22684     * @param style The style to be used by markers.
22685     *
22686     * Each marker must be associated to a group class, and will use the style
22687     * defined by such class when grouped to other markers.
22688     *
22689     * The following styles are provided by default theme:
22690     * @li @c radio - blue circle
22691     * @li @c radio2 - green circle
22692     * @li @c empty
22693     *
22694     * @see elm_map_group_class_new() for more details.
22695     * @see elm_map_marker_add()
22696     *
22697     * @ingroup Map
22698     */
22699    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22700
22701    /**
22702     * Set the icon callback function of a group class.
22703     *
22704     * @param clas The group class.
22705     * @param icon_get The callback function that will return the icon.
22706     *
22707     * Each marker must be associated to a group class, and it can display a
22708     * custom icon. The function @p icon_get must return this icon.
22709     *
22710     * @see elm_map_group_class_new() for more details.
22711     * @see elm_map_marker_add()
22712     *
22713     * @ingroup Map
22714     */
22715    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22716
22717    /**
22718     * Set the data associated to the group class.
22719     *
22720     * @param clas The group class.
22721     * @param data The new user data.
22722     *
22723     * This data will be passed for callback functions, like icon get callback,
22724     * that can be set with elm_map_group_class_icon_cb_set().
22725     *
22726     * If a data was previously set, the object will lose the pointer for it,
22727     * so if needs to be freed, you must do it yourself.
22728     *
22729     * @see elm_map_group_class_new() for more details.
22730     * @see elm_map_group_class_icon_cb_set()
22731     * @see elm_map_marker_add()
22732     *
22733     * @ingroup Map
22734     */
22735    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22736
22737    /**
22738     * Set the minimum zoom from where the markers are displayed.
22739     *
22740     * @param clas The group class.
22741     * @param zoom The minimum zoom.
22742     *
22743     * Markers only will be displayed when the map is displayed at @p zoom
22744     * or bigger.
22745     *
22746     * @see elm_map_group_class_new() for more details.
22747     * @see elm_map_marker_add()
22748     *
22749     * @ingroup Map
22750     */
22751    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22752
22753    /**
22754     * Set the zoom from where the markers are no more grouped.
22755     *
22756     * @param clas The group class.
22757     * @param zoom The maximum zoom.
22758     *
22759     * Markers only will be grouped when the map is displayed at
22760     * less than @p zoom.
22761     *
22762     * @see elm_map_group_class_new() for more details.
22763     * @see elm_map_marker_add()
22764     *
22765     * @ingroup Map
22766     */
22767    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22768
22769    /**
22770     * Set if the markers associated to the group class @clas are hidden or not.
22771     *
22772     * @param clas The group class.
22773     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22774     * to show them.
22775     *
22776     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22777     * is to show them.
22778     *
22779     * @ingroup Map
22780     */
22781    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22782
22783    /**
22784     * Create a new marker class.
22785     *
22786     * @param obj The map object.
22787     * @return Returns the new group class.
22788     *
22789     * Each marker must be associated to a class.
22790     *
22791     * The marker class defines the style of the marker when a marker is
22792     * displayed alone, i.e., not grouped to to others markers. When grouped
22793     * it will use group class style.
22794     *
22795     * A marker class will need to be provided when creating a marker with
22796     * elm_map_marker_add().
22797     *
22798     * Some properties and functions can be set by class, as:
22799     * - style, with elm_map_marker_class_style_set()
22800     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22801     *   It can be set using elm_map_marker_class_icon_cb_set().
22802     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22803     *   Set using elm_map_marker_class_get_cb_set().
22804     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22805     *   Set using elm_map_marker_class_del_cb_set().
22806     *
22807     * @see elm_map_marker_add()
22808     * @see elm_map_marker_class_style_set()
22809     * @see elm_map_marker_class_icon_cb_set()
22810     * @see elm_map_marker_class_get_cb_set()
22811     * @see elm_map_marker_class_del_cb_set()
22812     *
22813     * @ingroup Map
22814     */
22815    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22816
22817    /**
22818     * Set the marker's style of a marker class.
22819     *
22820     * @param clas The marker class.
22821     * @param style The style to be used by markers.
22822     *
22823     * Each marker must be associated to a marker class, and will use the style
22824     * defined by such class when alone, i.e., @b not grouped to other markers.
22825     *
22826     * The following styles are provided by default theme:
22827     * @li @c radio
22828     * @li @c radio2
22829     * @li @c empty
22830     *
22831     * @see elm_map_marker_class_new() for more details.
22832     * @see elm_map_marker_add()
22833     *
22834     * @ingroup Map
22835     */
22836    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22837
22838    /**
22839     * Set the icon callback function of a marker class.
22840     *
22841     * @param clas The marker class.
22842     * @param icon_get The callback function that will return the icon.
22843     *
22844     * Each marker must be associated to a marker class, and it can display a
22845     * custom icon. The function @p icon_get must return this icon.
22846     *
22847     * @see elm_map_marker_class_new() for more details.
22848     * @see elm_map_marker_add()
22849     *
22850     * @ingroup Map
22851     */
22852    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22853
22854    /**
22855     * Set the bubble content callback function of a marker class.
22856     *
22857     * @param clas The marker class.
22858     * @param get The callback function that will return the content.
22859     *
22860     * Each marker must be associated to a marker class, and it can display a
22861     * a content on a bubble that opens when the user click over the marker.
22862     * The function @p get must return this content object.
22863     *
22864     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22865     * can be used.
22866     *
22867     * @see elm_map_marker_class_new() for more details.
22868     * @see elm_map_marker_class_del_cb_set()
22869     * @see elm_map_marker_add()
22870     *
22871     * @ingroup Map
22872     */
22873    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22874
22875    /**
22876     * Set the callback function used to delete bubble content of a marker class.
22877     *
22878     * @param clas The marker class.
22879     * @param del The callback function that will delete the content.
22880     *
22881     * Each marker must be associated to a marker class, and it can display a
22882     * a content on a bubble that opens when the user click over the marker.
22883     * The function to return such content can be set with
22884     * elm_map_marker_class_get_cb_set().
22885     *
22886     * If this content must be freed, a callback function need to be
22887     * set for that task with this function.
22888     *
22889     * If this callback is defined it will have to delete (or not) the
22890     * object inside, but if the callback is not defined the object will be
22891     * destroyed with evas_object_del().
22892     *
22893     * @see elm_map_marker_class_new() for more details.
22894     * @see elm_map_marker_class_get_cb_set()
22895     * @see elm_map_marker_add()
22896     *
22897     * @ingroup Map
22898     */
22899    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22900
22901    /**
22902     * Get the list of available sources.
22903     *
22904     * @param obj The map object.
22905     * @return The source names list.
22906     *
22907     * It will provide a list with all available sources, that can be set as
22908     * current source with elm_map_source_name_set(), or get with
22909     * elm_map_source_name_get().
22910     *
22911     * Available sources:
22912     * @li "Mapnik"
22913     * @li "Osmarender"
22914     * @li "CycleMap"
22915     * @li "Maplint"
22916     *
22917     * @see elm_map_source_name_set() for more details.
22918     * @see elm_map_source_name_get()
22919     *
22920     * @ingroup Map
22921     */
22922    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22923
22924    /**
22925     * Set the source of the map.
22926     *
22927     * @param obj The map object.
22928     * @param source The source to be used.
22929     *
22930     * Map widget retrieves images that composes the map from a web service.
22931     * This web service can be set with this method.
22932     *
22933     * A different service can return a different maps with different
22934     * information and it can use different zoom values.
22935     *
22936     * The @p source_name need to match one of the names provided by
22937     * elm_map_source_names_get().
22938     *
22939     * The current source can be get using elm_map_source_name_get().
22940     *
22941     * @see elm_map_source_names_get()
22942     * @see elm_map_source_name_get()
22943     *
22944     *
22945     * @ingroup Map
22946     */
22947    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22948
22949    /**
22950     * Get the name of currently used source.
22951     *
22952     * @param obj The map object.
22953     * @return Returns the name of the source in use.
22954     *
22955     * @see elm_map_source_name_set() for more details.
22956     *
22957     * @ingroup Map
22958     */
22959    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22960
22961    /**
22962     * Set the source of the route service to be used by the map.
22963     *
22964     * @param obj The map object.
22965     * @param source The route service to be used, being it one of
22966     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22967     * and #ELM_MAP_ROUTE_SOURCE_ORS.
22968     *
22969     * Each one has its own algorithm, so the route retrieved may
22970     * differ depending on the source route. Now, only the default is working.
22971     *
22972     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22973     * http://www.yournavigation.org/.
22974     *
22975     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22976     * assumptions. Its routing core is based on Contraction Hierarchies.
22977     *
22978     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22979     *
22980     * @see elm_map_route_source_get().
22981     *
22982     * @ingroup Map
22983     */
22984    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22985
22986    /**
22987     * Get the current route source.
22988     *
22989     * @param obj The map object.
22990     * @return The source of the route service used by the map.
22991     *
22992     * @see elm_map_route_source_set() for details.
22993     *
22994     * @ingroup Map
22995     */
22996    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22997
22998    /**
22999     * Set the minimum zoom of the source.
23000     *
23001     * @param obj The map object.
23002     * @param zoom New minimum zoom value to be used.
23003     *
23004     * By default, it's 0.
23005     *
23006     * @ingroup Map
23007     */
23008    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23009
23010    /**
23011     * Get the minimum zoom of the source.
23012     *
23013     * @param obj The map object.
23014     * @return Returns the minimum zoom of the source.
23015     *
23016     * @see elm_map_source_zoom_min_set() for details.
23017     *
23018     * @ingroup Map
23019     */
23020    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23021
23022    /**
23023     * Set the maximum zoom of the source.
23024     *
23025     * @param obj The map object.
23026     * @param zoom New maximum zoom value to be used.
23027     *
23028     * By default, it's 18.
23029     *
23030     * @ingroup Map
23031     */
23032    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23033
23034    /**
23035     * Get the maximum zoom of the source.
23036     *
23037     * @param obj The map object.
23038     * @return Returns the maximum zoom of the source.
23039     *
23040     * @see elm_map_source_zoom_min_set() for details.
23041     *
23042     * @ingroup Map
23043     */
23044    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23045
23046    /**
23047     * Set the user agent used by the map object to access routing services.
23048     *
23049     * @param obj The map object.
23050     * @param user_agent The user agent to be used by the map.
23051     *
23052     * User agent is a client application implementing a network protocol used
23053     * in communications within a client–server distributed computing system
23054     *
23055     * The @p user_agent identification string will transmitted in a header
23056     * field @c User-Agent.
23057     *
23058     * @see elm_map_user_agent_get()
23059     *
23060     * @ingroup Map
23061     */
23062    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23063
23064    /**
23065     * Get the user agent used by the map object.
23066     *
23067     * @param obj The map object.
23068     * @return The user agent identification string used by the map.
23069     *
23070     * @see elm_map_user_agent_set() for details.
23071     *
23072     * @ingroup Map
23073     */
23074    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23075
23076    /**
23077     * Add a new route to the map object.
23078     *
23079     * @param obj The map object.
23080     * @param type The type of transport to be considered when tracing a route.
23081     * @param method The routing method, what should be priorized.
23082     * @param flon The start longitude.
23083     * @param flat The start latitude.
23084     * @param tlon The destination longitude.
23085     * @param tlat The destination latitude.
23086     *
23087     * @return The created route or @c NULL upon failure.
23088     *
23089     * A route will be traced by point on coordinates (@p flat, @p flon)
23090     * to point on coordinates (@p tlat, @p tlon), using the route service
23091     * set with elm_map_route_source_set().
23092     *
23093     * It will take @p type on consideration to define the route,
23094     * depending if the user will be walking or driving, the route may vary.
23095     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23096     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23097     *
23098     * Another parameter is what the route should priorize, the minor distance
23099     * or the less time to be spend on the route. So @p method should be one
23100     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23101     *
23102     * Routes created with this method can be deleted with
23103     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23104     * and distance can be get with elm_map_route_distance_get().
23105     *
23106     * @see elm_map_route_remove()
23107     * @see elm_map_route_color_set()
23108     * @see elm_map_route_distance_get()
23109     * @see elm_map_route_source_set()
23110     *
23111     * @ingroup Map
23112     */
23113    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);
23114
23115    /**
23116     * Remove a route from the map.
23117     *
23118     * @param route The route to remove.
23119     *
23120     * @see elm_map_route_add()
23121     *
23122     * @ingroup Map
23123     */
23124    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23125
23126    /**
23127     * Set the route color.
23128     *
23129     * @param route The route object.
23130     * @param r Red channel value, from 0 to 255.
23131     * @param g Green channel value, from 0 to 255.
23132     * @param b Blue channel value, from 0 to 255.
23133     * @param a Alpha channel value, from 0 to 255.
23134     *
23135     * It uses an additive color model, so each color channel represents
23136     * how much of each primary colors must to be used. 0 represents
23137     * ausence of this color, so if all of the three are set to 0,
23138     * the color will be black.
23139     *
23140     * These component values should be integers in the range 0 to 255,
23141     * (single 8-bit byte).
23142     *
23143     * This sets the color used for the route. By default, it is set to
23144     * solid red (r = 255, g = 0, b = 0, a = 255).
23145     *
23146     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23147     *
23148     * @see elm_map_route_color_get()
23149     *
23150     * @ingroup Map
23151     */
23152    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23153
23154    /**
23155     * Get the route color.
23156     *
23157     * @param route The route object.
23158     * @param r Pointer where to store the red channel value.
23159     * @param g Pointer where to store the green channel value.
23160     * @param b Pointer where to store the blue channel value.
23161     * @param a Pointer where to store the alpha channel value.
23162     *
23163     * @see elm_map_route_color_set() for details.
23164     *
23165     * @ingroup Map
23166     */
23167    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23168
23169    /**
23170     * Get the route distance in kilometers.
23171     *
23172     * @param route The route object.
23173     * @return The distance of route (unit : km).
23174     *
23175     * @ingroup Map
23176     */
23177    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23178
23179    /**
23180     * Get the information of route nodes.
23181     *
23182     * @param route The route object.
23183     * @return Returns a string with the nodes of route.
23184     *
23185     * @ingroup Map
23186     */
23187    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23188
23189    /**
23190     * Get the information of route waypoint.
23191     *
23192     * @param route the route object.
23193     * @return Returns a string with information about waypoint of route.
23194     *
23195     * @ingroup Map
23196     */
23197    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23198
23199    /**
23200     * Get the address of the name.
23201     *
23202     * @param name The name handle.
23203     * @return Returns the address string of @p name.
23204     *
23205     * This gets the coordinates of the @p name, created with one of the
23206     * conversion functions.
23207     *
23208     * @see elm_map_utils_convert_name_into_coord()
23209     * @see elm_map_utils_convert_coord_into_name()
23210     *
23211     * @ingroup Map
23212     */
23213    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23214
23215    /**
23216     * Get the current coordinates of the name.
23217     *
23218     * @param name The name handle.
23219     * @param lat Pointer where to store the latitude.
23220     * @param lon Pointer where to store The longitude.
23221     *
23222     * This gets the coordinates of the @p name, created with one of the
23223     * conversion functions.
23224     *
23225     * @see elm_map_utils_convert_name_into_coord()
23226     * @see elm_map_utils_convert_coord_into_name()
23227     *
23228     * @ingroup Map
23229     */
23230    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23231
23232    /**
23233     * Remove a name from the map.
23234     *
23235     * @param name The name to remove.
23236     *
23237     * Basically the struct handled by @p name will be freed, so convertions
23238     * between address and coordinates will be lost.
23239     *
23240     * @see elm_map_utils_convert_name_into_coord()
23241     * @see elm_map_utils_convert_coord_into_name()
23242     *
23243     * @ingroup Map
23244     */
23245    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23246
23247    /**
23248     * Rotate the map.
23249     *
23250     * @param obj The map object.
23251     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23252     * @param cx Rotation's center horizontal position.
23253     * @param cy Rotation's center vertical position.
23254     *
23255     * @see elm_map_rotate_get()
23256     *
23257     * @ingroup Map
23258     */
23259    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23260
23261    /**
23262     * Get the rotate degree of the map
23263     *
23264     * @param obj The map object
23265     * @param degree Pointer where to store degrees from 0.0 to 360.0
23266     * to rotate arount Z axis.
23267     * @param cx Pointer where to store rotation's center horizontal position.
23268     * @param cy Pointer where to store rotation's center vertical position.
23269     *
23270     * @see elm_map_rotate_set() to set map rotation.
23271     *
23272     * @ingroup Map
23273     */
23274    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);
23275
23276    /**
23277     * Enable or disable mouse wheel to be used to zoom in / out the map.
23278     *
23279     * @param obj The map object.
23280     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23281     * to enable it.
23282     *
23283     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23284     *
23285     * It's disabled by default.
23286     *
23287     * @see elm_map_wheel_disabled_get()
23288     *
23289     * @ingroup Map
23290     */
23291    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23292
23293    /**
23294     * Get a value whether mouse wheel is enabled or not.
23295     *
23296     * @param obj The map object.
23297     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23298     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23299     *
23300     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23301     *
23302     * @see elm_map_wheel_disabled_set() for details.
23303     *
23304     * @ingroup Map
23305     */
23306    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23307
23308 #ifdef ELM_EMAP
23309    /**
23310     * Add a track on the map
23311     *
23312     * @param obj The map object.
23313     * @param emap The emap route object.
23314     * @return The route object. This is an elm object of type Route.
23315     *
23316     * @see elm_route_add() for details.
23317     *
23318     * @ingroup Map
23319     */
23320    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23321 #endif
23322
23323    /**
23324     * Remove a track from the map
23325     *
23326     * @param obj The map object.
23327     * @param route The track to remove.
23328     *
23329     * @ingroup Map
23330     */
23331    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23332
23333    /**
23334     * @}
23335     */
23336
23337    /* Route */
23338    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23339 #ifdef ELM_EMAP
23340    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23341 #endif
23342    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23343    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23344    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23345    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23346
23347
23348    /**
23349     * @defgroup Panel Panel
23350     *
23351     * @image html img/widget/panel/preview-00.png
23352     * @image latex img/widget/panel/preview-00.eps
23353     *
23354     * @brief A panel is a type of animated container that contains subobjects.
23355     * It can be expanded or contracted by clicking the button on it's edge.
23356     *
23357     * Orientations are as follows:
23358     * @li ELM_PANEL_ORIENT_TOP
23359     * @li ELM_PANEL_ORIENT_LEFT
23360     * @li ELM_PANEL_ORIENT_RIGHT
23361     *
23362     * @ref tutorial_panel shows one way to use this widget.
23363     * @{
23364     */
23365    typedef enum _Elm_Panel_Orient
23366      {
23367         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23368         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23369         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23370         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23371      } Elm_Panel_Orient;
23372    /**
23373     * @brief Adds a panel object
23374     *
23375     * @param parent The parent object
23376     *
23377     * @return The panel object, or NULL on failure
23378     */
23379    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23380    /**
23381     * @brief Sets the orientation of the panel
23382     *
23383     * @param parent The parent object
23384     * @param orient The panel orientation. Can be one of the following:
23385     * @li ELM_PANEL_ORIENT_TOP
23386     * @li ELM_PANEL_ORIENT_LEFT
23387     * @li ELM_PANEL_ORIENT_RIGHT
23388     *
23389     * Sets from where the panel will (dis)appear.
23390     */
23391    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23392    /**
23393     * @brief Get the orientation of the panel.
23394     *
23395     * @param obj The panel object
23396     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23397     */
23398    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23399    /**
23400     * @brief Set the content of the panel.
23401     *
23402     * @param obj The panel object
23403     * @param content The panel content
23404     *
23405     * Once the content object is set, a previously set one will be deleted.
23406     * If you want to keep that old content object, use the
23407     * elm_panel_content_unset() function.
23408     */
23409    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23410    /**
23411     * @brief Get the content of the panel.
23412     *
23413     * @param obj The panel object
23414     * @return The content that is being used
23415     *
23416     * Return the content object which is set for this widget.
23417     *
23418     * @see elm_panel_content_set()
23419     */
23420    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23421    /**
23422     * @brief Unset the content of the panel.
23423     *
23424     * @param obj The panel object
23425     * @return The content that was being used
23426     *
23427     * Unparent and return the content object which was set for this widget.
23428     *
23429     * @see elm_panel_content_set()
23430     */
23431    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23432    /**
23433     * @brief Set the state of the panel.
23434     *
23435     * @param obj The panel object
23436     * @param hidden If true, the panel will run the animation to contract
23437     */
23438    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23439    /**
23440     * @brief Get the state of the panel.
23441     *
23442     * @param obj The panel object
23443     * @param hidden If true, the panel is in the "hide" state
23444     */
23445    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23446    /**
23447     * @brief Toggle the hidden state of the panel from code
23448     *
23449     * @param obj The panel object
23450     */
23451    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23452    /**
23453     * @}
23454     */
23455
23456    /**
23457     * @defgroup Panes Panes
23458     * @ingroup Elementary
23459     *
23460     * @image html img/widget/panes/preview-00.png
23461     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23462     *
23463     * @image html img/panes.png
23464     * @image latex img/panes.eps width=\textwidth
23465     *
23466     * The panes adds a dragable bar between two contents. When dragged
23467     * this bar will resize contents size.
23468     *
23469     * Panes can be displayed vertically or horizontally, and contents
23470     * size proportion can be customized (homogeneous by default).
23471     *
23472     * Smart callbacks one can listen to:
23473     * - "press" - The panes has been pressed (button wasn't released yet).
23474     * - "unpressed" - The panes was released after being pressed.
23475     * - "clicked" - The panes has been clicked>
23476     * - "clicked,double" - The panes has been double clicked
23477     *
23478     * Available styles for it:
23479     * - @c "default"
23480     *
23481     * Here is an example on its usage:
23482     * @li @ref panes_example
23483     */
23484
23485    /**
23486     * @addtogroup Panes
23487     * @{
23488     */
23489
23490    /**
23491     * Add a new panes widget to the given parent Elementary
23492     * (container) object.
23493     *
23494     * @param parent The parent object.
23495     * @return a new panes widget handle or @c NULL, on errors.
23496     *
23497     * This function inserts a new panes widget on the canvas.
23498     *
23499     * @ingroup Panes
23500     */
23501    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23502
23503    /**
23504     * Set the left content of the panes widget.
23505     *
23506     * @param obj The panes object.
23507     * @param content The new left content object.
23508     *
23509     * Once the content object is set, a previously set one will be deleted.
23510     * If you want to keep that old content object, use the
23511     * elm_panes_content_left_unset() function.
23512     *
23513     * If panes is displayed vertically, left content will be displayed at
23514     * top.
23515     *
23516     * @see elm_panes_content_left_get()
23517     * @see elm_panes_content_right_set() to set content on the other side.
23518     *
23519     * @ingroup Panes
23520     */
23521    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23522
23523    /**
23524     * Set the right content of the panes widget.
23525     *
23526     * @param obj The panes object.
23527     * @param content The new right content object.
23528     *
23529     * Once the content object is set, a previously set one will be deleted.
23530     * If you want to keep that old content object, use the
23531     * elm_panes_content_right_unset() function.
23532     *
23533     * If panes is displayed vertically, left content will be displayed at
23534     * bottom.
23535     *
23536     * @see elm_panes_content_right_get()
23537     * @see elm_panes_content_left_set() to set content on the other side.
23538     *
23539     * @ingroup Panes
23540     */
23541    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23542
23543    /**
23544     * Get the left content of the panes.
23545     *
23546     * @param obj The panes object.
23547     * @return The left content object that is being used.
23548     *
23549     * Return the left content object which is set for this widget.
23550     *
23551     * @see elm_panes_content_left_set() for details.
23552     *
23553     * @ingroup Panes
23554     */
23555    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23556
23557    /**
23558     * Get the right content of the panes.
23559     *
23560     * @param obj The panes object
23561     * @return The right content object that is being used
23562     *
23563     * Return the right content object which is set for this widget.
23564     *
23565     * @see elm_panes_content_right_set() for details.
23566     *
23567     * @ingroup Panes
23568     */
23569    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23570
23571    /**
23572     * Unset the left content used for the panes.
23573     *
23574     * @param obj The panes object.
23575     * @return The left content object that was being used.
23576     *
23577     * Unparent and return the left content object which was set for this widget.
23578     *
23579     * @see elm_panes_content_left_set() for details.
23580     * @see elm_panes_content_left_get().
23581     *
23582     * @ingroup Panes
23583     */
23584    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23585
23586    /**
23587     * Unset the right content used for the panes.
23588     *
23589     * @param obj The panes object.
23590     * @return The right content object that was being used.
23591     *
23592     * Unparent and return the right content object which was set for this
23593     * widget.
23594     *
23595     * @see elm_panes_content_right_set() for details.
23596     * @see elm_panes_content_right_get().
23597     *
23598     * @ingroup Panes
23599     */
23600    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23601
23602    /**
23603     * Get the size proportion of panes widget's left side.
23604     *
23605     * @param obj The panes object.
23606     * @return float value between 0.0 and 1.0 representing size proportion
23607     * of left side.
23608     *
23609     * @see elm_panes_content_left_size_set() for more details.
23610     *
23611     * @ingroup Panes
23612     */
23613    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23614
23615    /**
23616     * Set the size proportion of panes widget's left side.
23617     *
23618     * @param obj The panes object.
23619     * @param size Value between 0.0 and 1.0 representing size proportion
23620     * of left side.
23621     *
23622     * By default it's homogeneous, i.e., both sides have the same size.
23623     *
23624     * If something different is required, it can be set with this function.
23625     * For example, if the left content should be displayed over
23626     * 75% of the panes size, @p size should be passed as @c 0.75.
23627     * This way, right content will be resized to 25% of panes size.
23628     *
23629     * If displayed vertically, left content is displayed at top, and
23630     * right content at bottom.
23631     *
23632     * @note This proportion will change when user drags the panes bar.
23633     *
23634     * @see elm_panes_content_left_size_get()
23635     *
23636     * @ingroup Panes
23637     */
23638    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23639
23640   /**
23641    * Set the orientation of a given panes widget.
23642    *
23643    * @param obj The panes object.
23644    * @param horizontal Use @c EINA_TRUE to make @p obj to be
23645    * @b horizontal, @c EINA_FALSE to make it @b vertical.
23646    *
23647    * Use this function to change how your panes is to be
23648    * disposed: vertically or horizontally.
23649    *
23650    * By default it's displayed horizontally.
23651    *
23652    * @see elm_panes_horizontal_get()
23653    *
23654    * @ingroup Panes
23655    */
23656    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23657
23658    /**
23659     * Retrieve the orientation of a given panes widget.
23660     *
23661     * @param obj The panes object.
23662     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23663     * @c EINA_FALSE if it's @b vertical (and on errors).
23664     *
23665     * @see elm_panes_horizontal_set() for more details.
23666     *
23667     * @ingroup Panes
23668     */
23669    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23670    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23671    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23672
23673    /**
23674     * @}
23675     */
23676
23677    /**
23678     * @defgroup Flip Flip
23679     *
23680     * @image html img/widget/flip/preview-00.png
23681     * @image latex img/widget/flip/preview-00.eps
23682     *
23683     * This widget holds 2 content objects(Evas_Object): one on the front and one
23684     * on the back. It allows you to flip from front to back and vice-versa using
23685     * various animations.
23686     *
23687     * If either the front or back contents are not set the flip will treat that
23688     * as transparent. So if you wore to set the front content but not the back,
23689     * and then call elm_flip_go() you would see whatever is below the flip.
23690     *
23691     * For a list of supported animations see elm_flip_go().
23692     *
23693     * Signals that you can add callbacks for are:
23694     * "animate,begin" - when a flip animation was started
23695     * "animate,done" - when a flip animation is finished
23696     *
23697     * @ref tutorial_flip show how to use most of the API.
23698     *
23699     * @{
23700     */
23701    typedef enum _Elm_Flip_Mode
23702      {
23703         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23704         ELM_FLIP_ROTATE_X_CENTER_AXIS,
23705         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23706         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23707         ELM_FLIP_CUBE_LEFT,
23708         ELM_FLIP_CUBE_RIGHT,
23709         ELM_FLIP_CUBE_UP,
23710         ELM_FLIP_CUBE_DOWN,
23711         ELM_FLIP_PAGE_LEFT,
23712         ELM_FLIP_PAGE_RIGHT,
23713         ELM_FLIP_PAGE_UP,
23714         ELM_FLIP_PAGE_DOWN
23715      } Elm_Flip_Mode;
23716    typedef enum _Elm_Flip_Interaction
23717      {
23718         ELM_FLIP_INTERACTION_NONE,
23719         ELM_FLIP_INTERACTION_ROTATE,
23720         ELM_FLIP_INTERACTION_CUBE,
23721         ELM_FLIP_INTERACTION_PAGE
23722      } Elm_Flip_Interaction;
23723    typedef enum _Elm_Flip_Direction
23724      {
23725         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23726         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23727         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23728         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23729      } Elm_Flip_Direction;
23730    /**
23731     * @brief Add a new flip to the parent
23732     *
23733     * @param parent The parent object
23734     * @return The new object or NULL if it cannot be created
23735     */
23736    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23737    /**
23738     * @brief Set the front content of the flip widget.
23739     *
23740     * @param obj The flip object
23741     * @param content The new front content object
23742     *
23743     * Once the content object is set, a previously set one will be deleted.
23744     * If you want to keep that old content object, use the
23745     * elm_flip_content_front_unset() function.
23746     */
23747    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23748    /**
23749     * @brief Set the back content of the flip widget.
23750     *
23751     * @param obj The flip object
23752     * @param content The new back content object
23753     *
23754     * Once the content object is set, a previously set one will be deleted.
23755     * If you want to keep that old content object, use the
23756     * elm_flip_content_back_unset() function.
23757     */
23758    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23759    /**
23760     * @brief Get the front content used for the flip
23761     *
23762     * @param obj The flip object
23763     * @return The front content object that is being used
23764     *
23765     * Return the front content object which is set for this widget.
23766     */
23767    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23768    /**
23769     * @brief Get the back content used for the flip
23770     *
23771     * @param obj The flip object
23772     * @return The back content object that is being used
23773     *
23774     * Return the back content object which is set for this widget.
23775     */
23776    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23777    /**
23778     * @brief Unset the front content used for the flip
23779     *
23780     * @param obj The flip object
23781     * @return The front content object that was being used
23782     *
23783     * Unparent and return the front content object which was set for this widget.
23784     */
23785    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23786    /**
23787     * @brief Unset the back content used for the flip
23788     *
23789     * @param obj The flip object
23790     * @return The back content object that was being used
23791     *
23792     * Unparent and return the back content object which was set for this widget.
23793     */
23794    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23795    /**
23796     * @brief Get flip front visibility state
23797     *
23798     * @param obj The flip objct
23799     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23800     * showing.
23801     */
23802    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23803    /**
23804     * @brief Set flip perspective
23805     *
23806     * @param obj The flip object
23807     * @param foc The coordinate to set the focus on
23808     * @param x The X coordinate
23809     * @param y The Y coordinate
23810     *
23811     * @warning This function currently does nothing.
23812     */
23813    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23814    /**
23815     * @brief Runs the flip animation
23816     *
23817     * @param obj The flip object
23818     * @param mode The mode type
23819     *
23820     * Flips the front and back contents using the @p mode animation. This
23821     * efectively hides the currently visible content and shows the hidden one.
23822     *
23823     * There a number of possible animations to use for the flipping:
23824     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23825     * around a horizontal axis in the middle of its height, the other content
23826     * is shown as the other side of the flip.
23827     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23828     * around a vertical axis in the middle of its width, the other content is
23829     * shown as the other side of the flip.
23830     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23831     * around a diagonal axis in the middle of its width, the other content is
23832     * shown as the other side of the flip.
23833     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23834     * around a diagonal axis in the middle of its height, the other content is
23835     * shown as the other side of the flip.
23836     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23837     * as if the flip was a cube, the other content is show as the right face of
23838     * the cube.
23839     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23840     * right as if the flip was a cube, the other content is show as the left
23841     * face of the cube.
23842     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23843     * flip was a cube, the other content is show as the bottom face of the cube.
23844     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23845     * the flip was a cube, the other content is show as the upper face of the
23846     * cube.
23847     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23848     * if the flip was a book, the other content is shown as the page below that.
23849     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23850     * as if the flip was a book, the other content is shown as the page below
23851     * that.
23852     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23853     * flip was a book, the other content is shown as the page below that.
23854     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23855     * flip was a book, the other content is shown as the page below that.
23856     *
23857     * @image html elm_flip.png
23858     * @image latex elm_flip.eps width=\textwidth
23859     */
23860    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23861    /**
23862     * @brief Set the interactive flip mode
23863     *
23864     * @param obj The flip object
23865     * @param mode The interactive flip mode to use
23866     *
23867     * This sets if the flip should be interactive (allow user to click and
23868     * drag a side of the flip to reveal the back page and cause it to flip).
23869     * By default a flip is not interactive. You may also need to set which
23870     * sides of the flip are "active" for flipping and how much space they use
23871     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23872     * and elm_flip_interacton_direction_hitsize_set()
23873     *
23874     * The four avilable mode of interaction are:
23875     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23876     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23877     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23878     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23879     *
23880     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23881     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23882     * happen, those can only be acheived with elm_flip_go();
23883     */
23884    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23885    /**
23886     * @brief Get the interactive flip mode
23887     *
23888     * @param obj The flip object
23889     * @return The interactive flip mode
23890     *
23891     * Returns the interactive flip mode set by elm_flip_interaction_set()
23892     */
23893    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23894    /**
23895     * @brief Set which directions of the flip respond to interactive flip
23896     *
23897     * @param obj The flip object
23898     * @param dir The direction to change
23899     * @param enabled If that direction is enabled or not
23900     *
23901     * By default all directions are disabled, so you may want to enable the
23902     * desired directions for flipping if you need interactive flipping. You must
23903     * call this function once for each direction that should be enabled.
23904     *
23905     * @see elm_flip_interaction_set()
23906     */
23907    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23908    /**
23909     * @brief Get the enabled state of that flip direction
23910     *
23911     * @param obj The flip object
23912     * @param dir The direction to check
23913     * @return If that direction is enabled or not
23914     *
23915     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23916     *
23917     * @see elm_flip_interaction_set()
23918     */
23919    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23920    /**
23921     * @brief Set the amount of the flip that is sensitive to interactive flip
23922     *
23923     * @param obj The flip object
23924     * @param dir The direction to modify
23925     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23926     *
23927     * Set the amount of the flip that is sensitive to interactive flip, with 0
23928     * representing no area in the flip and 1 representing the entire flip. There
23929     * is however a consideration to be made in that the area will never be
23930     * smaller than the finger size set(as set in your Elementary configuration).
23931     *
23932     * @see elm_flip_interaction_set()
23933     */
23934    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23935    /**
23936     * @brief Get the amount of the flip that is sensitive to interactive flip
23937     *
23938     * @param obj The flip object
23939     * @param dir The direction to check
23940     * @return The size set for that direction
23941     *
23942     * Returns the amount os sensitive area set by
23943     * elm_flip_interacton_direction_hitsize_set().
23944     */
23945    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23946    /**
23947     * @}
23948     */
23949
23950    /* scrolledentry */
23951    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23952    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23953    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23954    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23955    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23956    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23957    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23958    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23959    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23960    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23961    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23962    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23963    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23964    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23965    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23966    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23967    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23968    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23969    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23970    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23971    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23972    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23973    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23974    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23975    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23976    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23977    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23978    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23979    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23980    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23981    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23982    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23983    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23984    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23985    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23986    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);
23987    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23988    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23989    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);
23990    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23991    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);
23992    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23993    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23994    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23995    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23996    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23997    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23998    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23999    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24000    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);
24001    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);
24002    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);
24003    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);
24004    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);
24005    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);
24006    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24007    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24008    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24009    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24010    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24011    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24012    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24013
24014    /**
24015     * @defgroup Conformant Conformant
24016     * @ingroup Elementary
24017     *
24018     * @image html img/widget/conformant/preview-00.png
24019     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24020     *
24021     * @image html img/conformant.png
24022     * @image latex img/conformant.eps width=\textwidth
24023     *
24024     * The aim is to provide a widget that can be used in elementary apps to
24025     * account for space taken up by the indicator, virtual keypad & softkey
24026     * windows when running the illume2 module of E17.
24027     *
24028     * So conformant content will be sized and positioned considering the
24029     * space required for such stuff, and when they popup, as a keyboard
24030     * shows when an entry is selected, conformant content won't change.
24031     *
24032     * Available styles for it:
24033     * - @c "default"
24034     *
24035     * See how to use this widget in this example:
24036     * @ref conformant_example
24037     */
24038
24039    /**
24040     * @addtogroup Conformant
24041     * @{
24042     */
24043
24044    /**
24045     * Add a new conformant widget to the given parent Elementary
24046     * (container) object.
24047     *
24048     * @param parent The parent object.
24049     * @return A new conformant widget handle or @c NULL, on errors.
24050     *
24051     * This function inserts a new conformant widget on the canvas.
24052     *
24053     * @ingroup Conformant
24054     */
24055    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24056
24057    /**
24058     * Set the content of the conformant widget.
24059     *
24060     * @param obj The conformant object.
24061     * @param content The content to be displayed by the conformant.
24062     *
24063     * Content will be sized and positioned considering the space required
24064     * to display a virtual keyboard. So it won't fill all the conformant
24065     * size. This way is possible to be sure that content won't resize
24066     * or be re-positioned after the keyboard is displayed.
24067     *
24068     * Once the content object is set, a previously set one will be deleted.
24069     * If you want to keep that old content object, use the
24070     * elm_conformat_content_unset() function.
24071     *
24072     * @see elm_conformant_content_unset()
24073     * @see elm_conformant_content_get()
24074     *
24075     * @ingroup Conformant
24076     */
24077    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24078
24079    /**
24080     * Get the content of the conformant widget.
24081     *
24082     * @param obj The conformant object.
24083     * @return The content that is being used.
24084     *
24085     * Return the content object which is set for this widget.
24086     * It won't be unparent from conformant. For that, use
24087     * elm_conformant_content_unset().
24088     *
24089     * @see elm_conformant_content_set() for more details.
24090     * @see elm_conformant_content_unset()
24091     *
24092     * @ingroup Conformant
24093     */
24094    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24095
24096    /**
24097     * Unset the content of the conformant widget.
24098     *
24099     * @param obj The conformant object.
24100     * @return The content that was being used.
24101     *
24102     * Unparent and return the content object which was set for this widget.
24103     *
24104     * @see elm_conformant_content_set() for more details.
24105     *
24106     * @ingroup Conformant
24107     */
24108    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24109
24110    /**
24111     * Returns the Evas_Object that represents the content area.
24112     *
24113     * @param obj The conformant object.
24114     * @return The content area of the widget.
24115     *
24116     * @ingroup Conformant
24117     */
24118    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24119
24120    /**
24121     * @}
24122     */
24123
24124    /**
24125     * @defgroup Mapbuf Mapbuf
24126     * @ingroup Elementary
24127     *
24128     * @image html img/widget/mapbuf/preview-00.png
24129     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24130     *
24131     * This holds one content object and uses an Evas Map of transformation
24132     * points to be later used with this content. So the content will be
24133     * moved, resized, etc as a single image. So it will improve performance
24134     * when you have a complex interafce, with a lot of elements, and will
24135     * need to resize or move it frequently (the content object and its
24136     * children).
24137     *
24138     * See how to use this widget in this example:
24139     * @ref mapbuf_example
24140     */
24141
24142    /**
24143     * @addtogroup Mapbuf
24144     * @{
24145     */
24146
24147    /**
24148     * Add a new mapbuf widget to the given parent Elementary
24149     * (container) object.
24150     *
24151     * @param parent The parent object.
24152     * @return A new mapbuf widget handle or @c NULL, on errors.
24153     *
24154     * This function inserts a new mapbuf widget on the canvas.
24155     *
24156     * @ingroup Mapbuf
24157     */
24158    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24159
24160    /**
24161     * Set the content of the mapbuf.
24162     *
24163     * @param obj The mapbuf object.
24164     * @param content The content that will be filled in this mapbuf object.
24165     *
24166     * Once the content object is set, a previously set one will be deleted.
24167     * If you want to keep that old content object, use the
24168     * elm_mapbuf_content_unset() function.
24169     *
24170     * To enable map, elm_mapbuf_enabled_set() should be used.
24171     *
24172     * @ingroup Mapbuf
24173     */
24174    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24175
24176    /**
24177     * Get the content of the mapbuf.
24178     *
24179     * @param obj The mapbuf object.
24180     * @return The content that is being used.
24181     *
24182     * Return the content object which is set for this widget.
24183     *
24184     * @see elm_mapbuf_content_set() for details.
24185     *
24186     * @ingroup Mapbuf
24187     */
24188    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24189
24190    /**
24191     * Unset the content of the mapbuf.
24192     *
24193     * @param obj The mapbuf object.
24194     * @return The content that was being used.
24195     *
24196     * Unparent and return the content object which was set for this widget.
24197     *
24198     * @see elm_mapbuf_content_set() for details.
24199     *
24200     * @ingroup Mapbuf
24201     */
24202    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24203
24204    /**
24205     * Enable or disable the map.
24206     *
24207     * @param obj The mapbuf object.
24208     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24209     *
24210     * This enables the map that is set or disables it. On enable, the object
24211     * geometry will be saved, and the new geometry will change (position and
24212     * size) to reflect the map geometry set.
24213     *
24214     * Also, when enabled, alpha and smooth states will be used, so if the
24215     * content isn't solid, alpha should be enabled, for example, otherwise
24216     * a black retangle will fill the content.
24217     *
24218     * When disabled, the stored map will be freed and geometry prior to
24219     * enabling the map will be restored.
24220     *
24221     * It's disabled by default.
24222     *
24223     * @see elm_mapbuf_alpha_set()
24224     * @see elm_mapbuf_smooth_set()
24225     *
24226     * @ingroup Mapbuf
24227     */
24228    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24229
24230    /**
24231     * Get a value whether map is enabled or not.
24232     *
24233     * @param obj The mapbuf object.
24234     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24235     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24236     *
24237     * @see elm_mapbuf_enabled_set() for details.
24238     *
24239     * @ingroup Mapbuf
24240     */
24241    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24242
24243    /**
24244     * Enable or disable smooth map rendering.
24245     *
24246     * @param obj The mapbuf object.
24247     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24248     * to disable it.
24249     *
24250     * This sets smoothing for map rendering. If the object is a type that has
24251     * its own smoothing settings, then both the smooth settings for this object
24252     * and the map must be turned off.
24253     *
24254     * By default smooth maps are enabled.
24255     *
24256     * @ingroup Mapbuf
24257     */
24258    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24259
24260    /**
24261     * Get a value whether smooth map rendering is enabled or not.
24262     *
24263     * @param obj The mapbuf object.
24264     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24265     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24266     *
24267     * @see elm_mapbuf_smooth_set() for details.
24268     *
24269     * @ingroup Mapbuf
24270     */
24271    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24272
24273    /**
24274     * Set or unset alpha flag for map rendering.
24275     *
24276     * @param obj The mapbuf object.
24277     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24278     * to disable it.
24279     *
24280     * This sets alpha flag for map rendering. If the object is a type that has
24281     * its own alpha settings, then this will take precedence. Only image objects
24282     * have this currently. It stops alpha blending of the map area, and is
24283     * useful if you know the object and/or all sub-objects is 100% solid.
24284     *
24285     * Alpha is enabled by default.
24286     *
24287     * @ingroup Mapbuf
24288     */
24289    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24290
24291    /**
24292     * Get a value whether alpha blending is enabled or not.
24293     *
24294     * @param obj The mapbuf object.
24295     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24296     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24297     *
24298     * @see elm_mapbuf_alpha_set() for details.
24299     *
24300     * @ingroup Mapbuf
24301     */
24302    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24303
24304    /**
24305     * @}
24306     */
24307
24308    /**
24309     * @defgroup Flipselector Flip Selector
24310     *
24311     * @image html img/widget/flipselector/preview-00.png
24312     * @image latex img/widget/flipselector/preview-00.eps
24313     *
24314     * A flip selector is a widget to show a set of @b text items, one
24315     * at a time, with the same sheet switching style as the @ref Clock
24316     * "clock" widget, when one changes the current displaying sheet
24317     * (thus, the "flip" in the name).
24318     *
24319     * User clicks to flip sheets which are @b held for some time will
24320     * make the flip selector to flip continuosly and automatically for
24321     * the user. The interval between flips will keep growing in time,
24322     * so that it helps the user to reach an item which is distant from
24323     * the current selection.
24324     *
24325     * Smart callbacks one can register to:
24326     * - @c "selected" - when the widget's selected text item is changed
24327     * - @c "overflowed" - when the widget's current selection is changed
24328     *   from the first item in its list to the last
24329     * - @c "underflowed" - when the widget's current selection is changed
24330     *   from the last item in its list to the first
24331     *
24332     * Available styles for it:
24333     * - @c "default"
24334     *
24335     * Here is an example on its usage:
24336     * @li @ref flipselector_example
24337     */
24338
24339    /**
24340     * @addtogroup Flipselector
24341     * @{
24342     */
24343
24344    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24345
24346    /**
24347     * Add a new flip selector widget to the given parent Elementary
24348     * (container) widget
24349     *
24350     * @param parent The parent object
24351     * @return a new flip selector widget handle or @c NULL, on errors
24352     *
24353     * This function inserts a new flip selector widget on the canvas.
24354     *
24355     * @ingroup Flipselector
24356     */
24357    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24358
24359    /**
24360     * Programmatically select the next item of a flip selector widget
24361     *
24362     * @param obj The flipselector object
24363     *
24364     * @note The selection will be animated. Also, if it reaches the
24365     * end of its list of member items, it will continue with the first
24366     * one onwards.
24367     *
24368     * @ingroup Flipselector
24369     */
24370    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24371
24372    /**
24373     * Programmatically select the previous item of a flip selector
24374     * widget
24375     *
24376     * @param obj The flipselector object
24377     *
24378     * @note The selection will be animated.  Also, if it reaches the
24379     * beginning of its list of member items, it will continue with the
24380     * last one backwards.
24381     *
24382     * @ingroup Flipselector
24383     */
24384    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24385
24386    /**
24387     * Append a (text) item to a flip selector widget
24388     *
24389     * @param obj The flipselector object
24390     * @param label The (text) label of the new item
24391     * @param func Convenience callback function to take place when
24392     * item is selected
24393     * @param data Data passed to @p func, above
24394     * @return A handle to the item added or @c NULL, on errors
24395     *
24396     * The widget's list of labels to show will be appended with the
24397     * given value. If the user wishes so, a callback function pointer
24398     * can be passed, which will get called when this same item is
24399     * selected.
24400     *
24401     * @note The current selection @b won't be modified by appending an
24402     * element to the list.
24403     *
24404     * @note The maximum length of the text label is going to be
24405     * determined <b>by the widget's theme</b>. Strings larger than
24406     * that value are going to be @b truncated.
24407     *
24408     * @ingroup Flipselector
24409     */
24410    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24411
24412    /**
24413     * Prepend a (text) item to a flip selector widget
24414     *
24415     * @param obj The flipselector object
24416     * @param label The (text) label of the new item
24417     * @param func Convenience callback function to take place when
24418     * item is selected
24419     * @param data Data passed to @p func, above
24420     * @return A handle to the item added or @c NULL, on errors
24421     *
24422     * The widget's list of labels to show will be prepended with the
24423     * given value. If the user wishes so, a callback function pointer
24424     * can be passed, which will get called when this same item is
24425     * selected.
24426     *
24427     * @note The current selection @b won't be modified by prepending
24428     * an element to the list.
24429     *
24430     * @note The maximum length of the text label is going to be
24431     * determined <b>by the widget's theme</b>. Strings larger than
24432     * that value are going to be @b truncated.
24433     *
24434     * @ingroup Flipselector
24435     */
24436    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24437
24438    /**
24439     * Get the internal list of items in a given flip selector widget.
24440     *
24441     * @param obj The flipselector object
24442     * @return The list of items (#Elm_Flipselector_Item as data) or
24443     * @c NULL on errors.
24444     *
24445     * This list is @b not to be modified in any way and must not be
24446     * freed. Use the list members with functions like
24447     * elm_flipselector_item_label_set(),
24448     * elm_flipselector_item_label_get(),
24449     * elm_flipselector_item_del(),
24450     * elm_flipselector_item_selected_get(),
24451     * elm_flipselector_item_selected_set().
24452     *
24453     * @warning This list is only valid until @p obj object's internal
24454     * items list is changed. It should be fetched again with another
24455     * call to this function when changes happen.
24456     *
24457     * @ingroup Flipselector
24458     */
24459    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24460
24461    /**
24462     * Get the first item in the given flip selector widget's list of
24463     * items.
24464     *
24465     * @param obj The flipselector object
24466     * @return The first item or @c NULL, if it has no items (and on
24467     * errors)
24468     *
24469     * @see elm_flipselector_item_append()
24470     * @see elm_flipselector_last_item_get()
24471     *
24472     * @ingroup Flipselector
24473     */
24474    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24475
24476    /**
24477     * Get the last item in the given flip selector widget's list of
24478     * items.
24479     *
24480     * @param obj The flipselector object
24481     * @return The last item or @c NULL, if it has no items (and on
24482     * errors)
24483     *
24484     * @see elm_flipselector_item_prepend()
24485     * @see elm_flipselector_first_item_get()
24486     *
24487     * @ingroup Flipselector
24488     */
24489    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24490
24491    /**
24492     * Get the currently selected item in a flip selector widget.
24493     *
24494     * @param obj The flipselector object
24495     * @return The selected item or @c NULL, if the widget has no items
24496     * (and on erros)
24497     *
24498     * @ingroup Flipselector
24499     */
24500    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24501
24502    /**
24503     * Set whether a given flip selector widget's item should be the
24504     * currently selected one.
24505     *
24506     * @param item The flip selector item
24507     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24508     *
24509     * This sets whether @p item is or not the selected (thus, under
24510     * display) one. If @p item is different than one under display,
24511     * the latter will be unselected. If the @p item is set to be
24512     * unselected, on the other hand, the @b first item in the widget's
24513     * internal members list will be the new selected one.
24514     *
24515     * @see elm_flipselector_item_selected_get()
24516     *
24517     * @ingroup Flipselector
24518     */
24519    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24520
24521    /**
24522     * Get whether a given flip selector widget's item is the currently
24523     * selected one.
24524     *
24525     * @param item The flip selector item
24526     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24527     * (or on errors).
24528     *
24529     * @see elm_flipselector_item_selected_set()
24530     *
24531     * @ingroup Flipselector
24532     */
24533    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24534
24535    /**
24536     * Delete a given item from a flip selector widget.
24537     *
24538     * @param item The item to delete
24539     *
24540     * @ingroup Flipselector
24541     */
24542    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24543
24544    /**
24545     * Get the label of a given flip selector widget's item.
24546     *
24547     * @param item The item to get label from
24548     * @return The text label of @p item or @c NULL, on errors
24549     *
24550     * @see elm_flipselector_item_label_set()
24551     *
24552     * @ingroup Flipselector
24553     */
24554    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24555
24556    /**
24557     * Set the label of a given flip selector widget's item.
24558     *
24559     * @param item The item to set label on
24560     * @param label The text label string, in UTF-8 encoding
24561     *
24562     * @see elm_flipselector_item_label_get()
24563     *
24564     * @ingroup Flipselector
24565     */
24566    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24567
24568    /**
24569     * Gets the item before @p item in a flip selector widget's
24570     * internal list of items.
24571     *
24572     * @param item The item to fetch previous from
24573     * @return The item before the @p item, in its parent's list. If
24574     *         there is no previous item for @p item or there's an
24575     *         error, @c NULL is returned.
24576     *
24577     * @see elm_flipselector_item_next_get()
24578     *
24579     * @ingroup Flipselector
24580     */
24581    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24582
24583    /**
24584     * Gets the item after @p item in a flip selector widget's
24585     * internal list of items.
24586     *
24587     * @param item The item to fetch next from
24588     * @return The item after the @p item, in its parent's list. If
24589     *         there is no next item for @p item or there's an
24590     *         error, @c NULL is returned.
24591     *
24592     * @see elm_flipselector_item_next_get()
24593     *
24594     * @ingroup Flipselector
24595     */
24596    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24597
24598    /**
24599     * Set the interval on time updates for an user mouse button hold
24600     * on a flip selector widget.
24601     *
24602     * @param obj The flip selector object
24603     * @param interval The (first) interval value in seconds
24604     *
24605     * This interval value is @b decreased while the user holds the
24606     * mouse pointer either flipping up or flipping doww a given flip
24607     * selector.
24608     *
24609     * This helps the user to get to a given item distant from the
24610     * current one easier/faster, as it will start to flip quicker and
24611     * quicker on mouse button holds.
24612     *
24613     * The calculation for the next flip interval value, starting from
24614     * the one set with this call, is the previous interval divided by
24615     * 1.05, so it decreases a little bit.
24616     *
24617     * The default starting interval value for automatic flips is
24618     * @b 0.85 seconds.
24619     *
24620     * @see elm_flipselector_interval_get()
24621     *
24622     * @ingroup Flipselector
24623     */
24624    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24625
24626    /**
24627     * Get the interval on time updates for an user mouse button hold
24628     * on a flip selector widget.
24629     *
24630     * @param obj The flip selector object
24631     * @return The (first) interval value, in seconds, set on it
24632     *
24633     * @see elm_flipselector_interval_set() for more details
24634     *
24635     * @ingroup Flipselector
24636     */
24637    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24638    /**
24639     * @}
24640     */
24641
24642    /**
24643     * @addtogroup Calendar
24644     * @{
24645     */
24646
24647    /**
24648     * @enum _Elm_Calendar_Mark_Repeat
24649     * @typedef Elm_Calendar_Mark_Repeat
24650     *
24651     * Event periodicity, used to define if a mark should be repeated
24652     * @b beyond event's day. It's set when a mark is added.
24653     *
24654     * So, for a mark added to 13th May with periodicity set to WEEKLY,
24655     * there will be marks every week after this date. Marks will be displayed
24656     * at 13th, 20th, 27th, 3rd June ...
24657     *
24658     * Values don't work as bitmask, only one can be choosen.
24659     *
24660     * @see elm_calendar_mark_add()
24661     *
24662     * @ingroup Calendar
24663     */
24664    typedef enum _Elm_Calendar_Mark_Repeat
24665      {
24666         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24667         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24668         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24669         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*/
24670         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. */
24671      } Elm_Calendar_Mark_Repeat;
24672
24673    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(). */
24674
24675    /**
24676     * Add a new calendar widget to the given parent Elementary
24677     * (container) object.
24678     *
24679     * @param parent The parent object.
24680     * @return a new calendar widget handle or @c NULL, on errors.
24681     *
24682     * This function inserts a new calendar widget on the canvas.
24683     *
24684     * @ref calendar_example_01
24685     *
24686     * @ingroup Calendar
24687     */
24688    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24689
24690    /**
24691     * Get weekdays names displayed by the calendar.
24692     *
24693     * @param obj The calendar object.
24694     * @return Array of seven strings to be used as weekday names.
24695     *
24696     * By default, weekdays abbreviations get from system are displayed:
24697     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24698     * The first string is related to Sunday, the second to Monday...
24699     *
24700     * @see elm_calendar_weekdays_name_set()
24701     *
24702     * @ref calendar_example_05
24703     *
24704     * @ingroup Calendar
24705     */
24706    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24707
24708    /**
24709     * Set weekdays names to be displayed by the calendar.
24710     *
24711     * @param obj The calendar object.
24712     * @param weekdays Array of seven strings to be used as weekday names.
24713     * @warning It must have 7 elements, or it will access invalid memory.
24714     * @warning The strings must be NULL terminated ('@\0').
24715     *
24716     * By default, weekdays abbreviations get from system are displayed:
24717     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24718     *
24719     * The first string should be related to Sunday, the second to Monday...
24720     *
24721     * The usage should be like this:
24722     * @code
24723     *   const char *weekdays[] =
24724     *   {
24725     *      "Sunday", "Monday", "Tuesday", "Wednesday",
24726     *      "Thursday", "Friday", "Saturday"
24727     *   };
24728     *   elm_calendar_weekdays_names_set(calendar, weekdays);
24729     * @endcode
24730     *
24731     * @see elm_calendar_weekdays_name_get()
24732     *
24733     * @ref calendar_example_02
24734     *
24735     * @ingroup Calendar
24736     */
24737    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24738
24739    /**
24740     * Set the minimum and maximum values for the year
24741     *
24742     * @param obj The calendar object
24743     * @param min The minimum year, greater than 1901;
24744     * @param max The maximum year;
24745     *
24746     * Maximum must be greater than minimum, except if you don't wan't to set
24747     * maximum year.
24748     * Default values are 1902 and -1.
24749     *
24750     * If the maximum year is a negative value, it will be limited depending
24751     * on the platform architecture (year 2037 for 32 bits);
24752     *
24753     * @see elm_calendar_min_max_year_get()
24754     *
24755     * @ref calendar_example_03
24756     *
24757     * @ingroup Calendar
24758     */
24759    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24760
24761    /**
24762     * Get the minimum and maximum values for the year
24763     *
24764     * @param obj The calendar object.
24765     * @param min The minimum year.
24766     * @param max The maximum year.
24767     *
24768     * Default values are 1902 and -1.
24769     *
24770     * @see elm_calendar_min_max_year_get() for more details.
24771     *
24772     * @ref calendar_example_05
24773     *
24774     * @ingroup Calendar
24775     */
24776    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24777
24778    /**
24779     * Enable or disable day selection
24780     *
24781     * @param obj The calendar object.
24782     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24783     * disable it.
24784     *
24785     * Enabled by default. If disabled, the user still can select months,
24786     * but not days. Selected days are highlighted on calendar.
24787     * It should be used if you won't need such selection for the widget usage.
24788     *
24789     * When a day is selected, or month is changed, smart callbacks for
24790     * signal "changed" will be called.
24791     *
24792     * @see elm_calendar_day_selection_enable_get()
24793     *
24794     * @ref calendar_example_04
24795     *
24796     * @ingroup Calendar
24797     */
24798    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24799
24800    /**
24801     * Get a value whether day selection is enabled or not.
24802     *
24803     * @see elm_calendar_day_selection_enable_set() for details.
24804     *
24805     * @param obj The calendar object.
24806     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24807     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24808     *
24809     * @ref calendar_example_05
24810     *
24811     * @ingroup Calendar
24812     */
24813    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24814
24815
24816    /**
24817     * Set selected date to be highlighted on calendar.
24818     *
24819     * @param obj The calendar object.
24820     * @param selected_time A @b tm struct to represent the selected date.
24821     *
24822     * Set the selected date, changing the displayed month if needed.
24823     * Selected date changes when the user goes to next/previous month or
24824     * select a day pressing over it on calendar.
24825     *
24826     * @see elm_calendar_selected_time_get()
24827     *
24828     * @ref calendar_example_04
24829     *
24830     * @ingroup Calendar
24831     */
24832    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
24833
24834    /**
24835     * Get selected date.
24836     *
24837     * @param obj The calendar object
24838     * @param selected_time A @b tm struct to point to selected date
24839     * @return EINA_FALSE means an error ocurred and returned time shouldn't
24840     * be considered.
24841     *
24842     * Get date selected by the user or set by function
24843     * elm_calendar_selected_time_set().
24844     * Selected date changes when the user goes to next/previous month or
24845     * select a day pressing over it on calendar.
24846     *
24847     * @see elm_calendar_selected_time_get()
24848     *
24849     * @ref calendar_example_05
24850     *
24851     * @ingroup Calendar
24852     */
24853    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
24854
24855    /**
24856     * Set a function to format the string that will be used to display
24857     * month and year;
24858     *
24859     * @param obj The calendar object
24860     * @param format_function Function to set the month-year string given
24861     * the selected date
24862     *
24863     * By default it uses strftime with "%B %Y" format string.
24864     * It should allocate the memory that will be used by the string,
24865     * that will be freed by the widget after usage.
24866     * A pointer to the string and a pointer to the time struct will be provided.
24867     *
24868     * Example:
24869     * @code
24870     * static char *
24871     * _format_month_year(struct tm *selected_time)
24872     * {
24873     *    char buf[32];
24874     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
24875     *    return strdup(buf);
24876     * }
24877     *
24878     * elm_calendar_format_function_set(calendar, _format_month_year);
24879     * @endcode
24880     *
24881     * @ref calendar_example_02
24882     *
24883     * @ingroup Calendar
24884     */
24885    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
24886
24887    /**
24888     * Add a new mark to the calendar
24889     *
24890     * @param obj The calendar object
24891     * @param mark_type A string used to define the type of mark. It will be
24892     * emitted to the theme, that should display a related modification on these
24893     * days representation.
24894     * @param mark_time A time struct to represent the date of inclusion of the
24895     * mark. For marks that repeats it will just be displayed after the inclusion
24896     * date in the calendar.
24897     * @param repeat Repeat the event following this periodicity. Can be a unique
24898     * mark (that don't repeat), daily, weekly, monthly or annually.
24899     * @return The created mark or @p NULL upon failure.
24900     *
24901     * Add a mark that will be drawn in the calendar respecting the insertion
24902     * time and periodicity. It will emit the type as signal to the widget theme.
24903     * Default theme supports "holiday" and "checked", but it can be extended.
24904     *
24905     * It won't immediately update the calendar, drawing the marks.
24906     * For this, call elm_calendar_marks_draw(). However, when user selects
24907     * next or previous month calendar forces marks drawn.
24908     *
24909     * Marks created with this method can be deleted with
24910     * elm_calendar_mark_del().
24911     *
24912     * Example
24913     * @code
24914     * struct tm selected_time;
24915     * time_t current_time;
24916     *
24917     * current_time = time(NULL) + 5 * 84600;
24918     * localtime_r(&current_time, &selected_time);
24919     * elm_calendar_mark_add(cal, "holiday", selected_time,
24920     *     ELM_CALENDAR_ANNUALLY);
24921     *
24922     * current_time = time(NULL) + 1 * 84600;
24923     * localtime_r(&current_time, &selected_time);
24924     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
24925     *
24926     * elm_calendar_marks_draw(cal);
24927     * @endcode
24928     *
24929     * @see elm_calendar_marks_draw()
24930     * @see elm_calendar_mark_del()
24931     *
24932     * @ref calendar_example_06
24933     *
24934     * @ingroup Calendar
24935     */
24936    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);
24937
24938    /**
24939     * Delete mark from the calendar.
24940     *
24941     * @param mark The mark to be deleted.
24942     *
24943     * If deleting all calendar marks is required, elm_calendar_marks_clear()
24944     * should be used instead of getting marks list and deleting each one.
24945     *
24946     * @see elm_calendar_mark_add()
24947     *
24948     * @ref calendar_example_06
24949     *
24950     * @ingroup Calendar
24951     */
24952    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
24953
24954    /**
24955     * Remove all calendar's marks
24956     *
24957     * @param obj The calendar object.
24958     *
24959     * @see elm_calendar_mark_add()
24960     * @see elm_calendar_mark_del()
24961     *
24962     * @ingroup Calendar
24963     */
24964    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24965
24966
24967    /**
24968     * Get a list of all the calendar marks.
24969     *
24970     * @param obj The calendar object.
24971     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24972     *
24973     * @see elm_calendar_mark_add()
24974     * @see elm_calendar_mark_del()
24975     * @see elm_calendar_marks_clear()
24976     *
24977     * @ingroup Calendar
24978     */
24979    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24980
24981    /**
24982     * Draw calendar marks.
24983     *
24984     * @param obj The calendar object.
24985     *
24986     * Should be used after adding, removing or clearing marks.
24987     * It will go through the entire marks list updating the calendar.
24988     * If lots of marks will be added, add all the marks and then call
24989     * this function.
24990     *
24991     * When the month is changed, i.e. user selects next or previous month,
24992     * marks will be drawed.
24993     *
24994     * @see elm_calendar_mark_add()
24995     * @see elm_calendar_mark_del()
24996     * @see elm_calendar_marks_clear()
24997     *
24998     * @ref calendar_example_06
24999     *
25000     * @ingroup Calendar
25001     */
25002    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25003
25004    /**
25005     * Set a day text color to the same that represents Saturdays.
25006     *
25007     * @param obj The calendar object.
25008     * @param pos The text position. Position is the cell counter, from left
25009     * to right, up to down. It starts on 0 and ends on 41.
25010     *
25011     * @deprecated use elm_calendar_mark_add() instead like:
25012     *
25013     * @code
25014     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25015     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25016     * @endcode
25017     *
25018     * @see elm_calendar_mark_add()
25019     *
25020     * @ingroup Calendar
25021     */
25022    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25023
25024    /**
25025     * Set a day text color to the same that represents Sundays.
25026     *
25027     * @param obj The calendar object.
25028     * @param pos The text position. Position is the cell counter, from left
25029     * to right, up to down. It starts on 0 and ends on 41.
25030
25031     * @deprecated use elm_calendar_mark_add() instead like:
25032     *
25033     * @code
25034     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25035     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25036     * @endcode
25037     *
25038     * @see elm_calendar_mark_add()
25039     *
25040     * @ingroup Calendar
25041     */
25042    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25043
25044    /**
25045     * Set a day text color to the same that represents Weekdays.
25046     *
25047     * @param obj The calendar object
25048     * @param pos The text position. Position is the cell counter, from left
25049     * to right, up to down. It starts on 0 and ends on 41.
25050     *
25051     * @deprecated use elm_calendar_mark_add() instead like:
25052     *
25053     * @code
25054     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25055     *
25056     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25057     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25058     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25059     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25060     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25061     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25062     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25063     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25064     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25065     * @endcode
25066     *
25067     * @see elm_calendar_mark_add()
25068     *
25069     * @ingroup Calendar
25070     */
25071    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25072
25073    /**
25074     * Set the interval on time updates for an user mouse button hold
25075     * on calendar widgets' month selection.
25076     *
25077     * @param obj The calendar object
25078     * @param interval The (first) interval value in seconds
25079     *
25080     * This interval value is @b decreased while the user holds the
25081     * mouse pointer either selecting next or previous month.
25082     *
25083     * This helps the user to get to a given month distant from the
25084     * current one easier/faster, as it will start to change quicker and
25085     * quicker on mouse button holds.
25086     *
25087     * The calculation for the next change interval value, starting from
25088     * the one set with this call, is the previous interval divided by
25089     * 1.05, so it decreases a little bit.
25090     *
25091     * The default starting interval value for automatic changes is
25092     * @b 0.85 seconds.
25093     *
25094     * @see elm_calendar_interval_get()
25095     *
25096     * @ingroup Calendar
25097     */
25098    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25099
25100    /**
25101     * Get the interval on time updates for an user mouse button hold
25102     * on calendar widgets' month selection.
25103     *
25104     * @param obj The calendar object
25105     * @return The (first) interval value, in seconds, set on it
25106     *
25107     * @see elm_calendar_interval_set() for more details
25108     *
25109     * @ingroup Calendar
25110     */
25111    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25112
25113    /**
25114     * @}
25115     */
25116
25117    /**
25118     * @defgroup Diskselector Diskselector
25119     * @ingroup Elementary
25120     *
25121     * @image html img/widget/diskselector/preview-00.png
25122     * @image latex img/widget/diskselector/preview-00.eps
25123     *
25124     * A diskselector is a kind of list widget. It scrolls horizontally,
25125     * and can contain label and icon objects. Three items are displayed
25126     * with the selected one in the middle.
25127     *
25128     * It can act like a circular list with round mode and labels can be
25129     * reduced for a defined length for side items.
25130     *
25131     * Smart callbacks one can listen to:
25132     * - "selected" - when item is selected, i.e. scroller stops.
25133     *
25134     * Available styles for it:
25135     * - @c "default"
25136     *
25137     * List of examples:
25138     * @li @ref diskselector_example_01
25139     * @li @ref diskselector_example_02
25140     */
25141
25142    /**
25143     * @addtogroup Diskselector
25144     * @{
25145     */
25146
25147    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(). */
25148
25149    /**
25150     * Add a new diskselector widget to the given parent Elementary
25151     * (container) object.
25152     *
25153     * @param parent The parent object.
25154     * @return a new diskselector widget handle or @c NULL, on errors.
25155     *
25156     * This function inserts a new diskselector widget on the canvas.
25157     *
25158     * @ingroup Diskselector
25159     */
25160    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25161
25162    /**
25163     * Enable or disable round mode.
25164     *
25165     * @param obj The diskselector object.
25166     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25167     * disable it.
25168     *
25169     * Disabled by default. If round mode is enabled the items list will
25170     * work like a circle list, so when the user reaches the last item,
25171     * the first one will popup.
25172     *
25173     * @see elm_diskselector_round_get()
25174     *
25175     * @ingroup Diskselector
25176     */
25177    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25178
25179    /**
25180     * Get a value whether round mode is enabled or not.
25181     *
25182     * @see elm_diskselector_round_set() for details.
25183     *
25184     * @param obj The diskselector object.
25185     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25186     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25187     *
25188     * @ingroup Diskselector
25189     */
25190    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25191
25192    /**
25193     * Get the side labels max length.
25194     *
25195     * @deprecated use elm_diskselector_side_label_length_get() instead:
25196     *
25197     * @param obj The diskselector object.
25198     * @return The max length defined for side labels, or 0 if not a valid
25199     * diskselector.
25200     *
25201     * @ingroup Diskselector
25202     */
25203    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25204
25205    /**
25206     * Set the side labels max length.
25207     *
25208     * @deprecated use elm_diskselector_side_label_length_set() instead:
25209     *
25210     * @param obj The diskselector object.
25211     * @param len The max length defined for side labels.
25212     *
25213     * @ingroup Diskselector
25214     */
25215    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25216
25217    /**
25218     * Get the side labels max length.
25219     *
25220     * @see elm_diskselector_side_label_length_set() for details.
25221     *
25222     * @param obj The diskselector object.
25223     * @return The max length defined for side labels, or 0 if not a valid
25224     * diskselector.
25225     *
25226     * @ingroup Diskselector
25227     */
25228    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25229
25230    /**
25231     * Set the side labels max length.
25232     *
25233     * @param obj The diskselector object.
25234     * @param len The max length defined for side labels.
25235     *
25236     * Length is the number of characters of items' label that will be
25237     * visible when it's set on side positions. It will just crop
25238     * the string after defined size. E.g.:
25239     *
25240     * An item with label "January" would be displayed on side position as
25241     * "Jan" if max length is set to 3, or "Janu", if this property
25242     * is set to 4.
25243     *
25244     * When it's selected, the entire label will be displayed, except for
25245     * width restrictions. In this case label will be cropped and "..."
25246     * will be concatenated.
25247     *
25248     * Default side label max length is 3.
25249     *
25250     * This property will be applyed over all items, included before or
25251     * later this function call.
25252     *
25253     * @ingroup Diskselector
25254     */
25255    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25256
25257    /**
25258     * Set the number of items to be displayed.
25259     *
25260     * @param obj The diskselector object.
25261     * @param num The number of items the diskselector will display.
25262     *
25263     * Default value is 3, and also it's the minimun. If @p num is less
25264     * than 3, it will be set to 3.
25265     *
25266     * Also, it can be set on theme, using data item @c display_item_num
25267     * on group "elm/diskselector/item/X", where X is style set.
25268     * E.g.:
25269     *
25270     * group { name: "elm/diskselector/item/X";
25271     * data {
25272     *     item: "display_item_num" "5";
25273     *     }
25274     *
25275     * @ingroup Diskselector
25276     */
25277    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25278
25279    /**
25280     * Get the number of items in the diskselector object.
25281     *
25282     * @param obj The diskselector object.
25283     *
25284     * @ingroup Diskselector
25285     */
25286    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25287
25288    /**
25289     * Set bouncing behaviour when the scrolled content reaches an edge.
25290     *
25291     * Tell the internal scroller object whether it should bounce or not
25292     * when it reaches the respective edges for each axis.
25293     *
25294     * @param obj The diskselector object.
25295     * @param h_bounce Whether to bounce or not in the horizontal axis.
25296     * @param v_bounce Whether to bounce or not in the vertical axis.
25297     *
25298     * @see elm_scroller_bounce_set()
25299     *
25300     * @ingroup Diskselector
25301     */
25302    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25303
25304    /**
25305     * Get the bouncing behaviour of the internal scroller.
25306     *
25307     * Get whether the internal scroller should bounce when the edge of each
25308     * axis is reached scrolling.
25309     *
25310     * @param obj The diskselector object.
25311     * @param h_bounce Pointer where to store the bounce state of the horizontal
25312     * axis.
25313     * @param v_bounce Pointer where to store the bounce state of the vertical
25314     * axis.
25315     *
25316     * @see elm_scroller_bounce_get()
25317     * @see elm_diskselector_bounce_set()
25318     *
25319     * @ingroup Diskselector
25320     */
25321    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25322
25323    /**
25324     * Get the scrollbar policy.
25325     *
25326     * @see elm_diskselector_scroller_policy_get() for details.
25327     *
25328     * @param obj The diskselector object.
25329     * @param policy_h Pointer where to store horizontal scrollbar policy.
25330     * @param policy_v Pointer where to store vertical scrollbar policy.
25331     *
25332     * @ingroup Diskselector
25333     */
25334    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);
25335
25336    /**
25337     * Set the scrollbar policy.
25338     *
25339     * @param obj The diskselector object.
25340     * @param policy_h Horizontal scrollbar policy.
25341     * @param policy_v Vertical scrollbar policy.
25342     *
25343     * This sets the scrollbar visibility policy for the given scroller.
25344     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25345     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25346     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25347     * This applies respectively for the horizontal and vertical scrollbars.
25348     *
25349     * The both are disabled by default, i.e., are set to
25350     * #ELM_SCROLLER_POLICY_OFF.
25351     *
25352     * @ingroup Diskselector
25353     */
25354    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25355
25356    /**
25357     * Remove all diskselector's items.
25358     *
25359     * @param obj The diskselector object.
25360     *
25361     * @see elm_diskselector_item_del()
25362     * @see elm_diskselector_item_append()
25363     *
25364     * @ingroup Diskselector
25365     */
25366    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25367
25368    /**
25369     * Get a list of all the diskselector items.
25370     *
25371     * @param obj The diskselector object.
25372     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25373     * or @c NULL on failure.
25374     *
25375     * @see elm_diskselector_item_append()
25376     * @see elm_diskselector_item_del()
25377     * @see elm_diskselector_clear()
25378     *
25379     * @ingroup Diskselector
25380     */
25381    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25382
25383    /**
25384     * Appends a new item to the diskselector object.
25385     *
25386     * @param obj The diskselector object.
25387     * @param label The label of the diskselector item.
25388     * @param icon The icon object to use at left side of the item. An
25389     * icon can be any Evas object, but usually it is an icon created
25390     * with elm_icon_add().
25391     * @param func The function to call when the item is selected.
25392     * @param data The data to associate with the item for related callbacks.
25393     *
25394     * @return The created item or @c NULL upon failure.
25395     *
25396     * A new item will be created and appended to the diskselector, i.e., will
25397     * be set as last item. Also, if there is no selected item, it will
25398     * be selected. This will always happens for the first appended item.
25399     *
25400     * If no icon is set, label will be centered on item position, otherwise
25401     * the icon will be placed at left of the label, that will be shifted
25402     * to the right.
25403     *
25404     * Items created with this method can be deleted with
25405     * elm_diskselector_item_del().
25406     *
25407     * Associated @p data can be properly freed when item is deleted if a
25408     * callback function is set with elm_diskselector_item_del_cb_set().
25409     *
25410     * If a function is passed as argument, it will be called everytime this item
25411     * is selected, i.e., the user stops the diskselector with this
25412     * item on center position. If such function isn't needed, just passing
25413     * @c NULL as @p func is enough. The same should be done for @p data.
25414     *
25415     * Simple example (with no function callback or data associated):
25416     * @code
25417     * disk = elm_diskselector_add(win);
25418     * ic = elm_icon_add(win);
25419     * elm_icon_file_set(ic, "path/to/image", NULL);
25420     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25421     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25422     * @endcode
25423     *
25424     * @see elm_diskselector_item_del()
25425     * @see elm_diskselector_item_del_cb_set()
25426     * @see elm_diskselector_clear()
25427     * @see elm_icon_add()
25428     *
25429     * @ingroup Diskselector
25430     */
25431    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);
25432
25433
25434    /**
25435     * Delete them item from the diskselector.
25436     *
25437     * @param it The item of diskselector to be deleted.
25438     *
25439     * If deleting all diskselector items is required, elm_diskselector_clear()
25440     * should be used instead of getting items list and deleting each one.
25441     *
25442     * @see elm_diskselector_clear()
25443     * @see elm_diskselector_item_append()
25444     * @see elm_diskselector_item_del_cb_set()
25445     *
25446     * @ingroup Diskselector
25447     */
25448    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25449
25450    /**
25451     * Set the function called when a diskselector item is freed.
25452     *
25453     * @param it The item to set the callback on
25454     * @param func The function called
25455     *
25456     * If there is a @p func, then it will be called prior item's memory release.
25457     * That will be called with the following arguments:
25458     * @li item's data;
25459     * @li item's Evas object;
25460     * @li item itself;
25461     *
25462     * This way, a data associated to a diskselector item could be properly
25463     * freed.
25464     *
25465     * @ingroup Diskselector
25466     */
25467    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25468
25469    /**
25470     * Get the data associated to the item.
25471     *
25472     * @param it The diskselector item
25473     * @return The data associated to @p it
25474     *
25475     * The return value is a pointer to data associated to @p item when it was
25476     * created, with function elm_diskselector_item_append(). If no data
25477     * was passed as argument, it will return @c NULL.
25478     *
25479     * @see elm_diskselector_item_append()
25480     *
25481     * @ingroup Diskselector
25482     */
25483    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25484
25485    /**
25486     * Set the icon associated to the item.
25487     *
25488     * @param it The diskselector item
25489     * @param icon The icon object to associate with @p it
25490     *
25491     * The icon object to use at left side of the item. An
25492     * icon can be any Evas object, but usually it is an icon created
25493     * with elm_icon_add().
25494     *
25495     * Once the icon object is set, a previously set one will be deleted.
25496     * @warning Setting the same icon for two items will cause the icon to
25497     * dissapear from the first item.
25498     *
25499     * If an icon was passed as argument on item creation, with function
25500     * elm_diskselector_item_append(), it will be already
25501     * associated to the item.
25502     *
25503     * @see elm_diskselector_item_append()
25504     * @see elm_diskselector_item_icon_get()
25505     *
25506     * @ingroup Diskselector
25507     */
25508    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25509
25510    /**
25511     * Get the icon associated to the item.
25512     *
25513     * @param it The diskselector item
25514     * @return The icon associated to @p it
25515     *
25516     * The return value is a pointer to the icon associated to @p item when it was
25517     * created, with function elm_diskselector_item_append(), or later
25518     * with function elm_diskselector_item_icon_set. If no icon
25519     * was passed as argument, it will return @c NULL.
25520     *
25521     * @see elm_diskselector_item_append()
25522     * @see elm_diskselector_item_icon_set()
25523     *
25524     * @ingroup Diskselector
25525     */
25526    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25527
25528    /**
25529     * Set the label of item.
25530     *
25531     * @param it The item of diskselector.
25532     * @param label The label of item.
25533     *
25534     * The label to be displayed by the item.
25535     *
25536     * If no icon is set, label will be centered on item position, otherwise
25537     * the icon will be placed at left of the label, that will be shifted
25538     * to the right.
25539     *
25540     * An item with label "January" would be displayed on side position as
25541     * "Jan" if max length is set to 3 with function
25542     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25543     * is set to 4.
25544     *
25545     * When this @p item is selected, the entire label will be displayed,
25546     * except for width restrictions.
25547     * In this case label will be cropped and "..." will be concatenated,
25548     * but only for display purposes. It will keep the entire string, so
25549     * if diskselector is resized the remaining characters will be displayed.
25550     *
25551     * If a label was passed as argument on item creation, with function
25552     * elm_diskselector_item_append(), it will be already
25553     * displayed by the item.
25554     *
25555     * @see elm_diskselector_side_label_lenght_set()
25556     * @see elm_diskselector_item_label_get()
25557     * @see elm_diskselector_item_append()
25558     *
25559     * @ingroup Diskselector
25560     */
25561    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25562
25563    /**
25564     * Get the label of item.
25565     *
25566     * @param it The item of diskselector.
25567     * @return The label of item.
25568     *
25569     * The return value is a pointer to the label associated to @p item when it was
25570     * created, with function elm_diskselector_item_append(), or later
25571     * with function elm_diskselector_item_label_set. If no label
25572     * was passed as argument, it will return @c NULL.
25573     *
25574     * @see elm_diskselector_item_label_set() for more details.
25575     * @see elm_diskselector_item_append()
25576     *
25577     * @ingroup Diskselector
25578     */
25579    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25580
25581    /**
25582     * Get the selected item.
25583     *
25584     * @param obj The diskselector object.
25585     * @return The selected diskselector item.
25586     *
25587     * The selected item can be unselected with function
25588     * elm_diskselector_item_selected_set(), and the first item of
25589     * diskselector will be selected.
25590     *
25591     * The selected item always will be centered on diskselector, with
25592     * full label displayed, i.e., max lenght set to side labels won't
25593     * apply on the selected item. More details on
25594     * elm_diskselector_side_label_length_set().
25595     *
25596     * @ingroup Diskselector
25597     */
25598    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25599
25600    /**
25601     * Set the selected state of an item.
25602     *
25603     * @param it The diskselector item
25604     * @param selected The selected state
25605     *
25606     * This sets the selected state of the given item @p it.
25607     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25608     *
25609     * If a new item is selected the previosly selected will be unselected.
25610     * Previoulsy selected item can be get with function
25611     * elm_diskselector_selected_item_get().
25612     *
25613     * If the item @p it is unselected, the first item of diskselector will
25614     * be selected.
25615     *
25616     * Selected items will be visible on center position of diskselector.
25617     * So if it was on another position before selected, or was invisible,
25618     * diskselector will animate items until the selected item reaches center
25619     * position.
25620     *
25621     * @see elm_diskselector_item_selected_get()
25622     * @see elm_diskselector_selected_item_get()
25623     *
25624     * @ingroup Diskselector
25625     */
25626    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25627
25628    /*
25629     * Get whether the @p item is selected or not.
25630     *
25631     * @param it The diskselector item.
25632     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25633     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25634     *
25635     * @see elm_diskselector_selected_item_set() for details.
25636     * @see elm_diskselector_item_selected_get()
25637     *
25638     * @ingroup Diskselector
25639     */
25640    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25641
25642    /**
25643     * Get the first item of the diskselector.
25644     *
25645     * @param obj The diskselector object.
25646     * @return The first item, or @c NULL if none.
25647     *
25648     * The list of items follows append order. So it will return the first
25649     * item appended to the widget that wasn't deleted.
25650     *
25651     * @see elm_diskselector_item_append()
25652     * @see elm_diskselector_items_get()
25653     *
25654     * @ingroup Diskselector
25655     */
25656    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25657
25658    /**
25659     * Get the last item of the diskselector.
25660     *
25661     * @param obj The diskselector object.
25662     * @return The last item, or @c NULL if none.
25663     *
25664     * The list of items follows append order. So it will return last first
25665     * item appended to the widget that wasn't deleted.
25666     *
25667     * @see elm_diskselector_item_append()
25668     * @see elm_diskselector_items_get()
25669     *
25670     * @ingroup Diskselector
25671     */
25672    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25673
25674    /**
25675     * Get the item before @p item in diskselector.
25676     *
25677     * @param it The diskselector item.
25678     * @return The item before @p item, or @c NULL if none or on failure.
25679     *
25680     * The list of items follows append order. So it will return item appended
25681     * just before @p item and that wasn't deleted.
25682     *
25683     * If it is the first item, @c NULL will be returned.
25684     * First item can be get by elm_diskselector_first_item_get().
25685     *
25686     * @see elm_diskselector_item_append()
25687     * @see elm_diskselector_items_get()
25688     *
25689     * @ingroup Diskselector
25690     */
25691    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25692
25693    /**
25694     * Get the item after @p item in diskselector.
25695     *
25696     * @param it The diskselector item.
25697     * @return The item after @p item, or @c NULL if none or on failure.
25698     *
25699     * The list of items follows append order. So it will return item appended
25700     * just after @p item and that wasn't deleted.
25701     *
25702     * If it is the last item, @c NULL will be returned.
25703     * Last item can be get by elm_diskselector_last_item_get().
25704     *
25705     * @see elm_diskselector_item_append()
25706     * @see elm_diskselector_items_get()
25707     *
25708     * @ingroup Diskselector
25709     */
25710    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25711
25712    /**
25713     * Set the text to be shown in the diskselector item.
25714     *
25715     * @param item Target item
25716     * @param text The text to set in the content
25717     *
25718     * Setup the text as tooltip to object. The item can have only one tooltip,
25719     * so any previous tooltip data is removed.
25720     *
25721     * @see elm_object_tooltip_text_set() for more details.
25722     *
25723     * @ingroup Diskselector
25724     */
25725    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25726
25727    /**
25728     * Set the content to be shown in the tooltip item.
25729     *
25730     * Setup the tooltip to item. The item can have only one tooltip,
25731     * so any previous tooltip data is removed. @p func(with @p data) will
25732     * be called every time that need show the tooltip and it should
25733     * return a valid Evas_Object. This object is then managed fully by
25734     * tooltip system and is deleted when the tooltip is gone.
25735     *
25736     * @param item the diskselector item being attached a tooltip.
25737     * @param func the function used to create the tooltip contents.
25738     * @param data what to provide to @a func as callback data/context.
25739     * @param del_cb called when data is not needed anymore, either when
25740     *        another callback replaces @p func, the tooltip is unset with
25741     *        elm_diskselector_item_tooltip_unset() or the owner @a item
25742     *        dies. This callback receives as the first parameter the
25743     *        given @a data, and @c event_info is the item.
25744     *
25745     * @see elm_object_tooltip_content_cb_set() for more details.
25746     *
25747     * @ingroup Diskselector
25748     */
25749    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);
25750
25751    /**
25752     * Unset tooltip from item.
25753     *
25754     * @param item diskselector item to remove previously set tooltip.
25755     *
25756     * Remove tooltip from item. The callback provided as del_cb to
25757     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25758     * it is not used anymore.
25759     *
25760     * @see elm_object_tooltip_unset() for more details.
25761     * @see elm_diskselector_item_tooltip_content_cb_set()
25762     *
25763     * @ingroup Diskselector
25764     */
25765    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25766
25767
25768    /**
25769     * Sets a different style for this item tooltip.
25770     *
25771     * @note before you set a style you should define a tooltip with
25772     *       elm_diskselector_item_tooltip_content_cb_set() or
25773     *       elm_diskselector_item_tooltip_text_set()
25774     *
25775     * @param item diskselector item with tooltip already set.
25776     * @param style the theme style to use (default, transparent, ...)
25777     *
25778     * @see elm_object_tooltip_style_set() for more details.
25779     *
25780     * @ingroup Diskselector
25781     */
25782    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25783
25784    /**
25785     * Get the style for this item tooltip.
25786     *
25787     * @param item diskselector item with tooltip already set.
25788     * @return style the theme style in use, defaults to "default". If the
25789     *         object does not have a tooltip set, then NULL is returned.
25790     *
25791     * @see elm_object_tooltip_style_get() for more details.
25792     * @see elm_diskselector_item_tooltip_style_set()
25793     *
25794     * @ingroup Diskselector
25795     */
25796    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25797
25798    /**
25799     * Set the cursor to be shown when mouse is over the diskselector item
25800     *
25801     * @param item Target item
25802     * @param cursor the cursor name to be used.
25803     *
25804     * @see elm_object_cursor_set() for more details.
25805     *
25806     * @ingroup Diskselector
25807     */
25808    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
25809
25810    /**
25811     * Get the cursor to be shown when mouse is over the diskselector item
25812     *
25813     * @param item diskselector item with cursor already set.
25814     * @return the cursor name.
25815     *
25816     * @see elm_object_cursor_get() for more details.
25817     * @see elm_diskselector_cursor_set()
25818     *
25819     * @ingroup Diskselector
25820     */
25821    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25822
25823
25824    /**
25825     * Unset the cursor to be shown when mouse is over the diskselector item
25826     *
25827     * @param item Target item
25828     *
25829     * @see elm_object_cursor_unset() for more details.
25830     * @see elm_diskselector_cursor_set()
25831     *
25832     * @ingroup Diskselector
25833     */
25834    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25835
25836    /**
25837     * Sets a different style for this item cursor.
25838     *
25839     * @note before you set a style you should define a cursor with
25840     *       elm_diskselector_item_cursor_set()
25841     *
25842     * @param item diskselector item with cursor already set.
25843     * @param style the theme style to use (default, transparent, ...)
25844     *
25845     * @see elm_object_cursor_style_set() for more details.
25846     *
25847     * @ingroup Diskselector
25848     */
25849    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25850
25851
25852    /**
25853     * Get the style for this item cursor.
25854     *
25855     * @param item diskselector item with cursor already set.
25856     * @return style the theme style in use, defaults to "default". If the
25857     *         object does not have a cursor set, then @c NULL is returned.
25858     *
25859     * @see elm_object_cursor_style_get() for more details.
25860     * @see elm_diskselector_item_cursor_style_set()
25861     *
25862     * @ingroup Diskselector
25863     */
25864    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25865
25866
25867    /**
25868     * Set if the cursor set should be searched on the theme or should use
25869     * the provided by the engine, only.
25870     *
25871     * @note before you set if should look on theme you should define a cursor
25872     * with elm_diskselector_item_cursor_set().
25873     * By default it will only look for cursors provided by the engine.
25874     *
25875     * @param item widget item with cursor already set.
25876     * @param engine_only boolean to define if cursors set with
25877     * elm_diskselector_item_cursor_set() should be searched only
25878     * between cursors provided by the engine or searched on widget's
25879     * theme as well.
25880     *
25881     * @see elm_object_cursor_engine_only_set() for more details.
25882     *
25883     * @ingroup Diskselector
25884     */
25885    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
25886
25887    /**
25888     * Get the cursor engine only usage for this item cursor.
25889     *
25890     * @param item widget item with cursor already set.
25891     * @return engine_only boolean to define it cursors should be looked only
25892     * between the provided by the engine or searched on widget's theme as well.
25893     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
25894     *
25895     * @see elm_object_cursor_engine_only_get() for more details.
25896     * @see elm_diskselector_item_cursor_engine_only_set()
25897     *
25898     * @ingroup Diskselector
25899     */
25900    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25901
25902    /**
25903     * @}
25904     */
25905
25906    /**
25907     * @defgroup Colorselector Colorselector
25908     *
25909     * @{
25910     *
25911     * @image html img/widget/colorselector/preview-00.png
25912     * @image latex img/widget/colorselector/preview-00.eps
25913     *
25914     * @brief Widget for user to select a color.
25915     *
25916     * Signals that you can add callbacks for are:
25917     * "changed" - When the color value changes(event_info is NULL).
25918     *
25919     * See @ref tutorial_colorselector.
25920     */
25921    /**
25922     * @brief Add a new colorselector to the parent
25923     *
25924     * @param parent The parent object
25925     * @return The new object or NULL if it cannot be created
25926     *
25927     * @ingroup Colorselector
25928     */
25929    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25930    /**
25931     * Set a color for the colorselector
25932     *
25933     * @param obj   Colorselector object
25934     * @param r     r-value of color
25935     * @param g     g-value of color
25936     * @param b     b-value of color
25937     * @param a     a-value of color
25938     *
25939     * @ingroup Colorselector
25940     */
25941    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
25942    /**
25943     * Get a color from the colorselector
25944     *
25945     * @param obj   Colorselector object
25946     * @param r     integer pointer for r-value of color
25947     * @param g     integer pointer for g-value of color
25948     * @param b     integer pointer for b-value of color
25949     * @param a     integer pointer for a-value of color
25950     *
25951     * @ingroup Colorselector
25952     */
25953    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
25954    /**
25955     * @}
25956     */
25957
25958    /**
25959     * @defgroup Ctxpopup Ctxpopup
25960     *
25961     * @image html img/widget/ctxpopup/preview-00.png
25962     * @image latex img/widget/ctxpopup/preview-00.eps
25963     *
25964     * @brief Context popup widet.
25965     *
25966     * A ctxpopup is a widget that, when shown, pops up a list of items.
25967     * It automatically chooses an area inside its parent object's view
25968     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
25969     * optimally fit into it. In the default theme, it will also point an
25970     * arrow to it's top left position at the time one shows it. Ctxpopup
25971     * items have a label and/or an icon. It is intended for a small
25972     * number of items (hence the use of list, not genlist).
25973     *
25974     * @note Ctxpopup is a especialization of @ref Hover.
25975     *
25976     * Signals that you can add callbacks for are:
25977     * "dismissed" - the ctxpopup was dismissed
25978     *
25979     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
25980     * @{
25981     */
25982    typedef enum _Elm_Ctxpopup_Direction
25983      {
25984         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25985                                           area */
25986         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25987                                            the clicked area */
25988         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25989                                           the clicked area */
25990         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25991                                         area */
25992         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25993      } Elm_Ctxpopup_Direction;
25994
25995    /**
25996     * @brief Add a new Ctxpopup object to the parent.
25997     *
25998     * @param parent Parent object
25999     * @return New object or @c NULL, if it cannot be created
26000     */
26001    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26002    /**
26003     * @brief Set the Ctxpopup's parent
26004     *
26005     * @param obj The ctxpopup object
26006     * @param area The parent to use
26007     *
26008     * Set the parent object.
26009     *
26010     * @note elm_ctxpopup_add() will automatically call this function
26011     * with its @c parent argument.
26012     *
26013     * @see elm_ctxpopup_add()
26014     * @see elm_hover_parent_set()
26015     */
26016    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26017    /**
26018     * @brief Get the Ctxpopup's parent
26019     *
26020     * @param obj The ctxpopup object
26021     *
26022     * @see elm_ctxpopup_hover_parent_set() for more information
26023     */
26024    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26025    /**
26026     * @brief Clear all items in the given ctxpopup object.
26027     *
26028     * @param obj Ctxpopup object
26029     */
26030    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26031    /**
26032     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26033     *
26034     * @param obj Ctxpopup object
26035     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26036     */
26037    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26038    /**
26039     * @brief Get the value of current ctxpopup object's orientation.
26040     *
26041     * @param obj Ctxpopup object
26042     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26043     *
26044     * @see elm_ctxpopup_horizontal_set()
26045     */
26046    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26047    /**
26048     * @brief Add a new item to a ctxpopup object.
26049     *
26050     * @param obj Ctxpopup object
26051     * @param icon Icon to be set on new item
26052     * @param label The Label of the new item
26053     * @param func Convenience function called when item selected
26054     * @param data Data passed to @p func
26055     * @return A handle to the item added or @c NULL, on errors
26056     *
26057     * @warning Ctxpopup can't hold both an item list and a content at the same
26058     * time. When an item is added, any previous content will be removed.
26059     *
26060     * @see elm_ctxpopup_content_set()
26061     */
26062    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);
26063    /**
26064     * @brief Delete the given item in a ctxpopup object.
26065     *
26066     * @param it Ctxpopup item to be deleted
26067     *
26068     * @see elm_ctxpopup_item_append()
26069     */
26070    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26071    /**
26072     * @brief Set the ctxpopup item's state as disabled or enabled.
26073     *
26074     * @param it Ctxpopup item to be enabled/disabled
26075     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26076     *
26077     * When disabled the item is greyed out to indicate it's state.
26078     */
26079    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26080    /**
26081     * @brief Get the ctxpopup item's disabled/enabled state.
26082     *
26083     * @param it Ctxpopup item to be enabled/disabled
26084     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26085     *
26086     * @see elm_ctxpopup_item_disabled_set()
26087     */
26088    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26089    /**
26090     * @brief Get the icon object for the given ctxpopup item.
26091     *
26092     * @param it Ctxpopup item
26093     * @return icon object or @c NULL, if the item does not have icon or an error
26094     * occurred
26095     *
26096     * @see elm_ctxpopup_item_append()
26097     * @see elm_ctxpopup_item_icon_set()
26098     */
26099    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26100    /**
26101     * @brief Sets the side icon associated with the ctxpopup item
26102     *
26103     * @param it Ctxpopup item
26104     * @param icon Icon object to be set
26105     *
26106     * Once the icon object is set, a previously set one will be deleted.
26107     * @warning Setting the same icon for two items will cause the icon to
26108     * dissapear from the first item.
26109     *
26110     * @see elm_ctxpopup_item_append()
26111     */
26112    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26113    /**
26114     * @brief Get the label for the given ctxpopup item.
26115     *
26116     * @param it Ctxpopup item
26117     * @return label string or @c NULL, if the item does not have label or an
26118     * error occured
26119     *
26120     * @see elm_ctxpopup_item_append()
26121     * @see elm_ctxpopup_item_label_set()
26122     */
26123    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26124    /**
26125     * @brief (Re)set the label on the given ctxpopup item.
26126     *
26127     * @param it Ctxpopup item
26128     * @param label String to set as label
26129     */
26130    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26131    /**
26132     * @brief Set an elm widget as the content of the ctxpopup.
26133     *
26134     * @param obj Ctxpopup object
26135     * @param content Content to be swallowed
26136     *
26137     * If the content object is already set, a previous one will bedeleted. If
26138     * you want to keep that old content object, use the
26139     * elm_ctxpopup_content_unset() function.
26140     *
26141     * @deprecated use elm_object_content_set()
26142     *
26143     * @warning Ctxpopup can't hold both a item list and a content at the same
26144     * time. When a content is set, any previous items will be removed.
26145     */
26146    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26147    /**
26148     * @brief Unset the ctxpopup content
26149     *
26150     * @param obj Ctxpopup object
26151     * @return The content that was being used
26152     *
26153     * Unparent and return the content object which was set for this widget.
26154     *
26155     * @deprecated use elm_object_content_unset()
26156     *
26157     * @see elm_ctxpopup_content_set()
26158     */
26159    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26160    /**
26161     * @brief Set the direction priority of a ctxpopup.
26162     *
26163     * @param obj Ctxpopup object
26164     * @param first 1st priority of direction
26165     * @param second 2nd priority of direction
26166     * @param third 3th priority of direction
26167     * @param fourth 4th priority of direction
26168     *
26169     * This functions gives a chance to user to set the priority of ctxpopup
26170     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26171     * requested direction.
26172     *
26173     * @see Elm_Ctxpopup_Direction
26174     */
26175    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);
26176    /**
26177     * @brief Get the direction priority of a ctxpopup.
26178     *
26179     * @param obj Ctxpopup object
26180     * @param first 1st priority of direction to be returned
26181     * @param second 2nd priority of direction to be returned
26182     * @param third 3th priority of direction to be returned
26183     * @param fourth 4th priority of direction to be returned
26184     *
26185     * @see elm_ctxpopup_direction_priority_set() for more information.
26186     */
26187    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);
26188
26189    /**
26190     * @brief Get the current direction of a ctxpopup.
26191     *
26192     * @param obj Ctxpopup object
26193     * @return current direction of a ctxpopup
26194     *
26195     * @warning Once the ctxpopup showed up, the direction would be determined
26196     */
26197    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26198
26199    /**
26200     * @}
26201     */
26202
26203    /* transit */
26204    /**
26205     *
26206     * @defgroup Transit Transit
26207     * @ingroup Elementary
26208     *
26209     * Transit is designed to apply various animated transition effects to @c
26210     * Evas_Object, such like translation, rotation, etc. For using these
26211     * effects, create an @ref Elm_Transit and add the desired transition effects.
26212     *
26213     * Once the effects are added into transit, they will be automatically
26214     * managed (their callback will be called until the duration is ended, and
26215     * they will be deleted on completion).
26216     *
26217     * Example:
26218     * @code
26219     * Elm_Transit *trans = elm_transit_add();
26220     * elm_transit_object_add(trans, obj);
26221     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26222     * elm_transit_duration_set(transit, 1);
26223     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26224     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26225     * elm_transit_repeat_times_set(transit, 3);
26226     * @endcode
26227     *
26228     * Some transition effects are used to change the properties of objects. They
26229     * are:
26230     * @li @ref elm_transit_effect_translation_add
26231     * @li @ref elm_transit_effect_color_add
26232     * @li @ref elm_transit_effect_rotation_add
26233     * @li @ref elm_transit_effect_wipe_add
26234     * @li @ref elm_transit_effect_zoom_add
26235     * @li @ref elm_transit_effect_resizing_add
26236     *
26237     * Other transition effects are used to make one object disappear and another
26238     * object appear on its old place. These effects are:
26239     *
26240     * @li @ref elm_transit_effect_flip_add
26241     * @li @ref elm_transit_effect_resizable_flip_add
26242     * @li @ref elm_transit_effect_fade_add
26243     * @li @ref elm_transit_effect_blend_add
26244     *
26245     * It's also possible to make a transition chain with @ref
26246     * elm_transit_chain_transit_add.
26247     *
26248     * @warning We strongly recommend to use elm_transit just when edje can not do
26249     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26250     * animations can be manipulated inside the theme.
26251     *
26252     * List of examples:
26253     * @li @ref transit_example_01_explained
26254     * @li @ref transit_example_02_explained
26255     * @li @ref transit_example_03_c
26256     * @li @ref transit_example_04_c
26257     *
26258     * @{
26259     */
26260
26261    /**
26262     * @enum Elm_Transit_Tween_Mode
26263     *
26264     * The type of acceleration used in the transition.
26265     */
26266    typedef enum
26267      {
26268         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26269         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26270                                              over time, then decrease again
26271                                              and stop slowly */
26272         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26273                                              speed over time */
26274         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26275                                             over time */
26276      } Elm_Transit_Tween_Mode;
26277
26278    /**
26279     * @enum Elm_Transit_Effect_Flip_Axis
26280     *
26281     * The axis where flip effect should be applied.
26282     */
26283    typedef enum
26284      {
26285         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26286         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26287      } Elm_Transit_Effect_Flip_Axis;
26288    /**
26289     * @enum Elm_Transit_Effect_Wipe_Dir
26290     *
26291     * The direction where the wipe effect should occur.
26292     */
26293    typedef enum
26294      {
26295         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26296         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26297         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26298         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26299      } Elm_Transit_Effect_Wipe_Dir;
26300    /** @enum Elm_Transit_Effect_Wipe_Type
26301     *
26302     * Whether the wipe effect should show or hide the object.
26303     */
26304    typedef enum
26305      {
26306         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26307                                              animation */
26308         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26309                                             animation */
26310      } Elm_Transit_Effect_Wipe_Type;
26311
26312    /**
26313     * @typedef Elm_Transit
26314     *
26315     * The Transit created with elm_transit_add(). This type has the information
26316     * about the objects which the transition will be applied, and the
26317     * transition effects that will be used. It also contains info about
26318     * duration, number of repetitions, auto-reverse, etc.
26319     */
26320    typedef struct _Elm_Transit Elm_Transit;
26321    typedef void Elm_Transit_Effect;
26322    /**
26323     * @typedef Elm_Transit_Effect_Transition_Cb
26324     *
26325     * Transition callback called for this effect on each transition iteration.
26326     */
26327    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26328    /**
26329     * Elm_Transit_Effect_End_Cb
26330     *
26331     * Transition callback called for this effect when the transition is over.
26332     */
26333    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26334
26335    /**
26336     * Elm_Transit_Del_Cb
26337     *
26338     * A callback called when the transit is deleted.
26339     */
26340    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26341
26342    /**
26343     * Add new transit.
26344     *
26345     * @note Is not necessary to delete the transit object, it will be deleted at
26346     * the end of its operation.
26347     * @note The transit will start playing when the program enter in the main loop, is not
26348     * necessary to give a start to the transit.
26349     *
26350     * @return The transit object.
26351     *
26352     * @ingroup Transit
26353     */
26354    EAPI Elm_Transit                *elm_transit_add(void);
26355
26356    /**
26357     * Stops the animation and delete the @p transit object.
26358     *
26359     * Call this function if you wants to stop the animation before the duration
26360     * time. Make sure the @p transit object is still alive with
26361     * elm_transit_del_cb_set() function.
26362     * All added effects will be deleted, calling its repective data_free_cb
26363     * functions. The function setted by elm_transit_del_cb_set() will be called.
26364     *
26365     * @see elm_transit_del_cb_set()
26366     *
26367     * @param transit The transit object to be deleted.
26368     *
26369     * @ingroup Transit
26370     * @warning Just call this function if you are sure the transit is alive.
26371     */
26372    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26373
26374    /**
26375     * Add a new effect to the transit.
26376     *
26377     * @note The cb function and the data are the key to the effect. If you try to
26378     * add an already added effect, nothing is done.
26379     * @note After the first addition of an effect in @p transit, if its
26380     * effect list become empty again, the @p transit will be killed by
26381     * elm_transit_del(transit) function.
26382     *
26383     * Exemple:
26384     * @code
26385     * Elm_Transit *transit = elm_transit_add();
26386     * elm_transit_effect_add(transit,
26387     *                        elm_transit_effect_blend_op,
26388     *                        elm_transit_effect_blend_context_new(),
26389     *                        elm_transit_effect_blend_context_free);
26390     * @endcode
26391     *
26392     * @param transit The transit object.
26393     * @param transition_cb The operation function. It is called when the
26394     * animation begins, it is the function that actually performs the animation.
26395     * It is called with the @p data, @p transit and the time progression of the
26396     * animation (a double value between 0.0 and 1.0).
26397     * @param effect The context data of the effect.
26398     * @param end_cb The function to free the context data, it will be called
26399     * at the end of the effect, it must finalize the animation and free the
26400     * @p data.
26401     *
26402     * @ingroup Transit
26403     * @warning The transit free the context data at the and of the transition with
26404     * the data_free_cb function, do not use the context data in another transit.
26405     */
26406    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);
26407
26408    /**
26409     * Delete an added effect.
26410     *
26411     * This function will remove the effect from the @p transit, calling the
26412     * data_free_cb to free the @p data.
26413     *
26414     * @see elm_transit_effect_add()
26415     *
26416     * @note If the effect is not found, nothing is done.
26417     * @note If the effect list become empty, this function will call
26418     * elm_transit_del(transit), that is, it will kill the @p transit.
26419     *
26420     * @param transit The transit object.
26421     * @param transition_cb The operation function.
26422     * @param effect The context data of the effect.
26423     *
26424     * @ingroup Transit
26425     */
26426    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);
26427
26428    /**
26429     * Add new object to apply the effects.
26430     *
26431     * @note After the first addition of an object in @p transit, if its
26432     * object list become empty again, the @p transit will be killed by
26433     * elm_transit_del(transit) function.
26434     * @note If the @p obj belongs to another transit, the @p obj will be
26435     * removed from it and it will only belong to the @p transit. If the old
26436     * transit stays without objects, it will die.
26437     * @note When you add an object into the @p transit, its state from
26438     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26439     * transit ends, if you change this state whith evas_object_pass_events_set()
26440     * after add the object, this state will change again when @p transit stops to
26441     * run.
26442     *
26443     * @param transit The transit object.
26444     * @param obj Object to be animated.
26445     *
26446     * @ingroup Transit
26447     * @warning It is not allowed to add a new object after transit begins to go.
26448     */
26449    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26450
26451    /**
26452     * Removes an added object from the transit.
26453     *
26454     * @note If the @p obj is not in the @p transit, nothing is done.
26455     * @note If the list become empty, this function will call
26456     * elm_transit_del(transit), that is, it will kill the @p transit.
26457     *
26458     * @param transit The transit object.
26459     * @param obj Object to be removed from @p transit.
26460     *
26461     * @ingroup Transit
26462     * @warning It is not allowed to remove objects after transit begins to go.
26463     */
26464    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26465
26466    /**
26467     * Get the objects of the transit.
26468     *
26469     * @param transit The transit object.
26470     * @return a Eina_List with the objects from the transit.
26471     *
26472     * @ingroup Transit
26473     */
26474    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26475
26476    /**
26477     * Enable/disable keeping up the objects states.
26478     * If it is not kept, the objects states will be reset when transition ends.
26479     *
26480     * @note @p transit can not be NULL.
26481     * @note One state includes geometry, color, map data.
26482     *
26483     * @param transit The transit object.
26484     * @param state_keep Keeping or Non Keeping.
26485     *
26486     * @ingroup Transit
26487     */
26488    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26489
26490    /**
26491     * Get a value whether the objects states will be reset or not.
26492     *
26493     * @note @p transit can not be NULL
26494     *
26495     * @see elm_transit_objects_final_state_keep_set()
26496     *
26497     * @param transit The transit object.
26498     * @return EINA_TRUE means the states of the objects will be reset.
26499     * If @p transit is NULL, EINA_FALSE is returned
26500     *
26501     * @ingroup Transit
26502     */
26503    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26504
26505    /**
26506     * Set the event enabled when transit is operating.
26507     *
26508     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26509     * events from mouse and keyboard during the animation.
26510     * @note When you add an object with elm_transit_object_add(), its state from
26511     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26512     * transit ends, if you change this state with evas_object_pass_events_set()
26513     * after adding the object, this state will change again when @p transit stops
26514     * to run.
26515     *
26516     * @param transit The transit object.
26517     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26518     * ignored otherwise.
26519     *
26520     * @ingroup Transit
26521     */
26522    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26523
26524    /**
26525     * Get the value of event enabled status.
26526     *
26527     * @see elm_transit_event_enabled_set()
26528     *
26529     * @param transit The Transit object
26530     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26531     * EINA_FALSE is returned
26532     *
26533     * @ingroup Transit
26534     */
26535    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26536
26537    /**
26538     * Set the user-callback function when the transit is deleted.
26539     *
26540     * @note Using this function twice will overwrite the first function setted.
26541     * @note the @p transit object will be deleted after call @p cb function.
26542     *
26543     * @param transit The transit object.
26544     * @param cb Callback function pointer. This function will be called before
26545     * the deletion of the transit.
26546     * @param data Callback funtion user data. It is the @p op parameter.
26547     *
26548     * @ingroup Transit
26549     */
26550    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26551
26552    /**
26553     * Set reverse effect automatically.
26554     *
26555     * If auto reverse is setted, after running the effects with the progress
26556     * parameter from 0 to 1, it will call the effecs again with the progress
26557     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26558     * where the duration was setted with the function elm_transit_add and
26559     * the repeat with the function elm_transit_repeat_times_set().
26560     *
26561     * @param transit The transit object.
26562     * @param reverse EINA_TRUE means the auto_reverse is on.
26563     *
26564     * @ingroup Transit
26565     */
26566    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26567
26568    /**
26569     * Get if the auto reverse is on.
26570     *
26571     * @see elm_transit_auto_reverse_set()
26572     *
26573     * @param transit The transit object.
26574     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26575     * EINA_FALSE is returned
26576     *
26577     * @ingroup Transit
26578     */
26579    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26580
26581    /**
26582     * Set the transit repeat count. Effect will be repeated by repeat count.
26583     *
26584     * This function sets the number of repetition the transit will run after
26585     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26586     * If the @p repeat is a negative number, it will repeat infinite times.
26587     *
26588     * @note If this function is called during the transit execution, the transit
26589     * will run @p repeat times, ignoring the times it already performed.
26590     *
26591     * @param transit The transit object
26592     * @param repeat Repeat count
26593     *
26594     * @ingroup Transit
26595     */
26596    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26597
26598    /**
26599     * Get the transit repeat count.
26600     *
26601     * @see elm_transit_repeat_times_set()
26602     *
26603     * @param transit The Transit object.
26604     * @return The repeat count. If @p transit is NULL
26605     * 0 is returned
26606     *
26607     * @ingroup Transit
26608     */
26609    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26610
26611    /**
26612     * Set the transit animation acceleration type.
26613     *
26614     * This function sets the tween mode of the transit that can be:
26615     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26616     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26617     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26618     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26619     *
26620     * @param transit The transit object.
26621     * @param tween_mode The tween type.
26622     *
26623     * @ingroup Transit
26624     */
26625    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26626
26627    /**
26628     * Get the transit animation acceleration type.
26629     *
26630     * @note @p transit can not be NULL
26631     *
26632     * @param transit The transit object.
26633     * @return The tween type. If @p transit is NULL
26634     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26635     *
26636     * @ingroup Transit
26637     */
26638    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26639
26640    /**
26641     * Set the transit animation time
26642     *
26643     * @note @p transit can not be NULL
26644     *
26645     * @param transit The transit object.
26646     * @param duration The animation time.
26647     *
26648     * @ingroup Transit
26649     */
26650    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26651
26652    /**
26653     * Get the transit animation time
26654     *
26655     * @note @p transit can not be NULL
26656     *
26657     * @param transit The transit object.
26658     *
26659     * @return The transit animation time.
26660     *
26661     * @ingroup Transit
26662     */
26663    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26664
26665    /**
26666     * Starts the transition.
26667     * Once this API is called, the transit begins to measure the time.
26668     *
26669     * @note @p transit can not be NULL
26670     *
26671     * @param transit The transit object.
26672     *
26673     * @ingroup Transit
26674     */
26675    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26676
26677    /**
26678     * Pause/Resume the transition.
26679     *
26680     * If you call elm_transit_go again, the transit will be started from the
26681     * beginning, and will be unpaused.
26682     *
26683     * @note @p transit can not be NULL
26684     *
26685     * @param transit The transit object.
26686     * @param paused Whether the transition should be paused or not.
26687     *
26688     * @ingroup Transit
26689     */
26690    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26691
26692    /**
26693     * Get the value of paused status.
26694     *
26695     * @see elm_transit_paused_set()
26696     *
26697     * @note @p transit can not be NULL
26698     *
26699     * @param transit The transit object.
26700     * @return EINA_TRUE means transition is paused. If @p transit is NULL
26701     * EINA_FALSE is returned
26702     *
26703     * @ingroup Transit
26704     */
26705    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26706
26707    /**
26708     * Get the time progression of the animation (a double value between 0.0 and 1.0).
26709     *
26710     * The value returned is a fraction (current time / total time). It
26711     * represents the progression position relative to the total.
26712     *
26713     * @note @p transit can not be NULL
26714     *
26715     * @param transit The transit object.
26716     *
26717     * @return The time progression value. If @p transit is NULL
26718     * 0 is returned
26719     *
26720     * @ingroup Transit
26721     */
26722    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26723
26724    /**
26725     * Makes the chain relationship between two transits.
26726     *
26727     * @note @p transit can not be NULL. Transit would have multiple chain transits.
26728     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26729     *
26730     * @param transit The transit object.
26731     * @param chain_transit The chain transit object. This transit will be operated
26732     *        after transit is done.
26733     *
26734     * This function adds @p chain_transit transition to a chain after the @p
26735     * transit, and will be started as soon as @p transit ends. See @ref
26736     * transit_example_02_explained for a full example.
26737     *
26738     * @ingroup Transit
26739     */
26740    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26741
26742    /**
26743     * Cut off the chain relationship between two transits.
26744     *
26745     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26746     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26747     *
26748     * @param transit The transit object.
26749     * @param chain_transit The chain transit object.
26750     *
26751     * This function remove the @p chain_transit transition from the @p transit.
26752     *
26753     * @ingroup Transit
26754     */
26755    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26756
26757    /**
26758     * Get the current chain transit list.
26759     *
26760     * @note @p transit can not be NULL.
26761     *
26762     * @param transit The transit object.
26763     * @return chain transit list.
26764     *
26765     * @ingroup Transit
26766     */
26767    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
26768
26769    /**
26770     * Add the Resizing Effect to Elm_Transit.
26771     *
26772     * @note This API is one of the facades. It creates resizing effect context
26773     * and add it's required APIs to elm_transit_effect_add.
26774     *
26775     * @see elm_transit_effect_add()
26776     *
26777     * @param transit Transit object.
26778     * @param from_w Object width size when effect begins.
26779     * @param from_h Object height size when effect begins.
26780     * @param to_w Object width size when effect ends.
26781     * @param to_h Object height size when effect ends.
26782     * @return Resizing effect context data.
26783     *
26784     * @ingroup Transit
26785     */
26786    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);
26787
26788    /**
26789     * Add the Translation Effect to Elm_Transit.
26790     *
26791     * @note This API is one of the facades. It creates translation effect context
26792     * and add it's required APIs to elm_transit_effect_add.
26793     *
26794     * @see elm_transit_effect_add()
26795     *
26796     * @param transit Transit object.
26797     * @param from_dx X Position variation when effect begins.
26798     * @param from_dy Y Position variation when effect begins.
26799     * @param to_dx X Position variation when effect ends.
26800     * @param to_dy Y Position variation when effect ends.
26801     * @return Translation effect context data.
26802     *
26803     * @ingroup Transit
26804     * @warning It is highly recommended just create a transit with this effect when
26805     * the window that the objects of the transit belongs has already been created.
26806     * This is because this effect needs the geometry information about the objects,
26807     * and if the window was not created yet, it can get a wrong information.
26808     */
26809    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);
26810
26811    /**
26812     * Add the Zoom Effect to Elm_Transit.
26813     *
26814     * @note This API is one of the facades. It creates zoom effect context
26815     * and add it's required APIs to elm_transit_effect_add.
26816     *
26817     * @see elm_transit_effect_add()
26818     *
26819     * @param transit Transit object.
26820     * @param from_rate Scale rate when effect begins (1 is current rate).
26821     * @param to_rate Scale rate when effect ends.
26822     * @return Zoom effect context data.
26823     *
26824     * @ingroup Transit
26825     * @warning It is highly recommended just create a transit with this effect when
26826     * the window that the objects of the transit belongs has already been created.
26827     * This is because this effect needs the geometry information about the objects,
26828     * and if the window was not created yet, it can get a wrong information.
26829     */
26830    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
26831
26832    /**
26833     * Add the Flip Effect to Elm_Transit.
26834     *
26835     * @note This API is one of the facades. It creates flip effect context
26836     * and add it's required APIs to elm_transit_effect_add.
26837     * @note This effect is applied to each pair of objects in the order they are listed
26838     * in the transit list of objects. The first object in the pair will be the
26839     * "front" object and the second will be the "back" object.
26840     *
26841     * @see elm_transit_effect_add()
26842     *
26843     * @param transit Transit object.
26844     * @param axis Flipping Axis(X or Y).
26845     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26846     * @return Flip effect context data.
26847     *
26848     * @ingroup Transit
26849     * @warning It is highly recommended just create a transit with this effect when
26850     * the window that the objects of the transit belongs has already been created.
26851     * This is because this effect needs the geometry information about the objects,
26852     * and if the window was not created yet, it can get a wrong information.
26853     */
26854    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26855
26856    /**
26857     * Add the Resizable Flip Effect to Elm_Transit.
26858     *
26859     * @note This API is one of the facades. It creates resizable flip effect context
26860     * and add it's required APIs to elm_transit_effect_add.
26861     * @note This effect is applied to each pair of objects in the order they are listed
26862     * in the transit list of objects. The first object in the pair will be the
26863     * "front" object and the second will be the "back" object.
26864     *
26865     * @see elm_transit_effect_add()
26866     *
26867     * @param transit Transit object.
26868     * @param axis Flipping Axis(X or Y).
26869     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26870     * @return Resizable flip effect context data.
26871     *
26872     * @ingroup Transit
26873     * @warning It is highly recommended just create a transit with this effect when
26874     * the window that the objects of the transit belongs has already been created.
26875     * This is because this effect needs the geometry information about the objects,
26876     * and if the window was not created yet, it can get a wrong information.
26877     */
26878    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26879
26880    /**
26881     * Add the Wipe Effect to Elm_Transit.
26882     *
26883     * @note This API is one of the facades. It creates wipe effect context
26884     * and add it's required APIs to elm_transit_effect_add.
26885     *
26886     * @see elm_transit_effect_add()
26887     *
26888     * @param transit Transit object.
26889     * @param type Wipe type. Hide or show.
26890     * @param dir Wipe Direction.
26891     * @return Wipe effect context data.
26892     *
26893     * @ingroup Transit
26894     * @warning It is highly recommended just create a transit with this effect when
26895     * the window that the objects of the transit belongs has already been created.
26896     * This is because this effect needs the geometry information about the objects,
26897     * and if the window was not created yet, it can get a wrong information.
26898     */
26899    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
26900
26901    /**
26902     * Add the Color Effect to Elm_Transit.
26903     *
26904     * @note This API is one of the facades. It creates color effect context
26905     * and add it's required APIs to elm_transit_effect_add.
26906     *
26907     * @see elm_transit_effect_add()
26908     *
26909     * @param transit        Transit object.
26910     * @param  from_r        RGB R when effect begins.
26911     * @param  from_g        RGB G when effect begins.
26912     * @param  from_b        RGB B when effect begins.
26913     * @param  from_a        RGB A when effect begins.
26914     * @param  to_r          RGB R when effect ends.
26915     * @param  to_g          RGB G when effect ends.
26916     * @param  to_b          RGB B when effect ends.
26917     * @param  to_a          RGB A when effect ends.
26918     * @return               Color effect context data.
26919     *
26920     * @ingroup Transit
26921     */
26922    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);
26923
26924    /**
26925     * Add the Fade Effect to Elm_Transit.
26926     *
26927     * @note This API is one of the facades. It creates fade effect context
26928     * and add it's required APIs to elm_transit_effect_add.
26929     * @note This effect is applied to each pair of objects in the order they are listed
26930     * in the transit list of objects. The first object in the pair will be the
26931     * "before" object and the second will be the "after" object.
26932     *
26933     * @see elm_transit_effect_add()
26934     *
26935     * @param transit Transit object.
26936     * @return Fade effect context data.
26937     *
26938     * @ingroup Transit
26939     * @warning It is highly recommended just create a transit with this effect when
26940     * the window that the objects of the transit belongs has already been created.
26941     * This is because this effect needs the color information about the objects,
26942     * and if the window was not created yet, it can get a wrong information.
26943     */
26944    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
26945
26946    /**
26947     * Add the Blend Effect to Elm_Transit.
26948     *
26949     * @note This API is one of the facades. It creates blend effect context
26950     * and add it's required APIs to elm_transit_effect_add.
26951     * @note This effect is applied to each pair of objects in the order they are listed
26952     * in the transit list of objects. The first object in the pair will be the
26953     * "before" object and the second will be the "after" object.
26954     *
26955     * @see elm_transit_effect_add()
26956     *
26957     * @param transit Transit object.
26958     * @return Blend effect context data.
26959     *
26960     * @ingroup Transit
26961     * @warning It is highly recommended just create a transit with this effect when
26962     * the window that the objects of the transit belongs has already been created.
26963     * This is because this effect needs the color information about the objects,
26964     * and if the window was not created yet, it can get a wrong information.
26965     */
26966    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
26967
26968    /**
26969     * Add the Rotation Effect to Elm_Transit.
26970     *
26971     * @note This API is one of the facades. It creates rotation effect context
26972     * and add it's required APIs to elm_transit_effect_add.
26973     *
26974     * @see elm_transit_effect_add()
26975     *
26976     * @param transit Transit object.
26977     * @param from_degree Degree when effect begins.
26978     * @param to_degree Degree when effect is ends.
26979     * @return Rotation effect context data.
26980     *
26981     * @ingroup Transit
26982     * @warning It is highly recommended just create a transit with this effect when
26983     * the window that the objects of the transit belongs has already been created.
26984     * This is because this effect needs the geometry information about the objects,
26985     * and if the window was not created yet, it can get a wrong information.
26986     */
26987    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26988
26989    /**
26990     * Add the ImageAnimation Effect to Elm_Transit.
26991     *
26992     * @note This API is one of the facades. It creates image animation effect context
26993     * and add it's required APIs to elm_transit_effect_add.
26994     * The @p images parameter is a list images paths. This list and
26995     * its contents will be deleted at the end of the effect by
26996     * elm_transit_effect_image_animation_context_free() function.
26997     *
26998     * Example:
26999     * @code
27000     * char buf[PATH_MAX];
27001     * Eina_List *images = NULL;
27002     * Elm_Transit *transi = elm_transit_add();
27003     *
27004     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27005     * images = eina_list_append(images, eina_stringshare_add(buf));
27006     *
27007     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27008     * images = eina_list_append(images, eina_stringshare_add(buf));
27009     * elm_transit_effect_image_animation_add(transi, images);
27010     *
27011     * @endcode
27012     *
27013     * @see elm_transit_effect_add()
27014     *
27015     * @param transit Transit object.
27016     * @param images Eina_List of images file paths. This list and
27017     * its contents will be deleted at the end of the effect by
27018     * elm_transit_effect_image_animation_context_free() function.
27019     * @return Image Animation effect context data.
27020     *
27021     * @ingroup Transit
27022     */
27023    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27024    /**
27025     * @}
27026     */
27027
27028    typedef struct _Elm_Store                      Elm_Store;
27029    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27030    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27031    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27032    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27033    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27034    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27035    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27036    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27037    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27038    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27039
27040    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27041    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27042    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27043    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27044
27045    typedef enum
27046      {
27047         ELM_STORE_ITEM_MAPPING_NONE = 0,
27048         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27049         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27050         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27051         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27052         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27053         // can add more here as needed by common apps
27054         ELM_STORE_ITEM_MAPPING_LAST
27055      } Elm_Store_Item_Mapping_Type;
27056
27057    struct _Elm_Store_Item_Mapping_Icon
27058      {
27059         // FIXME: allow edje file icons
27060         int                   w, h;
27061         Elm_Icon_Lookup_Order lookup_order;
27062         Eina_Bool             standard_name : 1;
27063         Eina_Bool             no_scale : 1;
27064         Eina_Bool             smooth : 1;
27065         Eina_Bool             scale_up : 1;
27066         Eina_Bool             scale_down : 1;
27067      };
27068
27069    struct _Elm_Store_Item_Mapping_Empty
27070      {
27071         Eina_Bool             dummy;
27072      };
27073
27074    struct _Elm_Store_Item_Mapping_Photo
27075      {
27076         int                   size;
27077      };
27078
27079    struct _Elm_Store_Item_Mapping_Custom
27080      {
27081         Elm_Store_Item_Mapping_Cb func;
27082      };
27083
27084    struct _Elm_Store_Item_Mapping
27085      {
27086         Elm_Store_Item_Mapping_Type     type;
27087         const char                     *part;
27088         int                             offset;
27089         union
27090           {
27091              Elm_Store_Item_Mapping_Empty  empty;
27092              Elm_Store_Item_Mapping_Icon   icon;
27093              Elm_Store_Item_Mapping_Photo  photo;
27094              Elm_Store_Item_Mapping_Custom custom;
27095              // add more types here
27096           } details;
27097      };
27098
27099    struct _Elm_Store_Item_Info
27100      {
27101         Elm_Genlist_Item_Class       *item_class;
27102         const Elm_Store_Item_Mapping *mapping;
27103         void                         *data;
27104         char                         *sort_id;
27105      };
27106
27107    struct _Elm_Store_Item_Info_Filesystem
27108      {
27109         Elm_Store_Item_Info  base;
27110         char                *path;
27111      };
27112
27113 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27114 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27115
27116    EAPI void                    elm_store_free(Elm_Store *st);
27117
27118    EAPI Elm_Store              *elm_store_filesystem_new(void);
27119    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27120    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27121    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27122
27123    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27124
27125    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27126    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27127    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27128    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27129    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27130    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27131
27132    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27133    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27134    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27135    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27136    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27137    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27138    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27139
27140    /**
27141     * @defgroup SegmentControl SegmentControl
27142     * @ingroup Elementary
27143     *
27144     * @image html img/widget/segment_control/preview-00.png
27145     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27146     *
27147     * @image html img/segment_control.png
27148     * @image latex img/segment_control.eps width=\textwidth
27149     *
27150     * Segment control widget is a horizontal control made of multiple segment
27151     * items, each segment item functioning similar to discrete two state button.
27152     * A segment control groups the items together and provides compact
27153     * single button with multiple equal size segments.
27154     *
27155     * Segment item size is determined by base widget
27156     * size and the number of items added.
27157     * Only one segment item can be at selected state. A segment item can display
27158     * combination of Text and any Evas_Object like Images or other widget.
27159     *
27160     * Smart callbacks one can listen to:
27161     * - "changed" - When the user clicks on a segment item which is not
27162     *   previously selected and get selected. The event_info parameter is the
27163     *   segment item index.
27164     *
27165     * Available styles for it:
27166     * - @c "default"
27167     *
27168     * Here is an example on its usage:
27169     * @li @ref segment_control_example
27170     */
27171
27172    /**
27173     * @addtogroup SegmentControl
27174     * @{
27175     */
27176
27177    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27178
27179    /**
27180     * Add a new segment control widget to the given parent Elementary
27181     * (container) object.
27182     *
27183     * @param parent The parent object.
27184     * @return a new segment control widget handle or @c NULL, on errors.
27185     *
27186     * This function inserts a new segment control widget on the canvas.
27187     *
27188     * @ingroup SegmentControl
27189     */
27190    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27191
27192    /**
27193     * Append a new item to the segment control object.
27194     *
27195     * @param obj The segment control object.
27196     * @param icon The icon object to use for the left side of the item. An
27197     * icon can be any Evas object, but usually it is an icon created
27198     * with elm_icon_add().
27199     * @param label The label of the item.
27200     *        Note that, NULL is different from empty string "".
27201     * @return The created item or @c NULL upon failure.
27202     *
27203     * A new item will be created and appended to the segment control, i.e., will
27204     * be set as @b last item.
27205     *
27206     * If it should be inserted at another position,
27207     * elm_segment_control_item_insert_at() should be used instead.
27208     *
27209     * Items created with this function can be deleted with function
27210     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27211     *
27212     * @note @p label set to @c NULL is different from empty string "".
27213     * If an item
27214     * only has icon, it will be displayed bigger and centered. If it has
27215     * icon and label, even that an empty string, icon will be smaller and
27216     * positioned at left.
27217     *
27218     * Simple example:
27219     * @code
27220     * sc = elm_segment_control_add(win);
27221     * ic = elm_icon_add(win);
27222     * elm_icon_file_set(ic, "path/to/image", NULL);
27223     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27224     * elm_segment_control_item_add(sc, ic, "label");
27225     * evas_object_show(sc);
27226     * @endcode
27227     *
27228     * @see elm_segment_control_item_insert_at()
27229     * @see elm_segment_control_item_del()
27230     *
27231     * @ingroup SegmentControl
27232     */
27233    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27234
27235    /**
27236     * Insert a new item to the segment control object at specified position.
27237     *
27238     * @param obj The segment control object.
27239     * @param icon The icon object to use for the left side of the item. An
27240     * icon can be any Evas object, but usually it is an icon created
27241     * with elm_icon_add().
27242     * @param label The label of the item.
27243     * @param index Item position. Value should be between 0 and items count.
27244     * @return The created item or @c NULL upon failure.
27245
27246     * Index values must be between @c 0, when item will be prepended to
27247     * segment control, and items count, that can be get with
27248     * elm_segment_control_item_count_get(), case when item will be appended
27249     * to segment control, just like elm_segment_control_item_add().
27250     *
27251     * Items created with this function can be deleted with function
27252     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27253     *
27254     * @note @p label set to @c NULL is different from empty string "".
27255     * If an item
27256     * only has icon, it will be displayed bigger and centered. If it has
27257     * icon and label, even that an empty string, icon will be smaller and
27258     * positioned at left.
27259     *
27260     * @see elm_segment_control_item_add()
27261     * @see elm_segment_control_item_count_get()
27262     * @see elm_segment_control_item_del()
27263     *
27264     * @ingroup SegmentControl
27265     */
27266    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);
27267
27268    /**
27269     * Remove a segment control item from its parent, deleting it.
27270     *
27271     * @param it The item to be removed.
27272     *
27273     * Items can be added with elm_segment_control_item_add() or
27274     * elm_segment_control_item_insert_at().
27275     *
27276     * @ingroup SegmentControl
27277     */
27278    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27279
27280    /**
27281     * Remove a segment control item at given index from its parent,
27282     * deleting it.
27283     *
27284     * @param obj The segment control object.
27285     * @param index The position of the segment control item to be deleted.
27286     *
27287     * Items can be added with elm_segment_control_item_add() or
27288     * elm_segment_control_item_insert_at().
27289     *
27290     * @ingroup SegmentControl
27291     */
27292    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27293
27294    /**
27295     * Get the Segment items count from segment control.
27296     *
27297     * @param obj The segment control object.
27298     * @return Segment items count.
27299     *
27300     * It will just return the number of items added to segment control @p obj.
27301     *
27302     * @ingroup SegmentControl
27303     */
27304    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27305
27306    /**
27307     * Get the item placed at specified index.
27308     *
27309     * @param obj The segment control object.
27310     * @param index The index of the segment item.
27311     * @return The segment control item or @c NULL on failure.
27312     *
27313     * Index is the position of an item in segment control widget. Its
27314     * range is from @c 0 to <tt> count - 1 </tt>.
27315     * Count is the number of items, that can be get with
27316     * elm_segment_control_item_count_get().
27317     *
27318     * @ingroup SegmentControl
27319     */
27320    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27321
27322    /**
27323     * Get the label of item.
27324     *
27325     * @param obj The segment control object.
27326     * @param index The index of the segment item.
27327     * @return The label of the item at @p index.
27328     *
27329     * The return value is a pointer to the label associated to the item when
27330     * it was created, with function elm_segment_control_item_add(), or later
27331     * with function elm_segment_control_item_label_set. If no label
27332     * was passed as argument, it will return @c NULL.
27333     *
27334     * @see elm_segment_control_item_label_set() for more details.
27335     * @see elm_segment_control_item_add()
27336     *
27337     * @ingroup SegmentControl
27338     */
27339    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27340
27341    /**
27342     * Set the label of item.
27343     *
27344     * @param it The item of segment control.
27345     * @param text The label of item.
27346     *
27347     * The label to be displayed by the item.
27348     * Label will be at right of the icon (if set).
27349     *
27350     * If a label was passed as argument on item creation, with function
27351     * elm_control_segment_item_add(), it will be already
27352     * displayed by the item.
27353     *
27354     * @see elm_segment_control_item_label_get()
27355     * @see elm_segment_control_item_add()
27356     *
27357     * @ingroup SegmentControl
27358     */
27359    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27360
27361    /**
27362     * Get the icon associated to the item.
27363     *
27364     * @param obj The segment control object.
27365     * @param index The index of the segment item.
27366     * @return The left side icon associated to the item at @p index.
27367     *
27368     * The return value is a pointer to the icon associated to the item when
27369     * it was created, with function elm_segment_control_item_add(), or later
27370     * with function elm_segment_control_item_icon_set(). If no icon
27371     * was passed as argument, it will return @c NULL.
27372     *
27373     * @see elm_segment_control_item_add()
27374     * @see elm_segment_control_item_icon_set()
27375     *
27376     * @ingroup SegmentControl
27377     */
27378    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27379
27380    /**
27381     * Set the icon associated to the item.
27382     *
27383     * @param it The segment control item.
27384     * @param icon The icon object to associate with @p it.
27385     *
27386     * The icon object to use at left side of the item. An
27387     * icon can be any Evas object, but usually it is an icon created
27388     * with elm_icon_add().
27389     *
27390     * Once the icon object is set, a previously set one will be deleted.
27391     * @warning Setting the same icon for two items will cause the icon to
27392     * dissapear from the first item.
27393     *
27394     * If an icon was passed as argument on item creation, with function
27395     * elm_segment_control_item_add(), it will be already
27396     * associated to the item.
27397     *
27398     * @see elm_segment_control_item_add()
27399     * @see elm_segment_control_item_icon_get()
27400     *
27401     * @ingroup SegmentControl
27402     */
27403    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27404
27405    /**
27406     * Get the index of an item.
27407     *
27408     * @param it The segment control item.
27409     * @return The position of item in segment control widget.
27410     *
27411     * Index is the position of an item in segment control widget. Its
27412     * range is from @c 0 to <tt> count - 1 </tt>.
27413     * Count is the number of items, that can be get with
27414     * elm_segment_control_item_count_get().
27415     *
27416     * @ingroup SegmentControl
27417     */
27418    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27419
27420    /**
27421     * Get the base object of the item.
27422     *
27423     * @param it The segment control item.
27424     * @return The base object associated with @p it.
27425     *
27426     * Base object is the @c Evas_Object that represents that item.
27427     *
27428     * @ingroup SegmentControl
27429     */
27430    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27431
27432    /**
27433     * Get the selected item.
27434     *
27435     * @param obj The segment control object.
27436     * @return The selected item or @c NULL if none of segment items is
27437     * selected.
27438     *
27439     * The selected item can be unselected with function
27440     * elm_segment_control_item_selected_set().
27441     *
27442     * The selected item always will be highlighted on segment control.
27443     *
27444     * @ingroup SegmentControl
27445     */
27446    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27447
27448    /**
27449     * Set the selected state of an item.
27450     *
27451     * @param it The segment control item
27452     * @param select The selected state
27453     *
27454     * This sets the selected state of the given item @p it.
27455     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27456     *
27457     * If a new item is selected the previosly selected will be unselected.
27458     * Previoulsy selected item can be get with function
27459     * elm_segment_control_item_selected_get().
27460     *
27461     * The selected item always will be highlighted on segment control.
27462     *
27463     * @see elm_segment_control_item_selected_get()
27464     *
27465     * @ingroup SegmentControl
27466     */
27467    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27468
27469    /**
27470     * @}
27471     */
27472
27473    /**
27474     * @defgroup Grid Grid
27475     *
27476     * The grid is a grid layout widget that lays out a series of children as a
27477     * fixed "grid" of widgets using a given percentage of the grid width and
27478     * height each using the child object.
27479     *
27480     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27481     * widgets size itself. The default is 100 x 100, so that means the
27482     * position and sizes of children will effectively be percentages (0 to 100)
27483     * of the width or height of the grid widget
27484     *
27485     * @{
27486     */
27487
27488    /**
27489     * Add a new grid to the parent
27490     *
27491     * @param parent The parent object
27492     * @return The new object or NULL if it cannot be created
27493     *
27494     * @ingroup Grid
27495     */
27496    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27497
27498    /**
27499     * Set the virtual size of the grid
27500     *
27501     * @param obj The grid object
27502     * @param w The virtual width of the grid
27503     * @param h The virtual height of the grid
27504     *
27505     * @ingroup Grid
27506     */
27507    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27508
27509    /**
27510     * Get the virtual size of the grid
27511     *
27512     * @param obj The grid object
27513     * @param w Pointer to integer to store the virtual width of the grid
27514     * @param h Pointer to integer to store the virtual height of the grid
27515     *
27516     * @ingroup Grid
27517     */
27518    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27519
27520    /**
27521     * Pack child at given position and size
27522     *
27523     * @param obj The grid object
27524     * @param subobj The child to pack
27525     * @param x The virtual x coord at which to pack it
27526     * @param y The virtual y coord at which to pack it
27527     * @param w The virtual width at which to pack it
27528     * @param h The virtual height at which to pack it
27529     *
27530     * @ingroup Grid
27531     */
27532    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27533
27534    /**
27535     * Unpack a child from a grid object
27536     *
27537     * @param obj The grid object
27538     * @param subobj The child to unpack
27539     *
27540     * @ingroup Grid
27541     */
27542    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27543
27544    /**
27545     * Faster way to remove all child objects from a grid object.
27546     *
27547     * @param obj The grid object
27548     * @param clear If true, it will delete just removed children
27549     *
27550     * @ingroup Grid
27551     */
27552    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27553
27554    /**
27555     * Set packing of an existing child at to position and size
27556     *
27557     * @param subobj The child to set packing of
27558     * @param x The virtual x coord at which to pack it
27559     * @param y The virtual y coord at which to pack it
27560     * @param w The virtual width at which to pack it
27561     * @param h The virtual height at which to pack it
27562     *
27563     * @ingroup Grid
27564     */
27565    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27566
27567    /**
27568     * get packing of a child
27569     *
27570     * @param subobj The child to query
27571     * @param x Pointer to integer to store the virtual x coord
27572     * @param y Pointer to integer to store the virtual y coord
27573     * @param w Pointer to integer to store the virtual width
27574     * @param h Pointer to integer to store the virtual height
27575     *
27576     * @ingroup Grid
27577     */
27578    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27579
27580    /**
27581     * @}
27582     */
27583
27584    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27585    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27586    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27587    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27588    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
27589    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
27590
27591    /**
27592     * @defgroup Video Video
27593     *
27594     * @addtogroup Video
27595     * @{
27596     *
27597     * Elementary comes with two object that help design application that need
27598     * to display video. The main one, Elm_Video, display a video by using Emotion.
27599     * It does embedded the video inside an Edje object, so you can do some
27600     * animation depending on the video state change. It does also implement a
27601     * ressource management policy to remove this burden from the application writer.
27602     *
27603     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27604     * It take care of updating its content according to Emotion event and provide a
27605     * way to theme itself. It also does automatically raise the priority of the
27606     * linked Elm_Video so it will use the video decoder if available. It also does
27607     * activate the remember function on the linked Elm_Video object.
27608     *
27609     * Signals that you can add callback for are :
27610     *
27611     * "forward,clicked" - the user clicked the forward button.
27612     * "info,clicked" - the user clicked the info button.
27613     * "next,clicked" - the user clicked the next button.
27614     * "pause,clicked" - the user clicked the pause button.
27615     * "play,clicked" - the user clicked the play button.
27616     * "prev,clicked" - the user clicked the prev button.
27617     * "rewind,clicked" - the user clicked the rewind button.
27618     * "stop,clicked" - the user clicked the stop button.
27619     */
27620
27621    /**
27622     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27623     *
27624     * @param parent The parent object
27625     * @return a new player widget handle or @c NULL, on errors.
27626     *
27627     * This function inserts a new player widget on the canvas.
27628     *
27629     * @see elm_player_video_set()
27630     *
27631     * @ingroup Video
27632     */
27633    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27634
27635    /**
27636     * @brief Link a Elm_Payer with an Elm_Video object.
27637     *
27638     * @param player the Elm_Player object.
27639     * @param video The Elm_Video object.
27640     *
27641     * This mean that action on the player widget will affect the
27642     * video object and the state of the video will be reflected in
27643     * the player itself.
27644     *
27645     * @see elm_player_add()
27646     * @see elm_video_add()
27647     *
27648     * @ingroup Video
27649     */
27650    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27651
27652    /**
27653     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27654     *
27655     * @param parent The parent object
27656     * @return a new video widget handle or @c NULL, on errors.
27657     *
27658     * This function inserts a new video widget on the canvas.
27659     *
27660     * @seeelm_video_file_set()
27661     * @see elm_video_uri_set()
27662     *
27663     * @ingroup Video
27664     */
27665    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27666
27667    /**
27668     * @brief Define the file that will be the video source.
27669     *
27670     * @param video The video object to define the file for.
27671     * @param filename The file to target.
27672     *
27673     * This function will explicitly define a filename as a source
27674     * for the video of the Elm_Video object.
27675     *
27676     * @see elm_video_uri_set()
27677     * @see elm_video_add()
27678     * @see elm_player_add()
27679     *
27680     * @ingroup Video
27681     */
27682    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27683
27684    /**
27685     * @brief Define the uri that will be the video source.
27686     *
27687     * @param video The video object to define the file for.
27688     * @param uri The uri to target.
27689     *
27690     * This function will define an uri as a source for the video of the
27691     * Elm_Video object. URI could be remote source of video, like http:// or local source
27692     * like for example WebCam who are most of the time v4l2:// (but that depend and
27693     * you should use Emotion API to request and list the available Webcam on your system).
27694     *
27695     * @see elm_video_file_set()
27696     * @see elm_video_add()
27697     * @see elm_player_add()
27698     *
27699     * @ingroup Video
27700     */
27701    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27702
27703    /**
27704     * @brief Get the underlying Emotion object.
27705     *
27706     * @param video The video object to proceed the request on.
27707     * @return the underlying Emotion object.
27708     *
27709     * @ingroup Video
27710     */
27711    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27712
27713    /**
27714     * @brief Start to play the video
27715     *
27716     * @param video The video object to proceed the request on.
27717     *
27718     * Start to play the video and cancel all suspend state.
27719     *
27720     * @ingroup Video
27721     */
27722    EAPI void elm_video_play(Evas_Object *video);
27723
27724    /**
27725     * @brief Pause the video
27726     *
27727     * @param video The video object to proceed the request on.
27728     *
27729     * Pause the video and start a timer to trigger suspend mode.
27730     *
27731     * @ingroup Video
27732     */
27733    EAPI void elm_video_pause(Evas_Object *video);
27734
27735    /**
27736     * @brief Stop the video
27737     *
27738     * @param video The video object to proceed the request on.
27739     *
27740     * Stop the video and put the emotion in deep sleep mode.
27741     *
27742     * @ingroup Video
27743     */
27744    EAPI void elm_video_stop(Evas_Object *video);
27745
27746    /**
27747     * @brief Is the video actually playing.
27748     *
27749     * @param video The video object to proceed the request on.
27750     * @return EINA_TRUE if the video is actually playing.
27751     *
27752     * You should consider watching event on the object instead of polling
27753     * the object state.
27754     *
27755     * @ingroup Video
27756     */
27757    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27758
27759    /**
27760     * @brief Is it possible to seek inside the video.
27761     *
27762     * @param video The video object to proceed the request on.
27763     * @return EINA_TRUE if is possible to seek inside the video.
27764     *
27765     * @ingroup Video
27766     */
27767    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27768
27769    /**
27770     * @brief Is the audio muted.
27771     *
27772     * @param video The video object to proceed the request on.
27773     * @return EINA_TRUE if the audio is muted.
27774     *
27775     * @ingroup Video
27776     */
27777    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27778
27779    /**
27780     * @brief Change the mute state of the Elm_Video object.
27781     *
27782     * @param video The video object to proceed the request on.
27783     * @param mute The new mute state.
27784     *
27785     * @ingroup Video
27786     */
27787    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27788
27789    /**
27790     * @brief Get the audio level of the current video.
27791     *
27792     * @param video The video object to proceed the request on.
27793     * @return the current audio level.
27794     *
27795     * @ingroup Video
27796     */
27797    EAPI double elm_video_audio_level_get(Evas_Object *video);
27798
27799    /**
27800     * @brief Set the audio level of anElm_Video object.
27801     *
27802     * @param video The video object to proceed the request on.
27803     * @param volume The new audio volume.
27804     *
27805     * @ingroup Video
27806     */
27807    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27808
27809    EAPI double elm_video_play_position_get(Evas_Object *video);
27810    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27811    EAPI double elm_video_play_length_get(Evas_Object *video);
27812    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27813    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27814    EAPI const char *elm_video_title_get(Evas_Object *video);
27815    /**
27816     * @}
27817     */
27818
27819    /**
27820     * @defgroup Naviframe Naviframe
27821     * @ingroup Elementary
27822     *
27823     * @brief Naviframe is a kind of view manager for the applications.
27824     *
27825     * Naviframe provides functions to switch different pages with stack
27826     * mechanism. It means if one page(item) needs to be changed to the new one,
27827     * then naviframe would push the new page to it's internal stack. Of course,
27828     * it can be back to the previous page by popping the top page. Naviframe
27829     * provides some transition effect while the pages are switching (same as
27830     * pager).
27831     *
27832     * Since each item could keep the different styles, users could keep the
27833     * same look & feel for the pages or different styles for the items in it's
27834     * application.
27835     *
27836     * Signals that you can add callback for are:
27837     *
27838     * @li "transition,finished" - When the transition is finished in changing
27839     *     the item
27840     * @li "title,clicked" - User clicked title area
27841     *
27842     * Default contents parts for the naviframe items that you can use for are:
27843     *
27844     * @li "elm.swallow.content" - The main content of the page
27845     * @li "elm.swallow.prev_btn" - The button to go to the previous page
27846     * @li "elm.swallow.next_btn" - The button to go to the next page
27847     *
27848     * Default text parts of naviframe items that you can be used are:
27849     *
27850     * @li "elm.text.title" - The title label in the title area
27851     *
27852     * @ref tutorial_naviframe gives a good overview of the usage of the API.
27853     */
27854
27855    /**
27856     * @addtogroup Naviframe
27857     * @{
27858     */
27859
27860    /**
27861     * @brief Add a new Naviframe object to the parent.
27862     *
27863     * @param parent Parent object
27864     * @return New object or @c NULL, if it cannot be created
27865     *
27866     * @ingroup Naviframe
27867     */
27868    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27869    /**
27870     * @brief Push a new item to the top of the naviframe stack (and show it).
27871     *
27872     * @param obj The naviframe object
27873     * @param title_label The label in the title area. The name of the title
27874     *        label part is "elm.text.title"
27875     * @param prev_btn The button to go to the previous item. If it is NULL,
27876     *        then naviframe will create a back button automatically. The name of
27877     *        the prev_btn part is "elm.swallow.prev_btn"
27878     * @param next_btn The button to go to the next item. Or It could be just an
27879     *        extra function button. The name of the next_btn part is
27880     *        "elm.swallow.next_btn"
27881     * @param content The main content object. The name of content part is
27882     *        "elm.swallow.content"
27883     * @param item_style The current item style name. @c NULL would be default.
27884     * @return The created item or @c NULL upon failure.
27885     *
27886     * The item pushed becomes one page of the naviframe, this item will be
27887     * deleted when it is popped.
27888     *
27889     * @see also elm_naviframe_item_style_set()
27890     *
27891     * The following styles are available for this item:
27892     * @li @c "default"
27893     *
27894     * @ingroup Naviframe
27895     */
27896    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);
27897    /**
27898     * @brief Pop an item that is on top of the stack
27899     *
27900     * @param obj The naviframe object
27901     * @return @c NULL or the content object(if the
27902     *         elm_naviframe_content_preserve_on_pop_get is true).
27903     *
27904     * This pops an item that is on the top(visible) of the naviframe, makes it
27905     * disappear, then deletes the item. The item that was underneath it on the
27906     * stack will become visible.
27907     *
27908     * @see also elm_naviframe_content_preserve_on_pop_get()
27909     *
27910     * @ingroup Naviframe
27911     */
27912    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
27913    /**
27914     * @brief Pop the items between the top and the above one on the given item.
27915     *
27916     * @param it The naviframe item
27917     *
27918     * @ingroup Naviframe
27919     */
27920    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27921    /**
27922     * @brief Delete the given item instantly.
27923     *
27924     * @param it The naviframe item
27925     *
27926     * This just deletes the given item from the naviframe item list instantly.
27927     * So this would not emit any signals for view transitions but just change
27928     * the current view if the given item is a top one.
27929     *
27930     * @ingroup Naviframe
27931     */
27932    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27933    /**
27934     * @brief preserve the content objects when items are popped.
27935     *
27936     * @param obj The naviframe object
27937     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
27938     *
27939     * @see also elm_naviframe_content_preserve_on_pop_get()
27940     *
27941     * @ingroup Naviframe
27942     */
27943    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
27944    /**
27945     * @brief Get a value whether preserve mode is enabled or not.
27946     *
27947     * @param obj The naviframe object
27948     * @return If @c EINA_TRUE, preserve mode is enabled
27949     *
27950     * @see also elm_naviframe_content_preserve_on_pop_set()
27951     *
27952     * @ingroup Naviframe
27953     */
27954    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27955    /**
27956     * @brief Get a top item on the naviframe stack
27957     *
27958     * @param obj The naviframe object
27959     * @return The top item on the naviframe stack or @c NULL, if the stack is
27960     *         empty
27961     *
27962     * @ingroup Naviframe
27963     */
27964    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27965    /**
27966     * @brief Get a bottom item on the naviframe stack
27967     *
27968     * @param obj The naviframe object
27969     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
27970     *         empty
27971     *
27972     * @ingroup Naviframe
27973     */
27974    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27975    /**
27976     * @brief Set an item style
27977     *
27978     * @param obj The naviframe item
27979     * @param item_style The current item style name. @c NULL would be default
27980     *
27981     * The following styles are available for this item:
27982     * @li @c "default"
27983     *
27984     * @see also elm_naviframe_item_style_get()
27985     *
27986     * @ingroup Naviframe
27987     */
27988    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
27989    /**
27990     * @brief Get an item style
27991     *
27992     * @param obj The naviframe item
27993     * @return The current item style name
27994     *
27995     * @see also elm_naviframe_item_style_set()
27996     *
27997     * @ingroup Naviframe
27998     */
27999    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28000    /**
28001     * @brief Show/Hide the title area
28002     *
28003     * @param it The naviframe item
28004     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28005     *        otherwise
28006     *
28007     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28008     *
28009     * @see also elm_naviframe_item_title_visible_get()
28010     *
28011     * @ingroup Naviframe
28012     */
28013    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28014    /**
28015     * @brief Get a value whether title area is visible or not.
28016     *
28017     * @param it The naviframe item
28018     * @return If @c EINA_TRUE, title area is visible
28019     *
28020     * @see also elm_naviframe_item_title_visible_set()
28021     *
28022     * @ingroup Naviframe
28023     */
28024    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28025
28026    /**
28027     * @brief Set creating prev button automatically or not
28028     *
28029     * @param obj The naviframe object
28030     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28031     *        be created internally when you pass the @c NULL to the prev_btn
28032     *        parameter in elm_naviframe_item_push
28033     *
28034     * @see also elm_naviframe_item_push()
28035     */
28036    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28037    /**
28038     * @brief Get a value whether prev button(back button) will be auto pushed or
28039     *        not.
28040     *
28041     * @param obj The naviframe object
28042     * @return If @c EINA_TRUE, prev button will be auto pushed.
28043     *
28044     * @see also elm_naviframe_item_push()
28045     *           elm_naviframe_prev_btn_auto_pushed_set()
28046     */
28047    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28048
28049    /**
28050     * @}
28051     */
28052
28053 #ifdef __cplusplus
28054 }
28055 #endif
28056
28057 #endif