2653a9e08e174fd7edc74c8a1120aa243315c205
[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     * Set a content of an object item
1026     *
1027     * @param it The Elementary object item
1028     * @param part The content part name to set (NULL for the default content)
1029     * @param content The new content of the object item
1030     *
1031     * @note Elementary object items may have many contents
1032     *
1033     * @ingroup General
1034     */
1035    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1036
1037 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1038
1039    /**
1040     * Get a content of an object item
1041     *
1042     * @param it The Elementary object item
1043     * @param part The content part name to unset (NULL for the default content)
1044     * @return content of the object item or NULL for any error
1045     *
1046     * @note Elementary object items may have many contents
1047     *
1048     * @ingroup General
1049     */
1050    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1051
1052 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1053
1054    /**
1055     * Unset a content of an object item
1056     *
1057     * @param it The Elementary object item
1058     * @param part The content part name to unset (NULL for the default content)
1059     *
1060     * @note Elementary object items may have many contents
1061     *
1062     * @ingroup General
1063     */
1064    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1065
1066 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1067
1068    /**
1069     * Set a label of an objec itemt
1070     *
1071     * @param it The Elementary object item
1072     * @param part The text part name to set (NULL for the default label)
1073     * @param label The new text of the label
1074     *
1075     * @note Elementary object items may have many labels
1076     *
1077     * @ingroup General
1078     */
1079    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1080
1081 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1082
1083    /**
1084     * Get a label of an object
1085     *
1086     * @param it The Elementary object item
1087     * @param part The text part name to get (NULL for the default label)
1088     * @return text of the label or NULL for any error
1089     *
1090     * @note Elementary object items may have many labels
1091     *
1092     * @ingroup General
1093     */
1094    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1095
1096    /**
1097     * Set the text to read out when in accessibility mode
1098     *
1099     * @param obj The object which is to be described
1100     * @param txt The text that describes the widget to people with poor or no vision
1101     *
1102     * @ingroup General
1103     */
1104    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1105
1106    /**
1107     * Set the text to read out when in accessibility mode
1108     *
1109     * @param it The object item which is to be described
1110     * @param txt The text that describes the widget to people with poor or no vision
1111     *
1112     * @ingroup General
1113     */
1114    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1115
1116
1117 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1118
1119    /**
1120     * Get the data associated with an object item
1121     * @param it The object item
1122     * @return The data associated with @p it
1123     *
1124     * @ingroup General
1125     */
1126    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1127
1128    /**
1129     * Set the data associated with an object item
1130     * @param it The object item
1131     * @param data The data to be associated with @p it
1132     *
1133     * @ingroup General
1134     */
1135    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1136
1137    /**
1138     * Send a signal to the edje object of the widget item.
1139     *
1140     * This function sends a signal to the edje object of the obj item. An
1141     * edje program can respond to a signal by specifying matching
1142     * 'signal' and 'source' fields.
1143     *
1144     * @param it The Elementary object item
1145     * @param emission The signal's name.
1146     * @param source The signal's source.
1147     * @ingroup General
1148     */
1149    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1150
1151    /**
1152     * @}
1153     */
1154
1155    /**
1156     * @defgroup Caches Caches
1157     *
1158     * These are functions which let one fine-tune some cache values for
1159     * Elementary applications, thus allowing for performance adjustments.
1160     *
1161     * @{
1162     */
1163
1164    /**
1165     * @brief Flush all caches.
1166     *
1167     * Frees all data that was in cache and is not currently being used to reduce
1168     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1169     * to calling all of the following functions:
1170     * @li edje_file_cache_flush()
1171     * @li edje_collection_cache_flush()
1172     * @li eet_clearcache()
1173     * @li evas_image_cache_flush()
1174     * @li evas_font_cache_flush()
1175     * @li evas_render_dump()
1176     * @note Evas caches are flushed for every canvas associated with a window.
1177     *
1178     * @ingroup Caches
1179     */
1180    EAPI void         elm_all_flush(void);
1181
1182    /**
1183     * Get the configured cache flush interval time
1184     *
1185     * This gets the globally configured cache flush interval time, in
1186     * ticks
1187     *
1188     * @return The cache flush interval time
1189     * @ingroup Caches
1190     *
1191     * @see elm_all_flush()
1192     */
1193    EAPI int          elm_cache_flush_interval_get(void);
1194
1195    /**
1196     * Set the configured cache flush interval time
1197     *
1198     * This sets the globally configured cache flush interval time, in ticks
1199     *
1200     * @param size The cache flush interval time
1201     * @ingroup Caches
1202     *
1203     * @see elm_all_flush()
1204     */
1205    EAPI void         elm_cache_flush_interval_set(int size);
1206
1207    /**
1208     * Set the configured cache flush interval time for all applications on the
1209     * display
1210     *
1211     * This sets the globally configured cache flush interval time -- in ticks
1212     * -- for all applications on the display.
1213     *
1214     * @param size The cache flush interval time
1215     * @ingroup Caches
1216     */
1217    EAPI void         elm_cache_flush_interval_all_set(int size);
1218
1219    /**
1220     * Get the configured cache flush enabled state
1221     *
1222     * This gets the globally configured cache flush state - if it is enabled
1223     * or not. When cache flushing is enabled, elementary will regularly
1224     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1225     * memory and allow usage to re-seed caches and data in memory where it
1226     * can do so. An idle application will thus minimise its memory usage as
1227     * data will be freed from memory and not be re-loaded as it is idle and
1228     * not rendering or doing anything graphically right now.
1229     *
1230     * @return The cache flush state
1231     * @ingroup Caches
1232     *
1233     * @see elm_all_flush()
1234     */
1235    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1236
1237    /**
1238     * Set the configured cache flush enabled state
1239     *
1240     * This sets the globally configured cache flush enabled state
1241     *
1242     * @param size The cache flush enabled state
1243     * @ingroup Caches
1244     *
1245     * @see elm_all_flush()
1246     */
1247    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1248
1249    /**
1250     * Set the configured cache flush enabled state for all applications on the
1251     * display
1252     *
1253     * This sets the globally configured cache flush enabled state for all
1254     * applications on the display.
1255     *
1256     * @param size The cache flush enabled state
1257     * @ingroup Caches
1258     */
1259    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1260
1261    /**
1262     * Get the configured font cache size
1263     *
1264     * This gets the globally configured font cache size, in bytes
1265     *
1266     * @return The font cache size
1267     * @ingroup Caches
1268     */
1269    EAPI int          elm_font_cache_get(void);
1270
1271    /**
1272     * Set the configured font cache size
1273     *
1274     * This sets the globally configured font cache size, in bytes
1275     *
1276     * @param size The font cache size
1277     * @ingroup Caches
1278     */
1279    EAPI void         elm_font_cache_set(int size);
1280
1281    /**
1282     * Set the configured font cache size for all applications on the
1283     * display
1284     *
1285     * This sets the globally configured font cache size -- in bytes
1286     * -- for all applications on the display.
1287     *
1288     * @param size The font cache size
1289     * @ingroup Caches
1290     */
1291    EAPI void         elm_font_cache_all_set(int size);
1292
1293    /**
1294     * Get the configured image cache size
1295     *
1296     * This gets the globally configured image cache size, in bytes
1297     *
1298     * @return The image cache size
1299     * @ingroup Caches
1300     */
1301    EAPI int          elm_image_cache_get(void);
1302
1303    /**
1304     * Set the configured image cache size
1305     *
1306     * This sets the globally configured image cache size, in bytes
1307     *
1308     * @param size The image cache size
1309     * @ingroup Caches
1310     */
1311    EAPI void         elm_image_cache_set(int size);
1312
1313    /**
1314     * Set the configured image cache size for all applications on the
1315     * display
1316     *
1317     * This sets the globally configured image cache size -- in bytes
1318     * -- for all applications on the display.
1319     *
1320     * @param size The image cache size
1321     * @ingroup Caches
1322     */
1323    EAPI void         elm_image_cache_all_set(int size);
1324
1325    /**
1326     * Get the configured edje file cache size.
1327     *
1328     * This gets the globally configured edje file cache size, in number
1329     * of files.
1330     *
1331     * @return The edje file cache size
1332     * @ingroup Caches
1333     */
1334    EAPI int          elm_edje_file_cache_get(void);
1335
1336    /**
1337     * Set the configured edje file cache size
1338     *
1339     * This sets the globally configured edje file cache size, in number
1340     * of files.
1341     *
1342     * @param size The edje file cache size
1343     * @ingroup Caches
1344     */
1345    EAPI void         elm_edje_file_cache_set(int size);
1346
1347    /**
1348     * Set the configured edje file cache size for all applications on the
1349     * display
1350     *
1351     * This sets the globally configured edje file cache size -- in number
1352     * of files -- for all applications on the display.
1353     *
1354     * @param size The edje file cache size
1355     * @ingroup Caches
1356     */
1357    EAPI void         elm_edje_file_cache_all_set(int size);
1358
1359    /**
1360     * Get the configured edje collections (groups) cache size.
1361     *
1362     * This gets the globally configured edje collections cache size, in
1363     * number of collections.
1364     *
1365     * @return The edje collections cache size
1366     * @ingroup Caches
1367     */
1368    EAPI int          elm_edje_collection_cache_get(void);
1369
1370    /**
1371     * Set the configured edje collections (groups) cache size
1372     *
1373     * This sets the globally configured edje collections cache size, in
1374     * number of collections.
1375     *
1376     * @param size The edje collections cache size
1377     * @ingroup Caches
1378     */
1379    EAPI void         elm_edje_collection_cache_set(int size);
1380
1381    /**
1382     * Set the configured edje collections (groups) cache size for all
1383     * applications on the display
1384     *
1385     * This sets the globally configured edje collections cache size -- in
1386     * number of collections -- for all applications on the display.
1387     *
1388     * @param size The edje collections cache size
1389     * @ingroup Caches
1390     */
1391    EAPI void         elm_edje_collection_cache_all_set(int size);
1392
1393    /**
1394     * @}
1395     */
1396
1397    /**
1398     * @defgroup Scaling Widget Scaling
1399     *
1400     * Different widgets can be scaled independently. These functions
1401     * allow you to manipulate this scaling on a per-widget basis. The
1402     * object and all its children get their scaling factors multiplied
1403     * by the scale factor set. This is multiplicative, in that if a
1404     * child also has a scale size set it is in turn multiplied by its
1405     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1406     * double size, @c 0.5 is half, etc.
1407     *
1408     * @ref general_functions_example_page "This" example contemplates
1409     * some of these functions.
1410     */
1411
1412    /**
1413     * Get the global scaling factor
1414     *
1415     * This gets the globally configured scaling factor that is applied to all
1416     * objects.
1417     *
1418     * @return The scaling factor
1419     * @ingroup Scaling
1420     */
1421    EAPI double       elm_scale_get(void);
1422
1423    /**
1424     * Set the global scaling factor
1425     *
1426     * This sets the globally configured scaling factor that is applied to all
1427     * objects.
1428     *
1429     * @param scale The scaling factor to set
1430     * @ingroup Scaling
1431     */
1432    EAPI void         elm_scale_set(double scale);
1433
1434    /**
1435     * Set the global scaling factor for all applications on the display
1436     *
1437     * This sets the globally configured scaling factor that is applied to all
1438     * objects for all applications.
1439     * @param scale The scaling factor to set
1440     * @ingroup Scaling
1441     */
1442    EAPI void         elm_scale_all_set(double scale);
1443
1444    /**
1445     * Set the scaling factor for a given Elementary object
1446     *
1447     * @param obj The Elementary to operate on
1448     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1449     * no scaling)
1450     *
1451     * @ingroup Scaling
1452     */
1453    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1454
1455    /**
1456     * Get the scaling factor for a given Elementary object
1457     *
1458     * @param obj The object
1459     * @return The scaling factor set by elm_object_scale_set()
1460     *
1461     * @ingroup Scaling
1462     */
1463    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1464
1465    /**
1466     * @defgroup Password_last_show Password last input show
1467     *
1468     * Last show feature of password mode enables user to view
1469     * the last input entered for few seconds before masking it.
1470     * These functions allow to set this feature in password mode
1471     * of entry widget and also allow to manipulate the duration
1472     * for which the input has to be visible.
1473     *
1474     * @{
1475     */
1476
1477    /**
1478     * Get show last setting of password mode.
1479     *
1480     * This gets the show last input setting of password mode which might be
1481     * enabled or disabled.
1482     *
1483     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1484     *            if it's disabled.
1485     * @ingroup Password_last_show
1486     */
1487    EAPI Eina_Bool elm_password_show_last_get(void);
1488
1489    /**
1490     * Set show last setting in password mode.
1491     *
1492     * This enables or disables show last setting of password mode.
1493     *
1494     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1495     * @see elm_password_show_last_timeout_set()
1496     * @ingroup Password_last_show
1497     */
1498    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1499
1500    /**
1501     * Get's the timeout value in last show password mode.
1502     *
1503     * This gets the time out value for which the last input entered in password
1504     * mode will be visible.
1505     *
1506     * @return The timeout value of last show password mode.
1507     * @ingroup Password_last_show
1508     */
1509    EAPI double elm_password_show_last_timeout_get(void);
1510
1511    /**
1512     * Set's the timeout value in last show password mode.
1513     *
1514     * This sets the time out value for which the last input entered in password
1515     * mode will be visible.
1516     *
1517     * @param password_show_last_timeout The timeout value.
1518     * @see elm_password_show_last_set()
1519     * @ingroup Password_last_show
1520     */
1521    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1522
1523    /**
1524     * @}
1525     */
1526
1527    /**
1528     * @defgroup UI-Mirroring Selective Widget mirroring
1529     *
1530     * These functions allow you to set ui-mirroring on specific
1531     * widgets or the whole interface. Widgets can be in one of two
1532     * modes, automatic and manual.  Automatic means they'll be changed
1533     * according to the system mirroring mode and manual means only
1534     * explicit changes will matter. You are not supposed to change
1535     * mirroring state of a widget set to automatic, will mostly work,
1536     * but the behavior is not really defined.
1537     *
1538     * @{
1539     */
1540
1541    EAPI Eina_Bool    elm_mirrored_get(void);
1542    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1543
1544    /**
1545     * Get the system mirrored mode. This determines the default mirrored mode
1546     * of widgets.
1547     *
1548     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1549     */
1550    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1551
1552    /**
1553     * Set the system mirrored mode. This determines the default mirrored mode
1554     * of widgets.
1555     *
1556     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1557     */
1558    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1559
1560    /**
1561     * Returns the widget's mirrored mode setting.
1562     *
1563     * @param obj The widget.
1564     * @return mirrored mode setting of the object.
1565     *
1566     **/
1567    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1568
1569    /**
1570     * Sets the widget's mirrored mode setting.
1571     * When widget in automatic mode, it follows the system mirrored mode set by
1572     * elm_mirrored_set().
1573     * @param obj The widget.
1574     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1575     */
1576    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1577
1578    /**
1579     * @}
1580     */
1581
1582    /**
1583     * Set the style to use by a widget
1584     *
1585     * Sets the style name that will define the appearance of a widget. Styles
1586     * vary from widget to widget and may also be defined by other themes
1587     * by means of extensions and overlays.
1588     *
1589     * @param obj The Elementary widget to style
1590     * @param style The style name to use
1591     *
1592     * @see elm_theme_extension_add()
1593     * @see elm_theme_extension_del()
1594     * @see elm_theme_overlay_add()
1595     * @see elm_theme_overlay_del()
1596     *
1597     * @ingroup Styles
1598     */
1599    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1600    /**
1601     * Get the style used by the widget
1602     *
1603     * This gets the style being used for that widget. Note that the string
1604     * pointer is only valid as longas the object is valid and the style doesn't
1605     * change.
1606     *
1607     * @param obj The Elementary widget to query for its style
1608     * @return The style name used
1609     *
1610     * @see elm_object_style_set()
1611     *
1612     * @ingroup Styles
1613     */
1614    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1615
1616    /**
1617     * @defgroup Styles Styles
1618     *
1619     * Widgets can have different styles of look. These generic API's
1620     * set styles of widgets, if they support them (and if the theme(s)
1621     * do).
1622     *
1623     * @ref general_functions_example_page "This" example contemplates
1624     * some of these functions.
1625     */
1626
1627    /**
1628     * Set the disabled state of an Elementary object.
1629     *
1630     * @param obj The Elementary object to operate on
1631     * @param disabled The state to put in in: @c EINA_TRUE for
1632     *        disabled, @c EINA_FALSE for enabled
1633     *
1634     * Elementary objects can be @b disabled, in which state they won't
1635     * receive input and, in general, will be themed differently from
1636     * their normal state, usually greyed out. Useful for contexts
1637     * where you don't want your users to interact with some of the
1638     * parts of you interface.
1639     *
1640     * This sets the state for the widget, either disabling it or
1641     * enabling it back.
1642     *
1643     * @ingroup Styles
1644     */
1645    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1646
1647    /**
1648     * Get the disabled state of an Elementary object.
1649     *
1650     * @param obj The Elementary object to operate on
1651     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1652     *            if it's enabled (or on errors)
1653     *
1654     * This gets the state of the widget, which might be enabled or disabled.
1655     *
1656     * @ingroup Styles
1657     */
1658    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1659
1660    /**
1661     * @defgroup WidgetNavigation Widget Tree Navigation.
1662     *
1663     * How to check if an Evas Object is an Elementary widget? How to
1664     * get the first elementary widget that is parent of the given
1665     * object?  These are all covered in widget tree navigation.
1666     *
1667     * @ref general_functions_example_page "This" example contemplates
1668     * some of these functions.
1669     */
1670
1671    /**
1672     * Check if the given Evas Object is an Elementary widget.
1673     *
1674     * @param obj the object to query.
1675     * @return @c EINA_TRUE if it is an elementary widget variant,
1676     *         @c EINA_FALSE otherwise
1677     * @ingroup WidgetNavigation
1678     */
1679    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1680
1681    /**
1682     * Get the first parent of the given object that is an Elementary
1683     * widget.
1684     *
1685     * @param obj the Elementary object to query parent from.
1686     * @return the parent object that is an Elementary widget, or @c
1687     *         NULL, if it was not found.
1688     *
1689     * Use this to query for an object's parent widget.
1690     *
1691     * @note Most of Elementary users wouldn't be mixing non-Elementary
1692     * smart objects in the objects tree of an application, as this is
1693     * an advanced usage of Elementary with Evas. So, except for the
1694     * application's window, which is the root of that tree, all other
1695     * objects would have valid Elementary widget parents.
1696     *
1697     * @ingroup WidgetNavigation
1698     */
1699    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1700
1701    /**
1702     * Get the top level parent of an Elementary widget.
1703     *
1704     * @param obj The object to query.
1705     * @return The top level Elementary widget, or @c NULL if parent cannot be
1706     * found.
1707     * @ingroup WidgetNavigation
1708     */
1709    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1710
1711    /**
1712     * Get the string that represents this Elementary widget.
1713     *
1714     * @note Elementary is weird and exposes itself as a single
1715     *       Evas_Object_Smart_Class of type "elm_widget", so
1716     *       evas_object_type_get() always return that, making debug and
1717     *       language bindings hard. This function tries to mitigate this
1718     *       problem, but the solution is to change Elementary to use
1719     *       proper inheritance.
1720     *
1721     * @param obj the object to query.
1722     * @return Elementary widget name, or @c NULL if not a valid widget.
1723     * @ingroup WidgetNavigation
1724     */
1725    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1726
1727    /**
1728     * @defgroup Config Elementary Config
1729     *
1730     * Elementary configuration is formed by a set options bounded to a
1731     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1732     * "finger size", etc. These are functions with which one syncronizes
1733     * changes made to those values to the configuration storing files, de
1734     * facto. You most probably don't want to use the functions in this
1735     * group unlees you're writing an elementary configuration manager.
1736     *
1737     * @{
1738     */
1739
1740    /**
1741     * Save back Elementary's configuration, so that it will persist on
1742     * future sessions.
1743     *
1744     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1745     * @ingroup Config
1746     *
1747     * This function will take effect -- thus, do I/O -- immediately. Use
1748     * it when you want to apply all configuration changes at once. The
1749     * current configuration set will get saved onto the current profile
1750     * configuration file.
1751     *
1752     */
1753    EAPI Eina_Bool    elm_config_save(void);
1754
1755    /**
1756     * Reload Elementary's configuration, bounded to current selected
1757     * profile.
1758     *
1759     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1760     * @ingroup Config
1761     *
1762     * Useful when you want to force reloading of configuration values for
1763     * a profile. If one removes user custom configuration directories,
1764     * for example, it will force a reload with system values insted.
1765     *
1766     */
1767    EAPI void         elm_config_reload(void);
1768
1769    /**
1770     * @}
1771     */
1772
1773    /**
1774     * @defgroup Profile Elementary Profile
1775     *
1776     * Profiles are pre-set options that affect the whole look-and-feel of
1777     * Elementary-based applications. There are, for example, profiles
1778     * aimed at desktop computer applications and others aimed at mobile,
1779     * touchscreen-based ones. You most probably don't want to use the
1780     * functions in this group unlees you're writing an elementary
1781     * configuration manager.
1782     *
1783     * @{
1784     */
1785
1786    /**
1787     * Get Elementary's profile in use.
1788     *
1789     * This gets the global profile that is applied to all Elementary
1790     * applications.
1791     *
1792     * @return The profile's name
1793     * @ingroup Profile
1794     */
1795    EAPI const char  *elm_profile_current_get(void);
1796
1797    /**
1798     * Get an Elementary's profile directory path in the filesystem. One
1799     * may want to fetch a system profile's dir or an user one (fetched
1800     * inside $HOME).
1801     *
1802     * @param profile The profile's name
1803     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1804     *                or a system one (@c EINA_FALSE)
1805     * @return The profile's directory path.
1806     * @ingroup Profile
1807     *
1808     * @note You must free it with elm_profile_dir_free().
1809     */
1810    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1811
1812    /**
1813     * Free an Elementary's profile directory path, as returned by
1814     * elm_profile_dir_get().
1815     *
1816     * @param p_dir The profile's path
1817     * @ingroup Profile
1818     *
1819     */
1820    EAPI void         elm_profile_dir_free(const char *p_dir);
1821
1822    /**
1823     * Get Elementary's list of available profiles.
1824     *
1825     * @return The profiles list. List node data are the profile name
1826     *         strings.
1827     * @ingroup Profile
1828     *
1829     * @note One must free this list, after usage, with the function
1830     *       elm_profile_list_free().
1831     */
1832    EAPI Eina_List   *elm_profile_list_get(void);
1833
1834    /**
1835     * Free Elementary's list of available profiles.
1836     *
1837     * @param l The profiles list, as returned by elm_profile_list_get().
1838     * @ingroup Profile
1839     *
1840     */
1841    EAPI void         elm_profile_list_free(Eina_List *l);
1842
1843    /**
1844     * Set Elementary's profile.
1845     *
1846     * This sets the global profile that is applied to Elementary
1847     * applications. Just the process the call comes from will be
1848     * affected.
1849     *
1850     * @param profile The profile's name
1851     * @ingroup Profile
1852     *
1853     */
1854    EAPI void         elm_profile_set(const char *profile);
1855
1856    /**
1857     * Set Elementary's profile.
1858     *
1859     * This sets the global profile that is applied to all Elementary
1860     * applications. All running Elementary windows will be affected.
1861     *
1862     * @param profile The profile's name
1863     * @ingroup Profile
1864     *
1865     */
1866    EAPI void         elm_profile_all_set(const char *profile);
1867
1868    /**
1869     * @}
1870     */
1871
1872    /**
1873     * @defgroup Engine Elementary Engine
1874     *
1875     * These are functions setting and querying which rendering engine
1876     * Elementary will use for drawing its windows' pixels.
1877     *
1878     * The following are the available engines:
1879     * @li "software_x11"
1880     * @li "fb"
1881     * @li "directfb"
1882     * @li "software_16_x11"
1883     * @li "software_8_x11"
1884     * @li "xrender_x11"
1885     * @li "opengl_x11"
1886     * @li "software_gdi"
1887     * @li "software_16_wince_gdi"
1888     * @li "sdl"
1889     * @li "software_16_sdl"
1890     * @li "opengl_sdl"
1891     * @li "buffer"
1892     *
1893     * @{
1894     */
1895
1896    /**
1897     * @brief Get Elementary's rendering engine in use.
1898     *
1899     * @return The rendering engine's name
1900     * @note there's no need to free the returned string, here.
1901     *
1902     * This gets the global rendering engine that is applied to all Elementary
1903     * applications.
1904     *
1905     * @see elm_engine_set()
1906     */
1907    EAPI const char  *elm_engine_current_get(void);
1908
1909    /**
1910     * @brief Set Elementary's rendering engine for use.
1911     *
1912     * @param engine The rendering engine's name
1913     *
1914     * This sets global rendering engine that is applied to all Elementary
1915     * applications. Note that it will take effect only to Elementary windows
1916     * created after this is called.
1917     *
1918     * @see elm_win_add()
1919     */
1920    EAPI void         elm_engine_set(const char *engine);
1921
1922    /**
1923     * @}
1924     */
1925
1926    /**
1927     * @defgroup Fonts Elementary Fonts
1928     *
1929     * These are functions dealing with font rendering, selection and the
1930     * like for Elementary applications. One might fetch which system
1931     * fonts are there to use and set custom fonts for individual classes
1932     * of UI items containing text (text classes).
1933     *
1934     * @{
1935     */
1936
1937   typedef struct _Elm_Text_Class
1938     {
1939        const char *name;
1940        const char *desc;
1941     } Elm_Text_Class;
1942
1943   typedef struct _Elm_Font_Overlay
1944     {
1945        const char     *text_class;
1946        const char     *font;
1947        Evas_Font_Size  size;
1948     } Elm_Font_Overlay;
1949
1950   typedef struct _Elm_Font_Properties
1951     {
1952        const char *name;
1953        Eina_List  *styles;
1954     } Elm_Font_Properties;
1955
1956    /**
1957     * Get Elementary's list of supported text classes.
1958     *
1959     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1960     * @ingroup Fonts
1961     *
1962     * Release the list with elm_text_classes_list_free().
1963     */
1964    EAPI const Eina_List     *elm_text_classes_list_get(void);
1965
1966    /**
1967     * Free Elementary's list of supported text classes.
1968     *
1969     * @ingroup Fonts
1970     *
1971     * @see elm_text_classes_list_get().
1972     */
1973    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1974
1975    /**
1976     * Get Elementary's list of font overlays, set with
1977     * elm_font_overlay_set().
1978     *
1979     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1980     * data.
1981     *
1982     * @ingroup Fonts
1983     *
1984     * For each text class, one can set a <b>font overlay</b> for it,
1985     * overriding the default font properties for that class coming from
1986     * the theme in use. There is no need to free this list.
1987     *
1988     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1989     */
1990    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1991
1992    /**
1993     * Set a font overlay for a given Elementary text class.
1994     *
1995     * @param text_class Text class name
1996     * @param font Font name and style string
1997     * @param size Font size
1998     *
1999     * @ingroup Fonts
2000     *
2001     * @p font has to be in the format returned by
2002     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2003     * and elm_font_overlay_unset().
2004     */
2005    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2006
2007    /**
2008     * Unset a font overlay for a given Elementary text class.
2009     *
2010     * @param text_class Text class name
2011     *
2012     * @ingroup Fonts
2013     *
2014     * This will bring back text elements belonging to text class
2015     * @p text_class back to their default font settings.
2016     */
2017    EAPI void                 elm_font_overlay_unset(const char *text_class);
2018
2019    /**
2020     * Apply the changes made with elm_font_overlay_set() and
2021     * elm_font_overlay_unset() on the current Elementary window.
2022     *
2023     * @ingroup Fonts
2024     *
2025     * This applies all font overlays set to all objects in the UI.
2026     */
2027    EAPI void                 elm_font_overlay_apply(void);
2028
2029    /**
2030     * Apply the changes made with elm_font_overlay_set() and
2031     * elm_font_overlay_unset() on all Elementary application windows.
2032     *
2033     * @ingroup Fonts
2034     *
2035     * This applies all font overlays set to all objects in the UI.
2036     */
2037    EAPI void                 elm_font_overlay_all_apply(void);
2038
2039    /**
2040     * Translate a font (family) name string in fontconfig's font names
2041     * syntax into an @c Elm_Font_Properties struct.
2042     *
2043     * @param font The font name and styles string
2044     * @return the font properties struct
2045     *
2046     * @ingroup Fonts
2047     *
2048     * @note The reverse translation can be achived with
2049     * elm_font_fontconfig_name_get(), for one style only (single font
2050     * instance, not family).
2051     */
2052    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2053
2054    /**
2055     * Free font properties return by elm_font_properties_get().
2056     *
2057     * @param efp the font properties struct
2058     *
2059     * @ingroup Fonts
2060     */
2061    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2062
2063    /**
2064     * Translate a font name, bound to a style, into fontconfig's font names
2065     * syntax.
2066     *
2067     * @param name The font (family) name
2068     * @param style The given style (may be @c NULL)
2069     *
2070     * @return the font name and style string
2071     *
2072     * @ingroup Fonts
2073     *
2074     * @note The reverse translation can be achived with
2075     * elm_font_properties_get(), for one style only (single font
2076     * instance, not family).
2077     */
2078    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2079
2080    /**
2081     * Free the font string return by elm_font_fontconfig_name_get().
2082     *
2083     * @param efp the font properties struct
2084     *
2085     * @ingroup Fonts
2086     */
2087    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2088
2089    /**
2090     * Create a font hash table of available system fonts.
2091     *
2092     * One must call it with @p list being the return value of
2093     * evas_font_available_list(). The hash will be indexed by font
2094     * (family) names, being its values @c Elm_Font_Properties blobs.
2095     *
2096     * @param list The list of available system fonts, as returned by
2097     * evas_font_available_list().
2098     * @return the font hash.
2099     *
2100     * @ingroup Fonts
2101     *
2102     * @note The user is supposed to get it populated at least with 3
2103     * default font families (Sans, Serif, Monospace), which should be
2104     * present on most systems.
2105     */
2106    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2107
2108    /**
2109     * Free the hash return by elm_font_available_hash_add().
2110     *
2111     * @param hash the hash to be freed.
2112     *
2113     * @ingroup Fonts
2114     */
2115    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2116
2117    /**
2118     * @}
2119     */
2120
2121    /**
2122     * @defgroup Fingers Fingers
2123     *
2124     * Elementary is designed to be finger-friendly for touchscreens,
2125     * and so in addition to scaling for display resolution, it can
2126     * also scale based on finger "resolution" (or size). You can then
2127     * customize the granularity of the areas meant to receive clicks
2128     * on touchscreens.
2129     *
2130     * Different profiles may have pre-set values for finger sizes.
2131     *
2132     * @ref general_functions_example_page "This" example contemplates
2133     * some of these functions.
2134     *
2135     * @{
2136     */
2137
2138    /**
2139     * Get the configured "finger size"
2140     *
2141     * @return The finger size
2142     *
2143     * This gets the globally configured finger size, <b>in pixels</b>
2144     *
2145     * @ingroup Fingers
2146     */
2147    EAPI Evas_Coord       elm_finger_size_get(void);
2148
2149    /**
2150     * Set the configured finger size
2151     *
2152     * This sets the globally configured finger size in pixels
2153     *
2154     * @param size The finger size
2155     * @ingroup Fingers
2156     */
2157    EAPI void             elm_finger_size_set(Evas_Coord size);
2158
2159    /**
2160     * Set the configured finger size for all applications on the display
2161     *
2162     * This sets the globally configured finger size in pixels for all
2163     * applications on the display
2164     *
2165     * @param size The finger size
2166     * @ingroup Fingers
2167     */
2168    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2169
2170    /**
2171     * @}
2172     */
2173
2174    /**
2175     * @defgroup Focus Focus
2176     *
2177     * An Elementary application has, at all times, one (and only one)
2178     * @b focused object. This is what determines where the input
2179     * events go to within the application's window. Also, focused
2180     * objects can be decorated differently, in order to signal to the
2181     * user where the input is, at a given moment.
2182     *
2183     * Elementary applications also have the concept of <b>focus
2184     * chain</b>: one can cycle through all the windows' focusable
2185     * objects by input (tab key) or programmatically. The default
2186     * focus chain for an application is the one define by the order in
2187     * which the widgets where added in code. One will cycle through
2188     * top level widgets, and, for each one containg sub-objects, cycle
2189     * through them all, before returning to the level
2190     * above. Elementary also allows one to set @b custom focus chains
2191     * for their applications.
2192     *
2193     * Besides the focused decoration a widget may exhibit, when it
2194     * gets focus, Elementary has a @b global focus highlight object
2195     * that can be enabled for a window. If one chooses to do so, this
2196     * extra highlight effect will surround the current focused object,
2197     * too.
2198     *
2199     * @note Some Elementary widgets are @b unfocusable, after
2200     * creation, by their very nature: they are not meant to be
2201     * interacted with input events, but are there just for visual
2202     * purposes.
2203     *
2204     * @ref general_functions_example_page "This" example contemplates
2205     * some of these functions.
2206     */
2207
2208    /**
2209     * Get the enable status of the focus highlight
2210     *
2211     * This gets whether the highlight on focused objects is enabled or not
2212     * @ingroup Focus
2213     */
2214    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2215
2216    /**
2217     * Set the enable status of the focus highlight
2218     *
2219     * Set whether to show or not the highlight on focused objects
2220     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2221     * @ingroup Focus
2222     */
2223    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2224
2225    /**
2226     * Get the enable status of the highlight animation
2227     *
2228     * Get whether the focus highlight, if enabled, will animate its switch from
2229     * one object to the next
2230     * @ingroup Focus
2231     */
2232    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2233
2234    /**
2235     * Set the enable status of the highlight animation
2236     *
2237     * Set whether the focus highlight, if enabled, will animate its switch from
2238     * one object to the next
2239     * @param animate Enable animation if EINA_TRUE, disable otherwise
2240     * @ingroup Focus
2241     */
2242    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2243
2244    /**
2245     * Get the whether an Elementary object has the focus or not.
2246     *
2247     * @param obj The Elementary object to get the information from
2248     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2249     *            not (and on errors).
2250     *
2251     * @see elm_object_focus_set()
2252     *
2253     * @ingroup Focus
2254     */
2255    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2256
2257    /**
2258     * Set/unset focus to a given Elementary object.
2259     *
2260     * @param obj The Elementary object to operate on.
2261     * @param enable @c EINA_TRUE Set focus to a given object,
2262     *               @c EINA_FALSE Unset focus to a given object.
2263     *
2264     * @note When you set focus to this object, if it can handle focus, will
2265     * take the focus away from the one who had it previously and will, for
2266     * now on, be the one receiving input events. Unsetting focus will remove
2267     * the focus from @p obj, passing it back to the previous element in the
2268     * focus chain list.
2269     *
2270     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2271     *
2272     * @ingroup Focus
2273     */
2274    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2275
2276    /**
2277     * Make a given Elementary object the focused one.
2278     *
2279     * @param obj The Elementary object to make focused.
2280     *
2281     * @note This object, if it can handle focus, will take the focus
2282     * away from the one who had it previously and will, for now on, be
2283     * the one receiving input events.
2284     *
2285     * @see elm_object_focus_get()
2286     * @deprecated use elm_object_focus_set() instead.
2287     *
2288     * @ingroup Focus
2289     */
2290    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2291
2292    /**
2293     * Remove the focus from an Elementary object
2294     *
2295     * @param obj The Elementary to take focus from
2296     *
2297     * This removes the focus from @p obj, passing it back to the
2298     * previous element in the focus chain list.
2299     *
2300     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2301     * @deprecated use elm_object_focus_set() instead.
2302     *
2303     * @ingroup Focus
2304     */
2305    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2306
2307    /**
2308     * Set the ability for an Element object to be focused
2309     *
2310     * @param obj The Elementary object to operate on
2311     * @param enable @c EINA_TRUE if the object can be focused, @c
2312     *        EINA_FALSE if not (and on errors)
2313     *
2314     * This sets whether the object @p obj is able to take focus or
2315     * not. Unfocusable objects do nothing when programmatically
2316     * focused, being the nearest focusable parent object the one
2317     * really getting focus. Also, when they receive mouse input, they
2318     * will get the event, but not take away the focus from where it
2319     * was previously.
2320     *
2321     * @ingroup Focus
2322     */
2323    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2324
2325    /**
2326     * Get whether an Elementary object is focusable or not
2327     *
2328     * @param obj The Elementary object to operate on
2329     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2330     *             EINA_FALSE if not (and on errors)
2331     *
2332     * @note Objects which are meant to be interacted with by input
2333     * events are created able to be focused, by default. All the
2334     * others are not.
2335     *
2336     * @ingroup Focus
2337     */
2338    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2339
2340    /**
2341     * Set custom focus chain.
2342     *
2343     * This function overwrites any previous custom focus chain within
2344     * the list of objects. The previous list will be deleted and this list
2345     * will be managed by elementary. After it is set, don't modify it.
2346     *
2347     * @note On focus cycle, only will be evaluated children of this container.
2348     *
2349     * @param obj The container object
2350     * @param objs Chain of objects to pass focus
2351     * @ingroup Focus
2352     */
2353    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2354
2355    /**
2356     * Unset a custom focus chain on a given Elementary widget
2357     *
2358     * @param obj The container object to remove focus chain from
2359     *
2360     * Any focus chain previously set on @p obj (for its child objects)
2361     * is removed entirely after this call.
2362     *
2363     * @ingroup Focus
2364     */
2365    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2366
2367    /**
2368     * Get custom focus chain
2369     *
2370     * @param obj The container object
2371     * @ingroup Focus
2372     */
2373    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2374
2375    /**
2376     * Append object to custom focus chain.
2377     *
2378     * @note If relative_child equal to NULL or not in custom chain, the object
2379     * will be added in end.
2380     *
2381     * @note On focus cycle, only will be evaluated children of this container.
2382     *
2383     * @param obj The container object
2384     * @param child The child to be added in custom chain
2385     * @param relative_child The relative object to position the child
2386     * @ingroup Focus
2387     */
2388    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2389
2390    /**
2391     * Prepend object to custom focus chain.
2392     *
2393     * @note If relative_child equal to NULL or not in custom chain, the object
2394     * will be added in begin.
2395     *
2396     * @note On focus cycle, only will be evaluated children of this container.
2397     *
2398     * @param obj The container object
2399     * @param child The child to be added in custom chain
2400     * @param relative_child The relative object to position the child
2401     * @ingroup Focus
2402     */
2403    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2404
2405    /**
2406     * Give focus to next object in object tree.
2407     *
2408     * Give focus to next object in focus chain of one object sub-tree.
2409     * If the last object of chain already have focus, the focus will go to the
2410     * first object of chain.
2411     *
2412     * @param obj The object root of sub-tree
2413     * @param dir Direction to cycle the focus
2414     *
2415     * @ingroup Focus
2416     */
2417    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2418
2419    /**
2420     * Give focus to near object in one direction.
2421     *
2422     * Give focus to near object in direction of one object.
2423     * If none focusable object in given direction, the focus will not change.
2424     *
2425     * @param obj The reference object
2426     * @param x Horizontal component of direction to focus
2427     * @param y Vertical component of direction to focus
2428     *
2429     * @ingroup Focus
2430     */
2431    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2432
2433    /**
2434     * Make the elementary object and its children to be unfocusable
2435     * (or focusable).
2436     *
2437     * @param obj The Elementary object to operate on
2438     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2439     *        @c EINA_FALSE for focusable.
2440     *
2441     * This sets whether the object @p obj and its children objects
2442     * are able to take focus or not. If the tree is set as unfocusable,
2443     * newest focused object which is not in this tree will get focus.
2444     * This API can be helpful for an object to be deleted.
2445     * When an object will be deleted soon, it and its children may not
2446     * want to get focus (by focus reverting or by other focus controls).
2447     * Then, just use this API before deleting.
2448     *
2449     * @see elm_object_tree_unfocusable_get()
2450     *
2451     * @ingroup Focus
2452     */
2453    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2454
2455    /**
2456     * Get whether an Elementary object and its children are unfocusable or not.
2457     *
2458     * @param obj The Elementary object to get the information from
2459     * @return @c EINA_TRUE, if the tree is unfocussable,
2460     *         @c EINA_FALSE if not (and on errors).
2461     *
2462     * @see elm_object_tree_unfocusable_set()
2463     *
2464     * @ingroup Focus
2465     */
2466    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2467
2468    /**
2469     * @defgroup Scrolling Scrolling
2470     *
2471     * These are functions setting how scrollable views in Elementary
2472     * widgets should behave on user interaction.
2473     *
2474     * @{
2475     */
2476
2477    /**
2478     * Get whether scrollers should bounce when they reach their
2479     * viewport's edge during a scroll.
2480     *
2481     * @return the thumb scroll bouncing state
2482     *
2483     * This is the default behavior for touch screens, in general.
2484     * @ingroup Scrolling
2485     */
2486    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2487
2488    /**
2489     * Set whether scrollers should bounce when they reach their
2490     * viewport's edge during a scroll.
2491     *
2492     * @param enabled the thumb scroll bouncing state
2493     *
2494     * @see elm_thumbscroll_bounce_enabled_get()
2495     * @ingroup Scrolling
2496     */
2497    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2498
2499    /**
2500     * Set whether scrollers should bounce when they reach their
2501     * viewport's edge during a scroll, for all Elementary application
2502     * windows.
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_all_set(Eina_Bool enabled);
2510
2511    /**
2512     * Get the amount of inertia a scroller will impose at bounce
2513     * animations.
2514     *
2515     * @return the thumb scroll bounce friction
2516     *
2517     * @ingroup Scrolling
2518     */
2519    EAPI double           elm_scroll_bounce_friction_get(void);
2520
2521    /**
2522     * Set the amount of inertia a scroller will impose at bounce
2523     * animations.
2524     *
2525     * @param friction the thumb scroll bounce friction
2526     *
2527     * @see elm_thumbscroll_bounce_friction_get()
2528     * @ingroup Scrolling
2529     */
2530    EAPI void             elm_scroll_bounce_friction_set(double friction);
2531
2532    /**
2533     * Set the amount of inertia a scroller will impose at bounce
2534     * animations, for all Elementary application windows.
2535     *
2536     * @param friction the thumb scroll bounce friction
2537     *
2538     * @see elm_thumbscroll_bounce_friction_get()
2539     * @ingroup Scrolling
2540     */
2541    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2542
2543    /**
2544     * Get the amount of inertia a <b>paged</b> scroller will impose at
2545     * page fitting animations.
2546     *
2547     * @return the page scroll friction
2548     *
2549     * @ingroup Scrolling
2550     */
2551    EAPI double           elm_scroll_page_scroll_friction_get(void);
2552
2553    /**
2554     * Set the amount of inertia a <b>paged</b> scroller will impose at
2555     * page fitting animations.
2556     *
2557     * @param friction the page scroll friction
2558     *
2559     * @see elm_thumbscroll_page_scroll_friction_get()
2560     * @ingroup Scrolling
2561     */
2562    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2563
2564    /**
2565     * Set the amount of inertia a <b>paged</b> scroller will impose at
2566     * page fitting animations, for all Elementary application windows.
2567     *
2568     * @param friction the page scroll friction
2569     *
2570     * @see elm_thumbscroll_page_scroll_friction_get()
2571     * @ingroup Scrolling
2572     */
2573    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2574
2575    /**
2576     * Get the amount of inertia a scroller will impose at region bring
2577     * animations.
2578     *
2579     * @return the bring in scroll friction
2580     *
2581     * @ingroup Scrolling
2582     */
2583    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2584
2585    /**
2586     * Set the amount of inertia a scroller will impose at region bring
2587     * animations.
2588     *
2589     * @param friction the bring in scroll friction
2590     *
2591     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2592     * @ingroup Scrolling
2593     */
2594    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2595
2596    /**
2597     * Set the amount of inertia a scroller will impose at region bring
2598     * animations, for all Elementary application windows.
2599     *
2600     * @param friction the bring in scroll friction
2601     *
2602     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2603     * @ingroup Scrolling
2604     */
2605    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2606
2607    /**
2608     * Get the amount of inertia scrollers will impose at animations
2609     * triggered by Elementary widgets' zooming API.
2610     *
2611     * @return the zoom friction
2612     *
2613     * @ingroup Scrolling
2614     */
2615    EAPI double           elm_scroll_zoom_friction_get(void);
2616
2617    /**
2618     * Set the amount of inertia scrollers will impose at animations
2619     * triggered by Elementary widgets' zooming API.
2620     *
2621     * @param friction the zoom friction
2622     *
2623     * @see elm_thumbscroll_zoom_friction_get()
2624     * @ingroup Scrolling
2625     */
2626    EAPI void             elm_scroll_zoom_friction_set(double friction);
2627
2628    /**
2629     * Set the amount of inertia scrollers will impose at animations
2630     * triggered by Elementary widgets' zooming API, for all Elementary
2631     * application windows.
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_all_set(double friction);
2639
2640    /**
2641     * Get whether scrollers should be draggable from any point in their
2642     * views.
2643     *
2644     * @return the thumb scroll state
2645     *
2646     * @note This is the default behavior for touch screens, in general.
2647     * @note All other functions namespaced with "thumbscroll" will only
2648     *       have effect if this mode is enabled.
2649     *
2650     * @ingroup Scrolling
2651     */
2652    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2653
2654    /**
2655     * Set whether scrollers should be draggable from any point in their
2656     * views.
2657     *
2658     * @param enabled the thumb scroll state
2659     *
2660     * @see elm_thumbscroll_enabled_get()
2661     * @ingroup Scrolling
2662     */
2663    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2664
2665    /**
2666     * Set whether scrollers should be draggable from any point in their
2667     * views, for all Elementary application windows.
2668     *
2669     * @param enabled the thumb scroll state
2670     *
2671     * @see elm_thumbscroll_enabled_get()
2672     * @ingroup Scrolling
2673     */
2674    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2675
2676    /**
2677     * Get the number of pixels one should travel while dragging a
2678     * scroller's view to actually trigger scrolling.
2679     *
2680     * @return the thumb scroll threshould
2681     *
2682     * One would use higher values for touch screens, in general, because
2683     * of their inherent imprecision.
2684     * @ingroup Scrolling
2685     */
2686    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2687
2688    /**
2689     * Set the number of pixels one should travel while dragging a
2690     * scroller's view to actually trigger scrolling.
2691     *
2692     * @param threshold the thumb scroll threshould
2693     *
2694     * @see elm_thumbscroll_threshould_get()
2695     * @ingroup Scrolling
2696     */
2697    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2698
2699    /**
2700     * Set the number of pixels one should travel while dragging a
2701     * scroller's view to actually trigger scrolling, for all Elementary
2702     * application windows.
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_all_set(unsigned int threshold);
2710
2711    /**
2712     * Get the minimum speed of mouse cursor movement which will trigger
2713     * list self scrolling animation after a mouse up event
2714     * (pixels/second).
2715     *
2716     * @return the thumb scroll momentum threshould
2717     *
2718     * @ingroup Scrolling
2719     */
2720    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2721
2722    /**
2723     * Set the minimum speed of mouse cursor movement which will trigger
2724     * list self scrolling animation after a mouse up event
2725     * (pixels/second).
2726     *
2727     * @param threshold the thumb scroll momentum threshould
2728     *
2729     * @see elm_thumbscroll_momentum_threshould_get()
2730     * @ingroup Scrolling
2731     */
2732    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
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), for all Elementary application windows.
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_all_set(double threshold);
2745
2746    /**
2747     * Get the amount of inertia a scroller will impose at self scrolling
2748     * animations.
2749     *
2750     * @return the thumb scroll friction
2751     *
2752     * @ingroup Scrolling
2753     */
2754    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2755
2756    /**
2757     * Set the amount of inertia a scroller will impose at self scrolling
2758     * animations.
2759     *
2760     * @param friction the thumb scroll friction
2761     *
2762     * @see elm_thumbscroll_friction_get()
2763     * @ingroup Scrolling
2764     */
2765    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2766
2767    /**
2768     * Set the amount of inertia a scroller will impose at self scrolling
2769     * animations, for all Elementary application windows.
2770     *
2771     * @param friction the thumb scroll friction
2772     *
2773     * @see elm_thumbscroll_friction_get()
2774     * @ingroup Scrolling
2775     */
2776    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2777
2778    /**
2779     * Get the amount of lag between your actual mouse cursor dragging
2780     * movement and a scroller's view movement itself, while pushing it
2781     * into bounce state manually.
2782     *
2783     * @return the thumb scroll border friction
2784     *
2785     * @ingroup Scrolling
2786     */
2787    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2788
2789    /**
2790     * Set the amount of lag between your actual mouse cursor dragging
2791     * movement and a scroller's view movement itself, while pushing it
2792     * into bounce state manually.
2793     *
2794     * @param friction the thumb scroll border friction. @c 0.0 for
2795     *        perfect synchrony between two movements, @c 1.0 for maximum
2796     *        lag.
2797     *
2798     * @see elm_thumbscroll_border_friction_get()
2799     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2800     *
2801     * @ingroup Scrolling
2802     */
2803    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2804
2805    /**
2806     * Set the amount of lag between your actual mouse cursor dragging
2807     * movement and a scroller's view movement itself, while pushing it
2808     * into bounce state manually, for all Elementary application windows.
2809     *
2810     * @param friction the thumb scroll border friction. @c 0.0 for
2811     *        perfect synchrony between two movements, @c 1.0 for maximum
2812     *        lag.
2813     *
2814     * @see elm_thumbscroll_border_friction_get()
2815     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2816     *
2817     * @ingroup Scrolling
2818     */
2819    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2820
2821    /**
2822     * @}
2823     */
2824
2825    /**
2826     * @defgroup Scrollhints Scrollhints
2827     *
2828     * Objects when inside a scroller can scroll, but this may not always be
2829     * desirable in certain situations. This allows an object to hint to itself
2830     * and parents to "not scroll" in one of 2 ways. If any child object of a
2831     * scroller has pushed a scroll freeze or hold then it affects all parent
2832     * scrollers until all children have released them.
2833     *
2834     * 1. To hold on scrolling. This means just flicking and dragging may no
2835     * longer scroll, but pressing/dragging near an edge of the scroller will
2836     * still scroll. This is automatically used by the entry object when
2837     * selecting text.
2838     *
2839     * 2. To totally freeze scrolling. This means it stops. until
2840     * popped/released.
2841     *
2842     * @{
2843     */
2844
2845    /**
2846     * Push the scroll hold by 1
2847     *
2848     * This increments the scroll hold count by one. If it is more than 0 it will
2849     * take effect on the parents of the indicated object.
2850     *
2851     * @param obj The object
2852     * @ingroup Scrollhints
2853     */
2854    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2855
2856    /**
2857     * Pop the scroll hold by 1
2858     *
2859     * This decrements the scroll hold count by one. If it is more than 0 it will
2860     * take effect on the parents of the indicated object.
2861     *
2862     * @param obj The object
2863     * @ingroup Scrollhints
2864     */
2865    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2866
2867    /**
2868     * Push the scroll freeze by 1
2869     *
2870     * This increments the scroll freeze count by one. If it is more
2871     * than 0 it will take effect on the parents of the indicated
2872     * object.
2873     *
2874     * @param obj The object
2875     * @ingroup Scrollhints
2876     */
2877    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2878
2879    /**
2880     * Pop the scroll freeze by 1
2881     *
2882     * This decrements 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_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2890
2891    /**
2892     * Lock the scrolling of the given widget (and thus all parents)
2893     *
2894     * This locks the given object from scrolling in the X axis (and implicitly
2895     * also locks all parent scrollers too from doing the same).
2896     *
2897     * @param obj The object
2898     * @param lock The lock state (1 == locked, 0 == unlocked)
2899     * @ingroup Scrollhints
2900     */
2901    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) 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 Y 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_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2914
2915    /**
2916     * Get the scrolling lock of the given widget
2917     *
2918     * This gets the lock for X axis scrolling.
2919     *
2920     * @param obj The object
2921     * @ingroup Scrollhints
2922     */
2923    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2924
2925    /**
2926     * Get the scrolling lock of the given widget
2927     *
2928     * This gets the lock for X axis scrolling.
2929     *
2930     * @param obj The object
2931     * @ingroup Scrollhints
2932     */
2933    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2934
2935    /**
2936     * @}
2937     */
2938
2939    /**
2940     * Send a signal to the widget edje object.
2941     *
2942     * This function sends a signal to the edje object of the obj. An
2943     * edje program can respond to a signal by specifying matching
2944     * 'signal' and 'source' fields.
2945     *
2946     * @param obj The object
2947     * @param emission The signal's name.
2948     * @param source The signal's source.
2949     * @ingroup General
2950     */
2951    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2952
2953    /**
2954     * Add a callback for a signal emitted by widget edje object.
2955     *
2956     * This function connects a callback function to a signal emitted by the
2957     * edje object of the obj.
2958     * Globs can occur in either the emission or source name.
2959     *
2960     * @param obj The object
2961     * @param emission The signal's name.
2962     * @param source The signal's source.
2963     * @param func The callback function to be executed when the signal is
2964     * emitted.
2965     * @param data A pointer to data to pass in to the callback function.
2966     * @ingroup General
2967     */
2968    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);
2969
2970    /**
2971     * Remove a signal-triggered callback from a widget edje object.
2972     *
2973     * This function removes a callback, previoulsy attached to a
2974     * signal emitted by the edje object of the obj.  The parameters
2975     * emission, source and func must match exactly those passed to a
2976     * previous call to elm_object_signal_callback_add(). The data
2977     * pointer that was passed to this call will be returned.
2978     *
2979     * @param obj The object
2980     * @param emission The signal's name.
2981     * @param source The signal's source.
2982     * @param func The callback function to be executed when the signal is
2983     * emitted.
2984     * @return The data pointer
2985     * @ingroup General
2986     */
2987    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);
2988
2989    /**
2990     * Add a callback for input events (key up, key down, mouse wheel)
2991     * on a given Elementary widget
2992     *
2993     * @param obj The widget to add an event callback on
2994     * @param func The callback function to be executed when the event
2995     * happens
2996     * @param data Data to pass in to @p func
2997     *
2998     * Every widget in an Elementary interface set to receive focus,
2999     * with elm_object_focus_allow_set(), will propagate @b all of its
3000     * key up, key down and mouse wheel input events up to its parent
3001     * object, and so on. All of the focusable ones in this chain which
3002     * had an event callback set, with this call, will be able to treat
3003     * those events. There are two ways of making the propagation of
3004     * these event upwards in the tree of widgets to @b cease:
3005     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3006     *   the event was @b not processed, so the propagation will go on.
3007     * - The @c event_info pointer passed to @p func will contain the
3008     *   event's structure and, if you OR its @c event_flags inner
3009     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3010     *   one has already handled it, thus killing the event's
3011     *   propagation, too.
3012     *
3013     * @note Your event callback will be issued on those events taking
3014     * place only if no other child widget of @obj has consumed the
3015     * event already.
3016     *
3017     * @note Not to be confused with @c
3018     * evas_object_event_callback_add(), which will add event callbacks
3019     * per type on general Evas objects (no event propagation
3020     * infrastructure taken in account).
3021     *
3022     * @note Not to be confused with @c
3023     * elm_object_signal_callback_add(), which will add callbacks to @b
3024     * signals coming from a widget's theme, not input events.
3025     *
3026     * @note Not to be confused with @c
3027     * edje_object_signal_callback_add(), which does the same as
3028     * elm_object_signal_callback_add(), but directly on an Edje
3029     * object.
3030     *
3031     * @note Not to be confused with @c
3032     * evas_object_smart_callback_add(), which adds callbacks to smart
3033     * objects' <b>smart events</b>, and not input events.
3034     *
3035     * @see elm_object_event_callback_del()
3036     *
3037     * @ingroup General
3038     */
3039    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3040
3041    /**
3042     * Remove an event callback from a widget.
3043     *
3044     * This function removes a callback, previoulsy attached to event emission
3045     * by the @p obj.
3046     * The parameters func and data must match exactly those passed to
3047     * a previous call to elm_object_event_callback_add(). The data pointer that
3048     * was passed to this call will be returned.
3049     *
3050     * @param obj The object
3051     * @param func The callback function to be executed when the event is
3052     * emitted.
3053     * @param data Data to pass in to the callback function.
3054     * @return The data pointer
3055     * @ingroup General
3056     */
3057    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3058
3059    /**
3060     * Adjust size of an element for finger usage.
3061     *
3062     * @param times_w How many fingers should fit horizontally
3063     * @param w Pointer to the width size to adjust
3064     * @param times_h How many fingers should fit vertically
3065     * @param h Pointer to the height size to adjust
3066     *
3067     * This takes width and height sizes (in pixels) as input and a
3068     * size multiple (which is how many fingers you want to place
3069     * within the area, being "finger" the size set by
3070     * elm_finger_size_set()), and adjusts the size to be large enough
3071     * to accommodate the resulting size -- if it doesn't already
3072     * accommodate it. On return the @p w and @p h sizes pointed to by
3073     * these parameters will be modified, on those conditions.
3074     *
3075     * @note This is kind of a low level Elementary call, most useful
3076     * on size evaluation times for widgets. An external user wouldn't
3077     * be calling, most of the time.
3078     *
3079     * @ingroup Fingers
3080     */
3081    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3082
3083    /**
3084     * Get the duration for occuring long press event.
3085     *
3086     * @return Timeout for long press event
3087     * @ingroup Longpress
3088     */
3089    EAPI double           elm_longpress_timeout_get(void);
3090
3091    /**
3092     * Set the duration for occuring long press event.
3093     *
3094     * @param lonpress_timeout Timeout for long press event
3095     * @ingroup Longpress
3096     */
3097    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3098
3099    /**
3100     * @defgroup Debug Debug
3101     * don't use it unless you are sure
3102     *
3103     * @{
3104     */
3105
3106    /**
3107     * Print Tree object hierarchy in stdout
3108     *
3109     * @param obj The root object
3110     * @ingroup Debug
3111     */
3112    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3113
3114    /**
3115     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3116     *
3117     * @param obj The root object
3118     * @param file The path of output file
3119     * @ingroup Debug
3120     */
3121    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3122
3123    /**
3124     * @}
3125     */
3126
3127    /**
3128     * @defgroup Theme Theme
3129     *
3130     * Elementary uses Edje to theme its widgets, naturally. But for the most
3131     * part this is hidden behind a simpler interface that lets the user set
3132     * extensions and choose the style of widgets in a much easier way.
3133     *
3134     * Instead of thinking in terms of paths to Edje files and their groups
3135     * each time you want to change the appearance of a widget, Elementary
3136     * works so you can add any theme file with extensions or replace the
3137     * main theme at one point in the application, and then just set the style
3138     * of widgets with elm_object_style_set() and related functions. Elementary
3139     * will then look in its list of themes for a matching group and apply it,
3140     * and when the theme changes midway through the application, all widgets
3141     * will be updated accordingly.
3142     *
3143     * There are three concepts you need to know to understand how Elementary
3144     * theming works: default theme, extensions and overlays.
3145     *
3146     * Default theme, obviously enough, is the one that provides the default
3147     * look of all widgets. End users can change the theme used by Elementary
3148     * by setting the @c ELM_THEME environment variable before running an
3149     * application, or globally for all programs using the @c elementary_config
3150     * utility. Applications can change the default theme using elm_theme_set(),
3151     * but this can go against the user wishes, so it's not an adviced practice.
3152     *
3153     * Ideally, applications should find everything they need in the already
3154     * provided theme, but there may be occasions when that's not enough and
3155     * custom styles are required to correctly express the idea. For this
3156     * cases, Elementary has extensions.
3157     *
3158     * Extensions allow the application developer to write styles of its own
3159     * to apply to some widgets. This requires knowledge of how each widget
3160     * is themed, as extensions will always replace the entire group used by
3161     * the widget, so important signals and parts need to be there for the
3162     * object to behave properly (see documentation of Edje for details).
3163     * Once the theme for the extension is done, the application needs to add
3164     * it to the list of themes Elementary will look into, using
3165     * elm_theme_extension_add(), and set the style of the desired widgets as
3166     * he would normally with elm_object_style_set().
3167     *
3168     * Overlays, on the other hand, can replace the look of all widgets by
3169     * overriding the default style. Like extensions, it's up to the application
3170     * developer to write the theme for the widgets it wants, the difference
3171     * being that when looking for the theme, Elementary will check first the
3172     * list of overlays, then the set theme and lastly the list of extensions,
3173     * so with overlays it's possible to replace the default view and every
3174     * widget will be affected. This is very much alike to setting the whole
3175     * theme for the application and will probably clash with the end user
3176     * options, not to mention the risk of ending up with not matching styles
3177     * across the program. Unless there's a very special reason to use them,
3178     * overlays should be avoided for the resons exposed before.
3179     *
3180     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3181     * keeps one default internally and every function that receives one of
3182     * these can be called with NULL to refer to this default (except for
3183     * elm_theme_free()). It's possible to create a new instance of a
3184     * ::Elm_Theme to set other theme for a specific widget (and all of its
3185     * children), but this is as discouraged, if not even more so, than using
3186     * overlays. Don't use this unless you really know what you are doing.
3187     *
3188     * But to be less negative about things, you can look at the following
3189     * examples:
3190     * @li @ref theme_example_01 "Using extensions"
3191     * @li @ref theme_example_02 "Using overlays"
3192     *
3193     * @{
3194     */
3195    /**
3196     * @typedef Elm_Theme
3197     *
3198     * Opaque handler for the list of themes Elementary looks for when
3199     * rendering widgets.
3200     *
3201     * Stay out of this unless you really know what you are doing. For most
3202     * cases, sticking to the default is all a developer needs.
3203     */
3204    typedef struct _Elm_Theme Elm_Theme;
3205
3206    /**
3207     * Create a new specific theme
3208     *
3209     * This creates an empty specific theme that only uses the default theme. A
3210     * specific theme has its own private set of extensions and overlays too
3211     * (which are empty by default). Specific themes do not fall back to themes
3212     * of parent objects. They are not intended for this use. Use styles, overlays
3213     * and extensions when needed, but avoid specific themes unless there is no
3214     * other way (example: you want to have a preview of a new theme you are
3215     * selecting in a "theme selector" window. The preview is inside a scroller
3216     * and should display what the theme you selected will look like, but not
3217     * actually apply it yet. The child of the scroller will have a specific
3218     * theme set to show this preview before the user decides to apply it to all
3219     * applications).
3220     */
3221    EAPI Elm_Theme       *elm_theme_new(void);
3222    /**
3223     * Free a specific theme
3224     *
3225     * @param th The theme to free
3226     *
3227     * This frees a theme created with elm_theme_new().
3228     */
3229    EAPI void             elm_theme_free(Elm_Theme *th);
3230    /**
3231     * Copy the theme fom the source to the destination theme
3232     *
3233     * @param th The source theme to copy from
3234     * @param thdst The destination theme to copy data to
3235     *
3236     * This makes a one-time static copy of all the theme config, extensions
3237     * and overlays from @p th to @p thdst. If @p th references a theme, then
3238     * @p thdst is also set to reference it, with all the theme settings,
3239     * overlays and extensions that @p th had.
3240     */
3241    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3242    /**
3243     * Tell the source theme to reference the ref theme
3244     *
3245     * @param th The theme that will do the referencing
3246     * @param thref The theme that is the reference source
3247     *
3248     * This clears @p th to be empty and then sets it to refer to @p thref
3249     * so @p th acts as an override to @p thref, but where its overrides
3250     * don't apply, it will fall through to @p thref for configuration.
3251     */
3252    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3253    /**
3254     * Return the theme referred to
3255     *
3256     * @param th The theme to get the reference from
3257     * @return The referenced theme handle
3258     *
3259     * This gets the theme set as the reference theme by elm_theme_ref_set().
3260     * If no theme is set as a reference, NULL is returned.
3261     */
3262    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3263    /**
3264     * Return the default theme
3265     *
3266     * @return The default theme handle
3267     *
3268     * This returns the internal default theme setup handle that all widgets
3269     * use implicitly unless a specific theme is set. This is also often use
3270     * as a shorthand of NULL.
3271     */
3272    EAPI Elm_Theme       *elm_theme_default_get(void);
3273    /**
3274     * Prepends a theme overlay to the list of overlays
3275     *
3276     * @param th The theme to add to, or if NULL, the default theme
3277     * @param item The Edje file path to be used
3278     *
3279     * Use this if your application needs to provide some custom overlay theme
3280     * (An Edje file that replaces some default styles of widgets) where adding
3281     * new styles, or changing system theme configuration is not possible. Do
3282     * NOT use this instead of a proper system theme configuration. Use proper
3283     * configuration files, profiles, environment variables etc. to set a theme
3284     * so that the theme can be altered by simple confiugration by a user. Using
3285     * this call to achieve that effect is abusing the API and will create lots
3286     * of trouble.
3287     *
3288     * @see elm_theme_extension_add()
3289     */
3290    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3291    /**
3292     * Delete a theme overlay from the list of overlays
3293     *
3294     * @param th The theme to delete from, or if NULL, the default theme
3295     * @param item The name of the theme overlay
3296     *
3297     * @see elm_theme_overlay_add()
3298     */
3299    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3300    /**
3301     * Appends a theme extension to the list of extensions.
3302     *
3303     * @param th The theme to add to, or if NULL, the default theme
3304     * @param item The Edje file path to be used
3305     *
3306     * This is intended when an application needs more styles of widgets or new
3307     * widget themes that the default does not provide (or may not provide). The
3308     * application has "extended" usage by coming up with new custom style names
3309     * for widgets for specific uses, but as these are not "standard", they are
3310     * not guaranteed to be provided by a default theme. This means the
3311     * application is required to provide these extra elements itself in specific
3312     * Edje files. This call adds one of those Edje files to the theme search
3313     * path to be search after the default theme. The use of this call is
3314     * encouraged when default styles do not meet the needs of the application.
3315     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3316     *
3317     * @see elm_object_style_set()
3318     */
3319    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3320    /**
3321     * Deletes a theme extension from the list of extensions.
3322     *
3323     * @param th The theme to delete from, or if NULL, the default theme
3324     * @param item The name of the theme extension
3325     *
3326     * @see elm_theme_extension_add()
3327     */
3328    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3329    /**
3330     * Set the theme search order for the given theme
3331     *
3332     * @param th The theme to set the search order, or if NULL, the default theme
3333     * @param theme Theme search string
3334     *
3335     * This sets the search string for the theme in path-notation from first
3336     * theme to search, to last, delimited by the : character. Example:
3337     *
3338     * "shiny:/path/to/file.edj:default"
3339     *
3340     * See the ELM_THEME environment variable for more information.
3341     *
3342     * @see elm_theme_get()
3343     * @see elm_theme_list_get()
3344     */
3345    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3346    /**
3347     * Return the theme search order
3348     *
3349     * @param th The theme to get the search order, or if NULL, the default theme
3350     * @return The internal search order path
3351     *
3352     * This function returns a colon separated string of theme elements as
3353     * returned by elm_theme_list_get().
3354     *
3355     * @see elm_theme_set()
3356     * @see elm_theme_list_get()
3357     */
3358    EAPI const char      *elm_theme_get(Elm_Theme *th);
3359    /**
3360     * Return a list of theme elements to be used in a theme.
3361     *
3362     * @param th Theme to get the list of theme elements from.
3363     * @return The internal list of theme elements
3364     *
3365     * This returns the internal list of theme elements (will only be valid as
3366     * long as the theme is not modified by elm_theme_set() or theme is not
3367     * freed by elm_theme_free(). This is a list of strings which must not be
3368     * altered as they are also internal. If @p th is NULL, then the default
3369     * theme element list is returned.
3370     *
3371     * A theme element can consist of a full or relative path to a .edj file,
3372     * or a name, without extension, for a theme to be searched in the known
3373     * theme paths for Elemementary.
3374     *
3375     * @see elm_theme_set()
3376     * @see elm_theme_get()
3377     */
3378    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3379    /**
3380     * Return the full patrh for a theme element
3381     *
3382     * @param f The theme element name
3383     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3384     * @return The full path to the file found.
3385     *
3386     * This returns a string you should free with free() on success, NULL on
3387     * failure. This will search for the given theme element, and if it is a
3388     * full or relative path element or a simple searchable name. The returned
3389     * path is the full path to the file, if searched, and the file exists, or it
3390     * is simply the full path given in the element or a resolved path if
3391     * relative to home. The @p in_search_path boolean pointed to is set to
3392     * EINA_TRUE if the file was a searchable file andis in the search path,
3393     * and EINA_FALSE otherwise.
3394     */
3395    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3396    /**
3397     * Flush the current theme.
3398     *
3399     * @param th Theme to flush
3400     *
3401     * This flushes caches that let elementary know where to find theme elements
3402     * in the given theme. If @p th is NULL, then the default theme is flushed.
3403     * Call this function if source theme data has changed in such a way as to
3404     * make any caches Elementary kept invalid.
3405     */
3406    EAPI void             elm_theme_flush(Elm_Theme *th);
3407    /**
3408     * This flushes all themes (default and specific ones).
3409     *
3410     * This will flush all themes in the current application context, by calling
3411     * elm_theme_flush() on each of them.
3412     */
3413    EAPI void             elm_theme_full_flush(void);
3414    /**
3415     * Set the theme for all elementary using applications on the current display
3416     *
3417     * @param theme The name of the theme to use. Format same as the ELM_THEME
3418     * environment variable.
3419     */
3420    EAPI void             elm_theme_all_set(const char *theme);
3421    /**
3422     * Return a list of theme elements in the theme search path
3423     *
3424     * @return A list of strings that are the theme element names.
3425     *
3426     * This lists all available theme files in the standard Elementary search path
3427     * for theme elements, and returns them in alphabetical order as theme
3428     * element names in a list of strings. Free this with
3429     * elm_theme_name_available_list_free() when you are done with the list.
3430     */
3431    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3432    /**
3433     * Free the list returned by elm_theme_name_available_list_new()
3434     *
3435     * This frees the list of themes returned by
3436     * elm_theme_name_available_list_new(). Once freed the list should no longer
3437     * be used. a new list mys be created.
3438     */
3439    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3440    /**
3441     * Set a specific theme to be used for this object and its children
3442     *
3443     * @param obj The object to set the theme on
3444     * @param th The theme to set
3445     *
3446     * This sets a specific theme that will be used for the given object and any
3447     * child objects it has. If @p th is NULL then the theme to be used is
3448     * cleared and the object will inherit its theme from its parent (which
3449     * ultimately will use the default theme if no specific themes are set).
3450     *
3451     * Use special themes with great care as this will annoy users and make
3452     * configuration difficult. Avoid any custom themes at all if it can be
3453     * helped.
3454     */
3455    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3456    /**
3457     * Get the specific theme to be used
3458     *
3459     * @param obj The object to get the specific theme from
3460     * @return The specifc theme set.
3461     *
3462     * This will return a specific theme set, or NULL if no specific theme is
3463     * set on that object. It will not return inherited themes from parents, only
3464     * the specific theme set for that specific object. See elm_object_theme_set()
3465     * for more information.
3466     */
3467    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3468
3469    /**
3470     * Get a data item from a theme
3471     *
3472     * @param th The theme, or NULL for default theme
3473     * @param key The data key to search with
3474     * @return The data value, or NULL on failure
3475     *
3476     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3477     * It works the same way as edje_file_data_get() except that the return is stringshared.
3478     */
3479    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3480    /**
3481     * @}
3482     */
3483
3484    /* win */
3485    /** @defgroup Win Win
3486     *
3487     * @image html img/widget/win/preview-00.png
3488     * @image latex img/widget/win/preview-00.eps
3489     *
3490     * The window class of Elementary.  Contains functions to manipulate
3491     * windows. The Evas engine used to render the window contents is specified
3492     * in the system or user elementary config files (whichever is found last),
3493     * and can be overridden with the ELM_ENGINE environment variable for
3494     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3495     * compilation setup and modules actually installed at runtime) are (listed
3496     * in order of best supported and most likely to be complete and work to
3497     * lowest quality).
3498     *
3499     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3500     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3501     * rendering in X11)
3502     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3503     * exits)
3504     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3505     * rendering)
3506     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3507     * buffer)
3508     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3509     * rendering using SDL as the buffer)
3510     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3511     * GDI with software)
3512     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3513     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3514     * grayscale using dedicated 8bit software engine in X11)
3515     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3516     * X11 using 16bit software engine)
3517     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3518     * (Windows CE rendering via GDI with 16bit software renderer)
3519     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3520     * buffer with 16bit software renderer)
3521     *
3522     * All engines use a simple string to select the engine to render, EXCEPT
3523     * the "shot" engine. This actually encodes the output of the virtual
3524     * screenshot and how long to delay in the engine string. The engine string
3525     * is encoded in the following way:
3526     *
3527     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3528     *
3529     * Where options are separated by a ":" char if more than one option is
3530     * given, with delay, if provided being the first option and file the last
3531     * (order is important). The delay specifies how long to wait after the
3532     * window is shown before doing the virtual "in memory" rendering and then
3533     * save the output to the file specified by the file option (and then exit).
3534     * If no delay is given, the default is 0.5 seconds. If no file is given the
3535     * default output file is "out.png". Repeat option is for continous
3536     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3537     * fixed to "out001.png" Some examples of using the shot engine:
3538     *
3539     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3540     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3541     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3542     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3543     *   ELM_ENGINE="shot:" elementary_test
3544     *
3545     * Signals that you can add callbacks for are:
3546     *
3547     * @li "delete,request": the user requested to close the window. See
3548     * elm_win_autodel_set().
3549     * @li "focus,in": window got focus
3550     * @li "focus,out": window lost focus
3551     * @li "moved": window that holds the canvas was moved
3552     *
3553     * Examples:
3554     * @li @ref win_example_01
3555     *
3556     * @{
3557     */
3558    /**
3559     * Defines the types of window that can be created
3560     *
3561     * These are hints set on the window so that a running Window Manager knows
3562     * how the window should be handled and/or what kind of decorations it
3563     * should have.
3564     *
3565     * Currently, only the X11 backed engines use them.
3566     */
3567    typedef enum _Elm_Win_Type
3568      {
3569         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3570                          window. Almost every window will be created with this
3571                          type. */
3572         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3573         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3574                            window holding desktop icons. */
3575         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3576                         be kept on top of any other window by the Window
3577                         Manager. */
3578         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3579                            similar. */
3580         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3581         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3582                            pallete. */
3583         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3584         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3585                                  entry in a menubar is clicked. Typically used
3586                                  with elm_win_override_set(). This hint exists
3587                                  for completion only, as the EFL way of
3588                                  implementing a menu would not normally use a
3589                                  separate window for its contents. */
3590         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3591                               triggered by right-clicking an object. */
3592         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3593                            explanatory text that typically appear after the
3594                            mouse cursor hovers over an object for a while.
3595                            Typically used with elm_win_override_set() and also
3596                            not very commonly used in the EFL. */
3597         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3598                                 battery life or a new E-Mail received. */
3599         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3600                          usually used in the EFL. */
3601         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3602                        object being dragged across different windows, or even
3603                        applications. Typically used with
3604                        elm_win_override_set(). */
3605         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3606                                  buffer. No actual window is created for this
3607                                  type, instead the window and all of its
3608                                  contents will be rendered to an image buffer.
3609                                  This allows to have children window inside a
3610                                  parent one just like any other object would
3611                                  be, and do other things like applying @c
3612                                  Evas_Map effects to it. This is the only type
3613                                  of window that requires the @c parent
3614                                  parameter of elm_win_add() to be a valid @c
3615                                  Evas_Object. */
3616      } Elm_Win_Type;
3617
3618    /**
3619     * The differents layouts that can be requested for the virtual keyboard.
3620     *
3621     * When the application window is being managed by Illume, it may request
3622     * any of the following layouts for the virtual keyboard.
3623     */
3624    typedef enum _Elm_Win_Keyboard_Mode
3625      {
3626         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3627         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3628         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3629         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3630         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3631         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3632         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3633         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3634         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3635         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3636         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3637         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3638         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3639         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3640         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3641         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3642      } Elm_Win_Keyboard_Mode;
3643
3644    /**
3645     * Available commands that can be sent to the Illume manager.
3646     *
3647     * When running under an Illume session, a window may send commands to the
3648     * Illume manager to perform different actions.
3649     */
3650    typedef enum _Elm_Illume_Command
3651      {
3652         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3653                                          window */
3654         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3655                                             in the list */
3656         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3657                                          screen */
3658         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3659      } Elm_Illume_Command;
3660
3661    /**
3662     * Adds a window object. If this is the first window created, pass NULL as
3663     * @p parent.
3664     *
3665     * @param parent Parent object to add the window to, or NULL
3666     * @param name The name of the window
3667     * @param type The window type, one of #Elm_Win_Type.
3668     *
3669     * The @p parent paramter can be @c NULL for every window @p type except
3670     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3671     * which the image object will be created.
3672     *
3673     * @return The created object, or NULL on failure
3674     */
3675    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3676    /**
3677     * Add @p subobj as a resize object of window @p obj.
3678     *
3679     *
3680     * Setting an object as a resize object of the window means that the
3681     * @p subobj child's size and position will be controlled by the window
3682     * directly. That is, the object will be resized to match the window size
3683     * and should never be moved or resized manually by the developer.
3684     *
3685     * In addition, resize objects of the window control what the minimum size
3686     * of it will be, as well as whether it can or not be resized by the user.
3687     *
3688     * For the end user to be able to resize a window by dragging the handles
3689     * or borders provided by the Window Manager, or using any other similar
3690     * mechanism, all of the resize objects in the window should have their
3691     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3692     *
3693     * @param obj The window object
3694     * @param subobj The resize object to add
3695     */
3696    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3697    /**
3698     * Delete @p subobj as a resize object of window @p obj.
3699     *
3700     * This function removes the object @p subobj from the resize objects of
3701     * the window @p obj. It will not delete the object itself, which will be
3702     * left unmanaged and should be deleted by the developer, manually handled
3703     * or set as child of some other container.
3704     *
3705     * @param obj The window object
3706     * @param subobj The resize object to add
3707     */
3708    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3709    /**
3710     * Set the title of the window
3711     *
3712     * @param obj The window object
3713     * @param title The title to set
3714     */
3715    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3716    /**
3717     * Get the title of the window
3718     *
3719     * The returned string is an internal one and should not be freed or
3720     * modified. It will also be rendered invalid if a new title is set or if
3721     * the window is destroyed.
3722     *
3723     * @param obj The window object
3724     * @return The title
3725     */
3726    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3727    /**
3728     * Set the window's autodel state.
3729     *
3730     * When closing the window in any way outside of the program control, like
3731     * pressing the X button in the titlebar or using a command from the
3732     * Window Manager, a "delete,request" signal is emitted to indicate that
3733     * this event occurred and the developer can take any action, which may
3734     * include, or not, destroying the window object.
3735     *
3736     * When the @p autodel parameter is set, the window will be automatically
3737     * destroyed when this event occurs, after the signal is emitted.
3738     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3739     * and is up to the program to do so when it's required.
3740     *
3741     * @param obj The window object
3742     * @param autodel If true, the window will automatically delete itself when
3743     * closed
3744     */
3745    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3746    /**
3747     * Get the window's autodel state.
3748     *
3749     * @param obj The window object
3750     * @return If the window will automatically delete itself when closed
3751     *
3752     * @see elm_win_autodel_set()
3753     */
3754    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3755    /**
3756     * Activate a window object.
3757     *
3758     * This function sends a request to the Window Manager to activate the
3759     * window pointed by @p obj. If honored by the WM, the window will receive
3760     * the keyboard focus.
3761     *
3762     * @note This is just a request that a Window Manager may ignore, so calling
3763     * this function does not ensure in any way that the window will be the
3764     * active one after it.
3765     *
3766     * @param obj The window object
3767     */
3768    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3769    /**
3770     * Lower a window object.
3771     *
3772     * Places the window pointed by @p obj at the bottom of the stack, so that
3773     * no other window is covered by it.
3774     *
3775     * If elm_win_override_set() is not set, the Window Manager may ignore this
3776     * request.
3777     *
3778     * @param obj The window object
3779     */
3780    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3781    /**
3782     * Raise a window object.
3783     *
3784     * Places the window pointed by @p obj at the top of the stack, so that it's
3785     * not covered by any other window.
3786     *
3787     * If elm_win_override_set() is not set, the Window Manager may ignore this
3788     * request.
3789     *
3790     * @param obj The window object
3791     */
3792    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3793    /**
3794     * Set the borderless state of a window.
3795     *
3796     * This function requests the Window Manager to not draw any decoration
3797     * around the window.
3798     *
3799     * @param obj The window object
3800     * @param borderless If true, the window is borderless
3801     */
3802    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3803    /**
3804     * Get the borderless state of a window.
3805     *
3806     * @param obj The window object
3807     * @return If true, the window is borderless
3808     */
3809    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3810    /**
3811     * Set the shaped state of a window.
3812     *
3813     * Shaped windows, when supported, will render the parts of the window that
3814     * has no content, transparent.
3815     *
3816     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3817     * background object or cover the entire window in any other way, or the
3818     * parts of the canvas that have no data will show framebuffer artifacts.
3819     *
3820     * @param obj The window object
3821     * @param shaped If true, the window is shaped
3822     *
3823     * @see elm_win_alpha_set()
3824     */
3825    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3826    /**
3827     * Get the shaped state of a window.
3828     *
3829     * @param obj The window object
3830     * @return If true, the window is shaped
3831     *
3832     * @see elm_win_shaped_set()
3833     */
3834    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3835    /**
3836     * Set the alpha channel state of a window.
3837     *
3838     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3839     * possibly making parts of the window completely or partially transparent.
3840     * This is also subject to the underlying system supporting it, like for
3841     * example, running under a compositing manager. If no compositing is
3842     * available, enabling this option will instead fallback to using shaped
3843     * windows, with elm_win_shaped_set().
3844     *
3845     * @param obj The window object
3846     * @param alpha If true, the window has an alpha channel
3847     *
3848     * @see elm_win_alpha_set()
3849     */
3850    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3851    /**
3852     * Get the transparency state of a window.
3853     *
3854     * @param obj The window object
3855     * @return If true, the window is transparent
3856     *
3857     * @see elm_win_transparent_set()
3858     */
3859    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3860    /**
3861     * Set the transparency state of a window.
3862     *
3863     * Use elm_win_alpha_set() instead.
3864     *
3865     * @param obj The window object
3866     * @param transparent If true, the window is transparent
3867     *
3868     * @see elm_win_alpha_set()
3869     */
3870    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3871    /**
3872     * Get the alpha channel state of a window.
3873     *
3874     * @param obj The window object
3875     * @return If true, the window has an alpha channel
3876     */
3877    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3878    /**
3879     * Set the override state of a window.
3880     *
3881     * A window with @p override set to EINA_TRUE will not be managed by the
3882     * Window Manager. This means that no decorations of any kind will be shown
3883     * for it, moving and resizing must be handled by the application, as well
3884     * as the window visibility.
3885     *
3886     * This should not be used for normal windows, and even for not so normal
3887     * ones, it should only be used when there's a good reason and with a lot
3888     * of care. Mishandling override windows may result situations that
3889     * disrupt the normal workflow of the end user.
3890     *
3891     * @param obj The window object
3892     * @param override If true, the window is overridden
3893     */
3894    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3895    /**
3896     * Get the override state of a window.
3897     *
3898     * @param obj The window object
3899     * @return If true, the window is overridden
3900     *
3901     * @see elm_win_override_set()
3902     */
3903    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3904    /**
3905     * Set the fullscreen state of a window.
3906     *
3907     * @param obj The window object
3908     * @param fullscreen If true, the window is fullscreen
3909     */
3910    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3911    /**
3912     * Get the fullscreen state of a window.
3913     *
3914     * @param obj The window object
3915     * @return If true, the window is fullscreen
3916     */
3917    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3918    /**
3919     * Set the maximized state of a window.
3920     *
3921     * @param obj The window object
3922     * @param maximized If true, the window is maximized
3923     */
3924    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3925    /**
3926     * Get the maximized state of a window.
3927     *
3928     * @param obj The window object
3929     * @return If true, the window is maximized
3930     */
3931    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3932    /**
3933     * Set the iconified state of a window.
3934     *
3935     * @param obj The window object
3936     * @param iconified If true, the window is iconified
3937     */
3938    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3939    /**
3940     * Get the iconified state of a window.
3941     *
3942     * @param obj The window object
3943     * @return If true, the window is iconified
3944     */
3945    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3946    /**
3947     * Set the layer of the window.
3948     *
3949     * What this means exactly will depend on the underlying engine used.
3950     *
3951     * In the case of X11 backed engines, the value in @p layer has the
3952     * following meanings:
3953     * @li < 3: The window will be placed below all others.
3954     * @li > 5: The window will be placed above all others.
3955     * @li other: The window will be placed in the default layer.
3956     *
3957     * @param obj The window object
3958     * @param layer The layer of the window
3959     */
3960    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3961    /**
3962     * Get the layer of the window.
3963     *
3964     * @param obj The window object
3965     * @return The layer of the window
3966     *
3967     * @see elm_win_layer_set()
3968     */
3969    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3970    /**
3971     * Set the rotation of the window.
3972     *
3973     * Most engines only work with multiples of 90.
3974     *
3975     * This function is used to set the orientation of the window @p obj to
3976     * match that of the screen. The window itself will be resized to adjust
3977     * to the new geometry of its contents. If you want to keep the window size,
3978     * see elm_win_rotation_with_resize_set().
3979     *
3980     * @param obj The window object
3981     * @param rotation The rotation of the window, in degrees (0-360),
3982     * counter-clockwise.
3983     */
3984    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3985    /**
3986     * Rotates the window and resizes it.
3987     *
3988     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3989     * that they fit inside the current window geometry.
3990     *
3991     * @param obj The window object
3992     * @param layer The rotation of the window in degrees (0-360),
3993     * counter-clockwise.
3994     */
3995    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3996    /**
3997     * Get the rotation of the window.
3998     *
3999     * @param obj The window object
4000     * @return The rotation of the window in degrees (0-360)
4001     *
4002     * @see elm_win_rotation_set()
4003     * @see elm_win_rotation_with_resize_set()
4004     */
4005    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4006    /**
4007     * Set the sticky state of the window.
4008     *
4009     * Hints the Window Manager that the window in @p obj should be left fixed
4010     * at its position even when the virtual desktop it's on moves or changes.
4011     *
4012     * @param obj The window object
4013     * @param sticky If true, the window's sticky state is enabled
4014     */
4015    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4016    /**
4017     * Get the sticky state of the window.
4018     *
4019     * @param obj The window object
4020     * @return If true, the window's sticky state is enabled
4021     *
4022     * @see elm_win_sticky_set()
4023     */
4024    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4025    /**
4026     * Set if this window is an illume conformant window
4027     *
4028     * @param obj The window object
4029     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4030     */
4031    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4032    /**
4033     * Get if this window is an illume conformant window
4034     *
4035     * @param obj The window object
4036     * @return A boolean if this window is illume conformant or not
4037     */
4038    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4039    /**
4040     * Set a window to be an illume quickpanel window
4041     *
4042     * By default window objects are not quickpanel windows.
4043     *
4044     * @param obj The window object
4045     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4046     */
4047    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4048    /**
4049     * Get if this window is a quickpanel or not
4050     *
4051     * @param obj The window object
4052     * @return A boolean if this window is a quickpanel or not
4053     */
4054    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4055    /**
4056     * Set the major priority of a quickpanel window
4057     *
4058     * @param obj The window object
4059     * @param priority The major priority for this quickpanel
4060     */
4061    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4062    /**
4063     * Get the major priority of a quickpanel window
4064     *
4065     * @param obj The window object
4066     * @return The major priority of this quickpanel
4067     */
4068    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4069    /**
4070     * Set the minor priority of a quickpanel window
4071     *
4072     * @param obj The window object
4073     * @param priority The minor priority for this quickpanel
4074     */
4075    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4076    /**
4077     * Get the minor priority of a quickpanel window
4078     *
4079     * @param obj The window object
4080     * @return The minor priority of this quickpanel
4081     */
4082    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4083    /**
4084     * Set which zone this quickpanel should appear in
4085     *
4086     * @param obj The window object
4087     * @param zone The requested zone for this quickpanel
4088     */
4089    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4090    /**
4091     * Get which zone this quickpanel should appear in
4092     *
4093     * @param obj The window object
4094     * @return The requested zone for this quickpanel
4095     */
4096    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4097    /**
4098     * Set the window to be skipped by keyboard focus
4099     *
4100     * This sets the window to be skipped by normal keyboard input. This means
4101     * a window manager will be asked to not focus this window as well as omit
4102     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4103     *
4104     * Call this and enable it on a window BEFORE you show it for the first time,
4105     * otherwise it may have no effect.
4106     *
4107     * Use this for windows that have only output information or might only be
4108     * interacted with by the mouse or fingers, and never for typing input.
4109     * Be careful that this may have side-effects like making the window
4110     * non-accessible in some cases unless the window is specially handled. Use
4111     * this with care.
4112     *
4113     * @param obj The window object
4114     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4115     */
4116    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4117    /**
4118     * Send a command to the windowing environment
4119     *
4120     * This is intended to work in touchscreen or small screen device
4121     * environments where there is a more simplistic window management policy in
4122     * place. This uses the window object indicated to select which part of the
4123     * environment to control (the part that this window lives in), and provides
4124     * a command and an optional parameter structure (use NULL for this if not
4125     * needed).
4126     *
4127     * @param obj The window object that lives in the environment to control
4128     * @param command The command to send
4129     * @param params Optional parameters for the command
4130     */
4131    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4132    /**
4133     * Get the inlined image object handle
4134     *
4135     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4136     * then the window is in fact an evas image object inlined in the parent
4137     * canvas. You can get this object (be careful to not manipulate it as it
4138     * is under control of elementary), and use it to do things like get pixel
4139     * data, save the image to a file, etc.
4140     *
4141     * @param obj The window object to get the inlined image from
4142     * @return The inlined image object, or NULL if none exists
4143     */
4144    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4145    /**
4146     * Set the enabled status for the focus highlight in a window
4147     *
4148     * This function will enable or disable the focus highlight only for the
4149     * given window, regardless of the global setting for it
4150     *
4151     * @param obj The window where to enable the highlight
4152     * @param enabled The enabled value for the highlight
4153     */
4154    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4155    /**
4156     * Get the enabled value of the focus highlight for this window
4157     *
4158     * @param obj The window in which to check if the focus highlight is enabled
4159     *
4160     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4161     */
4162    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4163    /**
4164     * Set the style for the focus highlight on this window
4165     *
4166     * Sets the style to use for theming the highlight of focused objects on
4167     * the given window. If @p style is NULL, the default will be used.
4168     *
4169     * @param obj The window where to set the style
4170     * @param style The style to set
4171     */
4172    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4173    /**
4174     * Get the style set for the focus highlight object
4175     *
4176     * Gets the style set for this windows highilght object, or NULL if none
4177     * is set.
4178     *
4179     * @param obj The window to retrieve the highlights style from
4180     *
4181     * @return The style set or NULL if none was. Default is used in that case.
4182     */
4183    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4184    /*...
4185     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4186     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4187     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4188     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4189     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4190     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4191     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4192     *
4193     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4194     * (blank mouse, private mouse obj, defaultmouse)
4195     *
4196     */
4197    /**
4198     * Sets the keyboard mode of the window.
4199     *
4200     * @param obj The window object
4201     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4202     */
4203    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4204    /**
4205     * Gets the keyboard mode of the window.
4206     *
4207     * @param obj The window object
4208     * @return The mode, one of #Elm_Win_Keyboard_Mode
4209     */
4210    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4211    /**
4212     * Sets whether the window is a keyboard.
4213     *
4214     * @param obj The window object
4215     * @param is_keyboard If true, the window is a virtual keyboard
4216     */
4217    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4218    /**
4219     * Gets whether the window is a keyboard.
4220     *
4221     * @param obj The window object
4222     * @return If the window is a virtual keyboard
4223     */
4224    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4225
4226    /**
4227     * Get the screen position of a window.
4228     *
4229     * @param obj The window object
4230     * @param x The int to store the x coordinate to
4231     * @param y The int to store the y coordinate to
4232     */
4233    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4234    /**
4235     * @}
4236     */
4237
4238    /**
4239     * @defgroup Inwin Inwin
4240     *
4241     * @image html img/widget/inwin/preview-00.png
4242     * @image latex img/widget/inwin/preview-00.eps
4243     * @image html img/widget/inwin/preview-01.png
4244     * @image latex img/widget/inwin/preview-01.eps
4245     * @image html img/widget/inwin/preview-02.png
4246     * @image latex img/widget/inwin/preview-02.eps
4247     *
4248     * An inwin is a window inside a window that is useful for a quick popup.
4249     * It does not hover.
4250     *
4251     * It works by creating an object that will occupy the entire window, so it
4252     * must be created using an @ref Win "elm_win" as parent only. The inwin
4253     * object can be hidden or restacked below every other object if it's
4254     * needed to show what's behind it without destroying it. If this is done,
4255     * the elm_win_inwin_activate() function can be used to bring it back to
4256     * full visibility again.
4257     *
4258     * There are three styles available in the default theme. These are:
4259     * @li default: The inwin is sized to take over most of the window it's
4260     * placed in.
4261     * @li minimal: The size of the inwin will be the minimum necessary to show
4262     * its contents.
4263     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4264     * possible, but it's sized vertically the most it needs to fit its\
4265     * contents.
4266     *
4267     * Some examples of Inwin can be found in the following:
4268     * @li @ref inwin_example_01
4269     *
4270     * @{
4271     */
4272    /**
4273     * Adds an inwin to the current window
4274     *
4275     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4276     * Never call this function with anything other than the top-most window
4277     * as its parameter, unless you are fond of undefined behavior.
4278     *
4279     * After creating the object, the widget will set itself as resize object
4280     * for the window with elm_win_resize_object_add(), so when shown it will
4281     * appear to cover almost the entire window (how much of it depends on its
4282     * content and the style used). It must not be added into other container
4283     * objects and it needs not be moved or resized manually.
4284     *
4285     * @param parent The parent object
4286     * @return The new object or NULL if it cannot be created
4287     */
4288    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4289    /**
4290     * Activates an inwin object, ensuring its visibility
4291     *
4292     * This function will make sure that the inwin @p obj is completely visible
4293     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4294     * to the front. It also sets the keyboard focus to it, which will be passed
4295     * onto its content.
4296     *
4297     * The object's theme will also receive the signal "elm,action,show" with
4298     * source "elm".
4299     *
4300     * @param obj The inwin to activate
4301     */
4302    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4303    /**
4304     * Set the content of an inwin object.
4305     *
4306     * Once the content object is set, a previously set one will be deleted.
4307     * If you want to keep that old content object, use the
4308     * elm_win_inwin_content_unset() function.
4309     *
4310     * @param obj The inwin object
4311     * @param content The object to set as content
4312     */
4313    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4314    /**
4315     * Get the content of an inwin object.
4316     *
4317     * Return the content object which is set for this widget.
4318     *
4319     * The returned object is valid as long as the inwin is still alive and no
4320     * other content is set on it. Deleting the object will notify the inwin
4321     * about it and this one will be left empty.
4322     *
4323     * If you need to remove an inwin's content to be reused somewhere else,
4324     * see elm_win_inwin_content_unset().
4325     *
4326     * @param obj The inwin object
4327     * @return The content that is being used
4328     */
4329    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330    /**
4331     * Unset the content of an inwin object.
4332     *
4333     * Unparent and return the content object which was set for this widget.
4334     *
4335     * @param obj The inwin object
4336     * @return The content that was being used
4337     */
4338    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4339    /**
4340     * @}
4341     */
4342    /* X specific calls - won't work on non-x engines (return 0) */
4343
4344    /**
4345     * Get the Ecore_X_Window of an Evas_Object
4346     *
4347     * @param obj The object
4348     *
4349     * @return The Ecore_X_Window of @p obj
4350     *
4351     * @ingroup Win
4352     */
4353    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354
4355    /* smart callbacks called:
4356     * "delete,request" - the user requested to delete the window
4357     * "focus,in" - window got focus
4358     * "focus,out" - window lost focus
4359     * "moved" - window that holds the canvas was moved
4360     */
4361
4362    /**
4363     * @defgroup Bg Bg
4364     *
4365     * @image html img/widget/bg/preview-00.png
4366     * @image latex img/widget/bg/preview-00.eps
4367     *
4368     * @brief Background object, used for setting a solid color, image or Edje
4369     * group as background to a window or any container object.
4370     *
4371     * The bg object is used for setting a solid background to a window or
4372     * packing into any container object. It works just like an image, but has
4373     * some properties useful to a background, like setting it to tiled,
4374     * centered, scaled or stretched.
4375     *
4376     * Here is some sample code using it:
4377     * @li @ref bg_01_example_page
4378     * @li @ref bg_02_example_page
4379     * @li @ref bg_03_example_page
4380     */
4381
4382    /* bg */
4383    typedef enum _Elm_Bg_Option
4384      {
4385         ELM_BG_OPTION_CENTER,  /**< center the background */
4386         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4387         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4388         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4389      } Elm_Bg_Option;
4390
4391    /**
4392     * Add a new background to the parent
4393     *
4394     * @param parent The parent object
4395     * @return The new object or NULL if it cannot be created
4396     *
4397     * @ingroup Bg
4398     */
4399    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4400
4401    /**
4402     * Set the file (image or edje) used for the background
4403     *
4404     * @param obj The bg object
4405     * @param file The file path
4406     * @param group Optional key (group in Edje) within the file
4407     *
4408     * This sets the image file used in the background object. The image (or edje)
4409     * will be stretched (retaining aspect if its an image file) to completely fill
4410     * the bg object. This may mean some parts are not visible.
4411     *
4412     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4413     * even if @p file is NULL.
4414     *
4415     * @ingroup Bg
4416     */
4417    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4418
4419    /**
4420     * Get the file (image or edje) used for the background
4421     *
4422     * @param obj The bg object
4423     * @param file The file path
4424     * @param group Optional key (group in Edje) within the file
4425     *
4426     * @ingroup Bg
4427     */
4428    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4429
4430    /**
4431     * Set the option used for the background image
4432     *
4433     * @param obj The bg object
4434     * @param option The desired background option (TILE, SCALE)
4435     *
4436     * This sets the option used for manipulating the display of the background
4437     * image. The image can be tiled or scaled.
4438     *
4439     * @ingroup Bg
4440     */
4441    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4442
4443    /**
4444     * Get the option used for the background image
4445     *
4446     * @param obj The bg object
4447     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4448     *
4449     * @ingroup Bg
4450     */
4451    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4452    /**
4453     * Set the option used for the background color
4454     *
4455     * @param obj The bg object
4456     * @param r
4457     * @param g
4458     * @param b
4459     *
4460     * This sets the color used for the background rectangle. Its range goes
4461     * from 0 to 255.
4462     *
4463     * @ingroup Bg
4464     */
4465    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4466    /**
4467     * Get the option used for the background color
4468     *
4469     * @param obj The bg object
4470     * @param r
4471     * @param g
4472     * @param b
4473     *
4474     * @ingroup Bg
4475     */
4476    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4477
4478    /**
4479     * Set the overlay object used for the background object.
4480     *
4481     * @param obj The bg object
4482     * @param overlay The overlay object
4483     *
4484     * This provides a way for elm_bg to have an 'overlay' that will be on top
4485     * of the bg. Once the over object is set, a previously set one will be
4486     * deleted, even if you set the new one to NULL. If you want to keep that
4487     * old content object, use the elm_bg_overlay_unset() function.
4488     *
4489     * @ingroup Bg
4490     */
4491
4492    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4493
4494    /**
4495     * Get the overlay object used for the background object.
4496     *
4497     * @param obj The bg object
4498     * @return The content that is being used
4499     *
4500     * Return the content object which is set for this widget
4501     *
4502     * @ingroup Bg
4503     */
4504    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4505
4506    /**
4507     * Get the overlay object used for the background object.
4508     *
4509     * @param obj The bg object
4510     * @return The content that was being used
4511     *
4512     * Unparent and return the overlay object which was set for this widget
4513     *
4514     * @ingroup Bg
4515     */
4516    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4517
4518    /**
4519     * Set the size of the pixmap representation of the image.
4520     *
4521     * This option just makes sense if an image is going to be set in the bg.
4522     *
4523     * @param obj The bg object
4524     * @param w The new width of the image pixmap representation.
4525     * @param h The new height of the image pixmap representation.
4526     *
4527     * This function sets a new size for pixmap representation of the given bg
4528     * image. It allows the image to be loaded already in the specified size,
4529     * reducing the memory usage and load time when loading a big image with load
4530     * size set to a smaller size.
4531     *
4532     * NOTE: this is just a hint, the real size of the pixmap may differ
4533     * depending on the type of image being loaded, being bigger than requested.
4534     *
4535     * @ingroup Bg
4536     */
4537    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4538    /* smart callbacks called:
4539     */
4540
4541    /**
4542     * @defgroup Icon Icon
4543     *
4544     * @image html img/widget/icon/preview-00.png
4545     * @image latex img/widget/icon/preview-00.eps
4546     *
4547     * An object that provides standard icon images (delete, edit, arrows, etc.)
4548     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4549     *
4550     * The icon image requested can be in the elementary theme, or in the
4551     * freedesktop.org paths. It's possible to set the order of preference from
4552     * where the image will be used.
4553     *
4554     * This API is very similar to @ref Image, but with ready to use images.
4555     *
4556     * Default images provided by the theme are described below.
4557     *
4558     * The first list contains icons that were first intended to be used in
4559     * toolbars, but can be used in many other places too:
4560     * @li home
4561     * @li close
4562     * @li apps
4563     * @li arrow_up
4564     * @li arrow_down
4565     * @li arrow_left
4566     * @li arrow_right
4567     * @li chat
4568     * @li clock
4569     * @li delete
4570     * @li edit
4571     * @li refresh
4572     * @li folder
4573     * @li file
4574     *
4575     * Now some icons that were designed to be used in menus (but again, you can
4576     * use them anywhere else):
4577     * @li menu/home
4578     * @li menu/close
4579     * @li menu/apps
4580     * @li menu/arrow_up
4581     * @li menu/arrow_down
4582     * @li menu/arrow_left
4583     * @li menu/arrow_right
4584     * @li menu/chat
4585     * @li menu/clock
4586     * @li menu/delete
4587     * @li menu/edit
4588     * @li menu/refresh
4589     * @li menu/folder
4590     * @li menu/file
4591     *
4592     * And here we have some media player specific icons:
4593     * @li media_player/forward
4594     * @li media_player/info
4595     * @li media_player/next
4596     * @li media_player/pause
4597     * @li media_player/play
4598     * @li media_player/prev
4599     * @li media_player/rewind
4600     * @li media_player/stop
4601     *
4602     * Signals that you can add callbacks for are:
4603     *
4604     * "clicked" - This is called when a user has clicked the icon
4605     *
4606     * An example of usage for this API follows:
4607     * @li @ref tutorial_icon
4608     */
4609
4610    /**
4611     * @addtogroup Icon
4612     * @{
4613     */
4614
4615    typedef enum _Elm_Icon_Type
4616      {
4617         ELM_ICON_NONE,
4618         ELM_ICON_FILE,
4619         ELM_ICON_STANDARD
4620      } Elm_Icon_Type;
4621    /**
4622     * @enum _Elm_Icon_Lookup_Order
4623     * @typedef Elm_Icon_Lookup_Order
4624     *
4625     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4626     * theme, FDO paths, or both?
4627     *
4628     * @ingroup Icon
4629     */
4630    typedef enum _Elm_Icon_Lookup_Order
4631      {
4632         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4633         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4634         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4635         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4636      } Elm_Icon_Lookup_Order;
4637
4638    /**
4639     * Add a new icon object to the parent.
4640     *
4641     * @param parent The parent object
4642     * @return The new object or NULL if it cannot be created
4643     *
4644     * @see elm_icon_file_set()
4645     *
4646     * @ingroup Icon
4647     */
4648    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4649    /**
4650     * Set the file that will be used as icon.
4651     *
4652     * @param obj The icon object
4653     * @param file The path to file that will be used as icon image
4654     * @param group The group that the icon belongs to in edje file
4655     *
4656     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4657     *
4658     * @note The icon image set by this function can be changed by
4659     * elm_icon_standard_set().
4660     *
4661     * @see elm_icon_file_get()
4662     *
4663     * @ingroup Icon
4664     */
4665    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4666    /**
4667     * Set a location in memory to be used as an icon
4668     *
4669     * @param obj The icon object
4670     * @param img The binary data that will be used as an image
4671     * @param size The size of binary data @p img
4672     * @param format Optional format of @p img to pass to the image loader
4673     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4674     *
4675     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4676     *
4677     * @note The icon image set by this function can be changed by
4678     * elm_icon_standard_set().
4679     *
4680     * @ingroup Icon
4681     */
4682    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);
4683    /**
4684     * Get the file that will be used as icon.
4685     *
4686     * @param obj The icon object
4687     * @param file The path to file that will be used as icon icon image
4688     * @param group The group that the icon belongs to in edje file
4689     *
4690     * @see elm_icon_file_set()
4691     *
4692     * @ingroup Icon
4693     */
4694    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4695    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4696    /**
4697     * Set the icon by icon standards names.
4698     *
4699     * @param obj The icon object
4700     * @param name The icon name
4701     *
4702     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4703     *
4704     * For example, freedesktop.org defines standard icon names such as "home",
4705     * "network", etc. There can be different icon sets to match those icon
4706     * keys. The @p name given as parameter is one of these "keys", and will be
4707     * used to look in the freedesktop.org paths and elementary theme. One can
4708     * change the lookup order with elm_icon_order_lookup_set().
4709     *
4710     * If name is not found in any of the expected locations and it is the
4711     * absolute path of an image file, this image will be used.
4712     *
4713     * @note The icon image set by this function can be changed by
4714     * elm_icon_file_set().
4715     *
4716     * @see elm_icon_standard_get()
4717     * @see elm_icon_file_set()
4718     *
4719     * @ingroup Icon
4720     */
4721    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4722    /**
4723     * Get the icon name set by icon standard names.
4724     *
4725     * @param obj The icon object
4726     * @return The icon name
4727     *
4728     * If the icon image was set using elm_icon_file_set() instead of
4729     * elm_icon_standard_set(), then this function will return @c NULL.
4730     *
4731     * @see elm_icon_standard_set()
4732     *
4733     * @ingroup Icon
4734     */
4735    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4736    /**
4737     * Set the smooth effect for an icon object.
4738     *
4739     * @param obj The icon object
4740     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4741     * otherwise. Default is @c EINA_TRUE.
4742     *
4743     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4744     * scaling provides a better resulting image, but is slower.
4745     *
4746     * The smooth scaling should be disabled when making animations that change
4747     * the icon size, since they will be faster. Animations that don't require
4748     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4749     * is already scaled, since the scaled icon image will be cached).
4750     *
4751     * @see elm_icon_smooth_get()
4752     *
4753     * @ingroup Icon
4754     */
4755    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4756    /**
4757     * Get the smooth effect for an icon object.
4758     *
4759     * @param obj The icon object
4760     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4761     *
4762     * @see elm_icon_smooth_set()
4763     *
4764     * @ingroup Icon
4765     */
4766    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4767    /**
4768     * Disable scaling of this object.
4769     *
4770     * @param obj The icon object.
4771     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4772     * otherwise. Default is @c EINA_FALSE.
4773     *
4774     * This function disables scaling of the icon object through the function
4775     * elm_object_scale_set(). However, this does not affect the object
4776     * size/resize in any way. For that effect, take a look at
4777     * elm_icon_scale_set().
4778     *
4779     * @see elm_icon_no_scale_get()
4780     * @see elm_icon_scale_set()
4781     * @see elm_object_scale_set()
4782     *
4783     * @ingroup Icon
4784     */
4785    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4786    /**
4787     * Get whether scaling is disabled on the object.
4788     *
4789     * @param obj The icon object
4790     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4791     *
4792     * @see elm_icon_no_scale_set()
4793     *
4794     * @ingroup Icon
4795     */
4796    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4797    /**
4798     * Set if the object is (up/down) resizable.
4799     *
4800     * @param obj The icon object
4801     * @param scale_up A bool to set if the object is resizable up. Default is
4802     * @c EINA_TRUE.
4803     * @param scale_down A bool to set if the object is resizable down. Default
4804     * is @c EINA_TRUE.
4805     *
4806     * This function limits the icon object resize ability. If @p scale_up is set to
4807     * @c EINA_FALSE, the object can't have its height or width resized to a value
4808     * higher than the original icon size. Same is valid for @p scale_down.
4809     *
4810     * @see elm_icon_scale_get()
4811     *
4812     * @ingroup Icon
4813     */
4814    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4815    /**
4816     * Get if the object is (up/down) resizable.
4817     *
4818     * @param obj The icon object
4819     * @param scale_up A bool to set if the object is resizable up
4820     * @param scale_down A bool to set if the object is resizable down
4821     *
4822     * @see elm_icon_scale_set()
4823     *
4824     * @ingroup Icon
4825     */
4826    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4827    /**
4828     * Get the object's image size
4829     *
4830     * @param obj The icon object
4831     * @param w A pointer to store the width in
4832     * @param h A pointer to store the height in
4833     *
4834     * @ingroup Icon
4835     */
4836    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4837    /**
4838     * Set if the icon fill the entire object area.
4839     *
4840     * @param obj The icon object
4841     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4842     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4843     *
4844     * When the icon object is resized to a different aspect ratio from the
4845     * original icon image, the icon image will still keep its aspect. This flag
4846     * tells how the image should fill the object's area. They are: keep the
4847     * entire icon inside the limits of height and width of the object (@p
4848     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4849     * of the object, and the icon will fill the entire object (@p fill_outside
4850     * is @c EINA_TRUE).
4851     *
4852     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4853     * retain property to false. Thus, the icon image will always keep its
4854     * original aspect ratio.
4855     *
4856     * @see elm_icon_fill_outside_get()
4857     * @see elm_image_fill_outside_set()
4858     *
4859     * @ingroup Icon
4860     */
4861    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4862    /**
4863     * Get if the object is filled outside.
4864     *
4865     * @param obj The icon object
4866     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4867     *
4868     * @see elm_icon_fill_outside_set()
4869     *
4870     * @ingroup Icon
4871     */
4872    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4873    /**
4874     * Set the prescale size for the icon.
4875     *
4876     * @param obj The icon object
4877     * @param size The prescale size. This value is used for both width and
4878     * height.
4879     *
4880     * This function sets a new size for pixmap representation of the given
4881     * icon. It allows the icon to be loaded already in the specified size,
4882     * reducing the memory usage and load time when loading a big icon with load
4883     * size set to a smaller size.
4884     *
4885     * It's equivalent to the elm_bg_load_size_set() function for bg.
4886     *
4887     * @note this is just a hint, the real size of the pixmap may differ
4888     * depending on the type of icon being loaded, being bigger than requested.
4889     *
4890     * @see elm_icon_prescale_get()
4891     * @see elm_bg_load_size_set()
4892     *
4893     * @ingroup Icon
4894     */
4895    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4896    /**
4897     * Get the prescale size for the icon.
4898     *
4899     * @param obj The icon object
4900     * @return The prescale size
4901     *
4902     * @see elm_icon_prescale_set()
4903     *
4904     * @ingroup Icon
4905     */
4906    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4907    /**
4908     * Sets the icon lookup order used by elm_icon_standard_set().
4909     *
4910     * @param obj The icon object
4911     * @param order The icon lookup order (can be one of
4912     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4913     * or ELM_ICON_LOOKUP_THEME)
4914     *
4915     * @see elm_icon_order_lookup_get()
4916     * @see Elm_Icon_Lookup_Order
4917     *
4918     * @ingroup Icon
4919     */
4920    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4921    /**
4922     * Gets the icon lookup order.
4923     *
4924     * @param obj The icon object
4925     * @return The icon lookup order
4926     *
4927     * @see elm_icon_order_lookup_set()
4928     * @see Elm_Icon_Lookup_Order
4929     *
4930     * @ingroup Icon
4931     */
4932    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4933    /**
4934     * Get if the icon supports animation or not.
4935     *
4936     * @param obj The icon object
4937     * @return @c EINA_TRUE if the icon supports animation,
4938     *         @c EINA_FALSE otherwise.
4939     *
4940     * Return if this elm icon's image can be animated. Currently Evas only
4941     * supports gif animation. If the return value is EINA_FALSE, other
4942     * elm_icon_animated_XXX APIs won't work.
4943     * @ingroup Icon
4944     */
4945    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4946    /**
4947     * Set animation mode of the icon.
4948     *
4949     * @param obj The icon object
4950     * @param anim @c EINA_TRUE if the object do animation job,
4951     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4952     *
4953     * Even though elm icon's file can be animated,
4954     * sometimes appication developer want to just first page of image.
4955     * In that time, don't call this function, because default value is EINA_FALSE
4956     * Only when you want icon support anition,
4957     * use this function and set animated to EINA_TURE
4958     * @ingroup Icon
4959     */
4960    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4961    /**
4962     * Get animation mode of the icon.
4963     *
4964     * @param obj The icon object
4965     * @return The animation mode of the icon object
4966     * @see elm_icon_animated_set
4967     * @ingroup Icon
4968     */
4969    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4970    /**
4971     * Set animation play mode of the icon.
4972     *
4973     * @param obj The icon object
4974     * @param play @c EINA_TRUE the object play animation images,
4975     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4976     *
4977     * If you want to play elm icon's animation, you set play to EINA_TURE.
4978     * For example, you make gif player using this set/get API and click event.
4979     *
4980     * 1. Click event occurs
4981     * 2. Check play flag using elm_icon_animaged_play_get
4982     * 3. If elm icon was playing, set play to EINA_FALSE.
4983     *    Then animation will be stopped and vice versa
4984     * @ingroup Icon
4985     */
4986    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4987    /**
4988     * Get animation play mode of the icon.
4989     *
4990     * @param obj The icon object
4991     * @return The play mode of the icon object
4992     *
4993     * @see elm_icon_animated_lay_get
4994     * @ingroup Icon
4995     */
4996    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4997
4998    /**
4999     * @}
5000     */
5001
5002    /**
5003     * @defgroup Image Image
5004     *
5005     * @image html img/widget/image/preview-00.png
5006     * @image latex img/widget/image/preview-00.eps
5007
5008     *
5009     * An object that allows one to load an image file to it. It can be used
5010     * anywhere like any other elementary widget.
5011     *
5012     * This widget provides most of the functionality provided from @ref Bg or @ref
5013     * Icon, but with a slightly different API (use the one that fits better your
5014     * needs).
5015     *
5016     * The features not provided by those two other image widgets are:
5017     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5018     * @li change the object orientation with elm_image_orient_set();
5019     * @li and turning the image editable with elm_image_editable_set().
5020     *
5021     * Signals that you can add callbacks for are:
5022     *
5023     * @li @c "clicked" - This is called when a user has clicked the image
5024     *
5025     * An example of usage for this API follows:
5026     * @li @ref tutorial_image
5027     */
5028
5029    /**
5030     * @addtogroup Image
5031     * @{
5032     */
5033
5034    /**
5035     * @enum _Elm_Image_Orient
5036     * @typedef Elm_Image_Orient
5037     *
5038     * Possible orientation options for elm_image_orient_set().
5039     *
5040     * @image html elm_image_orient_set.png
5041     * @image latex elm_image_orient_set.eps width=\textwidth
5042     *
5043     * @ingroup Image
5044     */
5045    typedef enum _Elm_Image_Orient
5046      {
5047         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5048         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5049         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5050         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5051         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5052         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5053         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5054         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5055      } Elm_Image_Orient;
5056
5057    /**
5058     * Add a new image to the parent.
5059     *
5060     * @param parent The parent object
5061     * @return The new object or NULL if it cannot be created
5062     *
5063     * @see elm_image_file_set()
5064     *
5065     * @ingroup Image
5066     */
5067    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5068    /**
5069     * Set the file that will be used as image.
5070     *
5071     * @param obj The image object
5072     * @param file The path to file that will be used as image
5073     * @param group The group that the image belongs in edje file (if it's an
5074     * edje image)
5075     *
5076     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5077     *
5078     * @see elm_image_file_get()
5079     *
5080     * @ingroup Image
5081     */
5082    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5083    /**
5084     * Get the file that will be used as image.
5085     *
5086     * @param obj The image object
5087     * @param file The path to file
5088     * @param group The group that the image belongs in edje file
5089     *
5090     * @see elm_image_file_set()
5091     *
5092     * @ingroup Image
5093     */
5094    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5095    /**
5096     * Set the smooth effect for an image.
5097     *
5098     * @param obj The image object
5099     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5100     * otherwise. Default is @c EINA_TRUE.
5101     *
5102     * Set the scaling algorithm to be used when scaling the image. Smooth
5103     * scaling provides a better resulting image, but is slower.
5104     *
5105     * The smooth scaling should be disabled when making animations that change
5106     * the image size, since it will be faster. Animations that don't require
5107     * resizing of the image can keep the smooth scaling enabled (even if the
5108     * image is already scaled, since the scaled image will be cached).
5109     *
5110     * @see elm_image_smooth_get()
5111     *
5112     * @ingroup Image
5113     */
5114    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5115    /**
5116     * Get the smooth effect for an image.
5117     *
5118     * @param obj The image object
5119     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5120     *
5121     * @see elm_image_smooth_get()
5122     *
5123     * @ingroup Image
5124     */
5125    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5126    /**
5127     * Gets the current size of the image.
5128     *
5129     * @param obj The image object.
5130     * @param w Pointer to store width, or NULL.
5131     * @param h Pointer to store height, or NULL.
5132     *
5133     * This is the real size of the image, not the size of the object.
5134     *
5135     * On error, neither w or h will be written.
5136     *
5137     * @ingroup Image
5138     */
5139    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5140    /**
5141     * Disable scaling of this object.
5142     *
5143     * @param obj The image object.
5144     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5145     * otherwise. Default is @c EINA_FALSE.
5146     *
5147     * This function disables scaling of the elm_image widget through the
5148     * function elm_object_scale_set(). However, this does not affect the widget
5149     * size/resize in any way. For that effect, take a look at
5150     * elm_image_scale_set().
5151     *
5152     * @see elm_image_no_scale_get()
5153     * @see elm_image_scale_set()
5154     * @see elm_object_scale_set()
5155     *
5156     * @ingroup Image
5157     */
5158    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5159    /**
5160     * Get whether scaling is disabled on the object.
5161     *
5162     * @param obj The image object
5163     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5164     *
5165     * @see elm_image_no_scale_set()
5166     *
5167     * @ingroup Image
5168     */
5169    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5170    /**
5171     * Set if the object is (up/down) resizable.
5172     *
5173     * @param obj The image object
5174     * @param scale_up A bool to set if the object is resizable up. Default is
5175     * @c EINA_TRUE.
5176     * @param scale_down A bool to set if the object is resizable down. Default
5177     * is @c EINA_TRUE.
5178     *
5179     * This function limits the image resize ability. If @p scale_up is set to
5180     * @c EINA_FALSE, the object can't have its height or width resized to a value
5181     * higher than the original image size. Same is valid for @p scale_down.
5182     *
5183     * @see elm_image_scale_get()
5184     *
5185     * @ingroup Image
5186     */
5187    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5188    /**
5189     * Get if the object is (up/down) resizable.
5190     *
5191     * @param obj The image object
5192     * @param scale_up A bool to set if the object is resizable up
5193     * @param scale_down A bool to set if the object is resizable down
5194     *
5195     * @see elm_image_scale_set()
5196     *
5197     * @ingroup Image
5198     */
5199    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5200    /**
5201     * Set if the image fill the entire object area when keeping the aspect ratio.
5202     *
5203     * @param obj The image object
5204     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5205     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5206     *
5207     * When the image should keep its aspect ratio even if resized to another
5208     * aspect ratio, there are two possibilities to resize it: keep the entire
5209     * image inside the limits of height and width of the object (@p fill_outside
5210     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5211     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5212     *
5213     * @note This option will have no effect if
5214     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5215     *
5216     * @see elm_image_fill_outside_get()
5217     * @see elm_image_aspect_ratio_retained_set()
5218     *
5219     * @ingroup Image
5220     */
5221    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5222    /**
5223     * Get if the object is filled outside
5224     *
5225     * @param obj The image object
5226     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5227     *
5228     * @see elm_image_fill_outside_set()
5229     *
5230     * @ingroup Image
5231     */
5232    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5233    /**
5234     * Set the prescale size for the image
5235     *
5236     * @param obj The image object
5237     * @param size The prescale size. This value is used for both width and
5238     * height.
5239     *
5240     * This function sets a new size for pixmap representation of the given
5241     * image. It allows the image to be loaded already in the specified size,
5242     * reducing the memory usage and load time when loading a big image with load
5243     * size set to a smaller size.
5244     *
5245     * It's equivalent to the elm_bg_load_size_set() function for bg.
5246     *
5247     * @note this is just a hint, the real size of the pixmap may differ
5248     * depending on the type of image being loaded, being bigger than requested.
5249     *
5250     * @see elm_image_prescale_get()
5251     * @see elm_bg_load_size_set()
5252     *
5253     * @ingroup Image
5254     */
5255    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5256    /**
5257     * Get the prescale size for the image
5258     *
5259     * @param obj The image object
5260     * @return The prescale size
5261     *
5262     * @see elm_image_prescale_set()
5263     *
5264     * @ingroup Image
5265     */
5266    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5267    /**
5268     * Set the image orientation.
5269     *
5270     * @param obj The image object
5271     * @param orient The image orientation
5272     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5273     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5274     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5275     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5276     *  Default is #ELM_IMAGE_ORIENT_NONE.
5277     *
5278     * This function allows to rotate or flip the given image.
5279     *
5280     * @see elm_image_orient_get()
5281     * @see @ref Elm_Image_Orient
5282     *
5283     * @ingroup Image
5284     */
5285    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5286    /**
5287     * Get the image orientation.
5288     *
5289     * @param obj The image object
5290     * @return The image orientation
5291     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5292     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5293     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5294     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5295     *
5296     * @see elm_image_orient_set()
5297     * @see @ref Elm_Image_Orient
5298     *
5299     * @ingroup Image
5300     */
5301    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5302    /**
5303     * Make the image 'editable'.
5304     *
5305     * @param obj Image object.
5306     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5307     *
5308     * This means the image is a valid drag target for drag and drop, and can be
5309     * cut or pasted too.
5310     *
5311     * @ingroup Image
5312     */
5313    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5314    /**
5315     * Make the image 'editable'.
5316     *
5317     * @param obj Image object.
5318     * @return Editability.
5319     *
5320     * This means the image is a valid drag target for drag and drop, and can be
5321     * cut or pasted too.
5322     *
5323     * @ingroup Image
5324     */
5325    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5326    /**
5327     * Get the basic Evas_Image object from this object (widget).
5328     *
5329     * @param obj The image object to get the inlined image from
5330     * @return The inlined image object, or NULL if none exists
5331     *
5332     * This function allows one to get the underlying @c Evas_Object of type
5333     * Image from this elementary widget. It can be useful to do things like get
5334     * the pixel data, save the image to a file, etc.
5335     *
5336     * @note Be careful to not manipulate it, as it is under control of
5337     * elementary.
5338     *
5339     * @ingroup Image
5340     */
5341    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5342    /**
5343     * Set whether the original aspect ratio of the image should be kept on resize.
5344     *
5345     * @param obj The image object.
5346     * @param retained @c EINA_TRUE if the image should retain the aspect,
5347     * @c EINA_FALSE otherwise.
5348     *
5349     * The original aspect ratio (width / height) of the image is usually
5350     * distorted to match the object's size. Enabling this option will retain
5351     * this original aspect, and the way that the image is fit into the object's
5352     * area depends on the option set by elm_image_fill_outside_set().
5353     *
5354     * @see elm_image_aspect_ratio_retained_get()
5355     * @see elm_image_fill_outside_set()
5356     *
5357     * @ingroup Image
5358     */
5359    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5360    /**
5361     * Get if the object retains the original aspect ratio.
5362     *
5363     * @param obj The image object.
5364     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5365     * otherwise.
5366     *
5367     * @ingroup Image
5368     */
5369    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5370
5371    /**
5372     * @}
5373     */
5374
5375    /* glview */
5376    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5377
5378    typedef enum _Elm_GLView_Mode
5379      {
5380         ELM_GLVIEW_ALPHA   = 1,
5381         ELM_GLVIEW_DEPTH   = 2,
5382         ELM_GLVIEW_STENCIL = 4
5383      } Elm_GLView_Mode;
5384
5385    /**
5386     * Defines a policy for the glview resizing.
5387     *
5388     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5389     */
5390    typedef enum _Elm_GLView_Resize_Policy
5391      {
5392         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5393         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5394      } Elm_GLView_Resize_Policy;
5395
5396    typedef enum _Elm_GLView_Render_Policy
5397      {
5398         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5399         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5400      } Elm_GLView_Render_Policy;
5401
5402    /**
5403     * @defgroup GLView
5404     *
5405     * A simple GLView widget that allows GL rendering.
5406     *
5407     * Signals that you can add callbacks for are:
5408     *
5409     * @{
5410     */
5411
5412    /**
5413     * Add a new glview to the parent
5414     *
5415     * @param parent The parent object
5416     * @return The new object or NULL if it cannot be created
5417     *
5418     * @ingroup GLView
5419     */
5420    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5421
5422    /**
5423     * Sets the size of the glview
5424     *
5425     * @param obj The glview object
5426     * @param width width of the glview object
5427     * @param height height of the glview object
5428     *
5429     * @ingroup GLView
5430     */
5431    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5432
5433    /**
5434     * Gets the size of the glview.
5435     *
5436     * @param obj The glview object
5437     * @param width width of the glview object
5438     * @param height height of the glview object
5439     *
5440     * Note that this function returns the actual image size of the
5441     * glview.  This means that when the scale policy is set to
5442     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5443     * size.
5444     *
5445     * @ingroup GLView
5446     */
5447    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5448
5449    /**
5450     * Gets the gl api struct for gl rendering
5451     *
5452     * @param obj The glview object
5453     * @return The api object or NULL if it cannot be created
5454     *
5455     * @ingroup GLView
5456     */
5457    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5458
5459    /**
5460     * Set the mode of the GLView. Supports Three simple modes.
5461     *
5462     * @param obj The glview object
5463     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5464     * @return True if set properly.
5465     *
5466     * @ingroup GLView
5467     */
5468    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5469
5470    /**
5471     * Set the resize policy for the glview object.
5472     *
5473     * @param obj The glview object.
5474     * @param policy The scaling policy.
5475     *
5476     * By default, the resize policy is set to
5477     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5478     * destroys the previous surface and recreates the newly specified
5479     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5480     * however, glview only scales the image object and not the underlying
5481     * GL Surface.
5482     *
5483     * @ingroup GLView
5484     */
5485    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5486
5487    /**
5488     * Set the render policy for the glview object.
5489     *
5490     * @param obj The glview object.
5491     * @param policy The render policy.
5492     *
5493     * By default, the render policy is set to
5494     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5495     * that during the render loop, glview is only redrawn if it needs
5496     * to be redrawn. (i.e. When it is visible) If the policy is set to
5497     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5498     * whether it is visible/need redrawing or not.
5499     *
5500     * @ingroup GLView
5501     */
5502    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5503
5504    /**
5505     * Set the init function that runs once in the main loop.
5506     *
5507     * @param obj The glview object.
5508     * @param func The init function to be registered.
5509     *
5510     * The registered init function gets called once during the render loop.
5511     *
5512     * @ingroup GLView
5513     */
5514    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5515
5516    /**
5517     * Set the render function that runs in the main loop.
5518     *
5519     * @param obj The glview object.
5520     * @param func The delete function to be registered.
5521     *
5522     * The registered del function gets called when GLView object is deleted.
5523     *
5524     * @ingroup GLView
5525     */
5526    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5527
5528    /**
5529     * Set the resize function that gets called when resize happens.
5530     *
5531     * @param obj The glview object.
5532     * @param func The resize function to be registered.
5533     *
5534     * @ingroup GLView
5535     */
5536    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5537
5538    /**
5539     * Set the render function that runs in the main loop.
5540     *
5541     * @param obj The glview object.
5542     * @param func The render function to be registered.
5543     *
5544     * @ingroup GLView
5545     */
5546    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5547
5548    /**
5549     * Notifies that there has been changes in the GLView.
5550     *
5551     * @param obj The glview object.
5552     *
5553     * @ingroup GLView
5554     */
5555    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5556
5557    /**
5558     * @}
5559     */
5560
5561    /* box */
5562    /**
5563     * @defgroup Box Box
5564     *
5565     * @image html img/widget/box/preview-00.png
5566     * @image latex img/widget/box/preview-00.eps width=\textwidth
5567     *
5568     * @image html img/box.png
5569     * @image latex img/box.eps width=\textwidth
5570     *
5571     * A box arranges objects in a linear fashion, governed by a layout function
5572     * that defines the details of this arrangement.
5573     *
5574     * By default, the box will use an internal function to set the layout to
5575     * a single row, either vertical or horizontal. This layout is affected
5576     * by a number of parameters, such as the homogeneous flag set by
5577     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5578     * elm_box_align_set() and the hints set to each object in the box.
5579     *
5580     * For this default layout, it's possible to change the orientation with
5581     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5582     * placing its elements ordered from top to bottom. When horizontal is set,
5583     * the order will go from left to right. If the box is set to be
5584     * homogeneous, every object in it will be assigned the same space, that
5585     * of the largest object. Padding can be used to set some spacing between
5586     * the cell given to each object. The alignment of the box, set with
5587     * elm_box_align_set(), determines how the bounding box of all the elements
5588     * will be placed within the space given to the box widget itself.
5589     *
5590     * The size hints of each object also affect how they are placed and sized
5591     * within the box. evas_object_size_hint_min_set() will give the minimum
5592     * size the object can have, and the box will use it as the basis for all
5593     * latter calculations. Elementary widgets set their own minimum size as
5594     * needed, so there's rarely any need to use it manually.
5595     *
5596     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5597     * used to tell whether the object will be allocated the minimum size it
5598     * needs or if the space given to it should be expanded. It's important
5599     * to realize that expanding the size given to the object is not the same
5600     * thing as resizing the object. It could very well end being a small
5601     * widget floating in a much larger empty space. If not set, the weight
5602     * for objects will normally be 0.0 for both axis, meaning the widget will
5603     * not be expanded. To take as much space possible, set the weight to
5604     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5605     *
5606     * Besides how much space each object is allocated, it's possible to control
5607     * how the widget will be placed within that space using
5608     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5609     * for both axis, meaning the object will be centered, but any value from
5610     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5611     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5612     * is -1.0, means the object will be resized to fill the entire space it
5613     * was allocated.
5614     *
5615     * In addition, customized functions to define the layout can be set, which
5616     * allow the application developer to organize the objects within the box
5617     * in any number of ways.
5618     *
5619     * The special elm_box_layout_transition() function can be used
5620     * to switch from one layout to another, animating the motion of the
5621     * children of the box.
5622     *
5623     * @note Objects should not be added to box objects using _add() calls.
5624     *
5625     * Some examples on how to use boxes follow:
5626     * @li @ref box_example_01
5627     * @li @ref box_example_02
5628     *
5629     * @{
5630     */
5631    /**
5632     * @typedef Elm_Box_Transition
5633     *
5634     * Opaque handler containing the parameters to perform an animated
5635     * transition of the layout the box uses.
5636     *
5637     * @see elm_box_transition_new()
5638     * @see elm_box_layout_set()
5639     * @see elm_box_layout_transition()
5640     */
5641    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5642
5643    /**
5644     * Add a new box to the parent
5645     *
5646     * By default, the box will be in vertical mode and non-homogeneous.
5647     *
5648     * @param parent The parent object
5649     * @return The new object or NULL if it cannot be created
5650     */
5651    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5652    /**
5653     * Set the horizontal orientation
5654     *
5655     * By default, box object arranges their contents vertically from top to
5656     * bottom.
5657     * By calling this function with @p horizontal as EINA_TRUE, the box will
5658     * become horizontal, arranging contents from left to right.
5659     *
5660     * @note This flag is ignored if a custom layout function is set.
5661     *
5662     * @param obj The box object
5663     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5664     * EINA_FALSE = vertical)
5665     */
5666    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5667    /**
5668     * Get the horizontal orientation
5669     *
5670     * @param obj The box object
5671     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5672     */
5673    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5674    /**
5675     * Set the box to arrange its children homogeneously
5676     *
5677     * If enabled, homogeneous layout makes all items the same size, according
5678     * to the size of the largest of its children.
5679     *
5680     * @note This flag is ignored if a custom layout function is set.
5681     *
5682     * @param obj The box object
5683     * @param homogeneous The homogeneous flag
5684     */
5685    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5686    /**
5687     * Get whether the box is using homogeneous mode or not
5688     *
5689     * @param obj The box object
5690     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5691     */
5692    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5693    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5694    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5695    /**
5696     * Add an object to the beginning of the pack list
5697     *
5698     * Pack @p subobj into the box @p obj, placing it first in the list of
5699     * children objects. The actual position the object will get on screen
5700     * depends on the layout used. If no custom layout is set, it will be at
5701     * the top or left, depending if the box is vertical or horizontal,
5702     * respectively.
5703     *
5704     * @param obj The box object
5705     * @param subobj The object to add to the box
5706     *
5707     * @see elm_box_pack_end()
5708     * @see elm_box_pack_before()
5709     * @see elm_box_pack_after()
5710     * @see elm_box_unpack()
5711     * @see elm_box_unpack_all()
5712     * @see elm_box_clear()
5713     */
5714    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5715    /**
5716     * Add an object at the end of the pack list
5717     *
5718     * Pack @p subobj into the box @p obj, placing it last in the list of
5719     * children objects. The actual position the object will get on screen
5720     * depends on the layout used. If no custom layout is set, it will be at
5721     * the bottom or right, depending if the box is vertical or horizontal,
5722     * respectively.
5723     *
5724     * @param obj The box object
5725     * @param subobj The object to add to the box
5726     *
5727     * @see elm_box_pack_start()
5728     * @see elm_box_pack_before()
5729     * @see elm_box_pack_after()
5730     * @see elm_box_unpack()
5731     * @see elm_box_unpack_all()
5732     * @see elm_box_clear()
5733     */
5734    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5735    /**
5736     * Adds an object to the box before the indicated object
5737     *
5738     * This will add the @p subobj to the box indicated before the object
5739     * indicated with @p before. If @p before is not already in the box, results
5740     * are undefined. Before means either to the left of the indicated object or
5741     * above it depending on orientation.
5742     *
5743     * @param obj The box object
5744     * @param subobj The object to add to the box
5745     * @param before The object before which to add it
5746     *
5747     * @see elm_box_pack_start()
5748     * @see elm_box_pack_end()
5749     * @see elm_box_pack_after()
5750     * @see elm_box_unpack()
5751     * @see elm_box_unpack_all()
5752     * @see elm_box_clear()
5753     */
5754    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5755    /**
5756     * Adds an object to the box after the indicated object
5757     *
5758     * This will add the @p subobj to the box indicated after the object
5759     * indicated with @p after. If @p after is not already in the box, results
5760     * are undefined. After means either to the right of the indicated object or
5761     * below it depending on orientation.
5762     *
5763     * @param obj The box object
5764     * @param subobj The object to add to the box
5765     * @param after The object after which to add it
5766     *
5767     * @see elm_box_pack_start()
5768     * @see elm_box_pack_end()
5769     * @see elm_box_pack_before()
5770     * @see elm_box_unpack()
5771     * @see elm_box_unpack_all()
5772     * @see elm_box_clear()
5773     */
5774    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5775    /**
5776     * Clear the box of all children
5777     *
5778     * Remove all the elements contained by the box, deleting the respective
5779     * objects.
5780     *
5781     * @param obj The box object
5782     *
5783     * @see elm_box_unpack()
5784     * @see elm_box_unpack_all()
5785     */
5786    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5787    /**
5788     * Unpack a box item
5789     *
5790     * Remove the object given by @p subobj from the box @p obj without
5791     * deleting it.
5792     *
5793     * @param obj The box object
5794     *
5795     * @see elm_box_unpack_all()
5796     * @see elm_box_clear()
5797     */
5798    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5799    /**
5800     * Remove all items from the box, without deleting them
5801     *
5802     * Clear the box from all children, but don't delete the respective objects.
5803     * If no other references of the box children exist, the objects will never
5804     * be deleted, and thus the application will leak the memory. Make sure
5805     * when using this function that you hold a reference to all the objects
5806     * in the box @p obj.
5807     *
5808     * @param obj The box object
5809     *
5810     * @see elm_box_clear()
5811     * @see elm_box_unpack()
5812     */
5813    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5814    /**
5815     * Retrieve a list of the objects packed into the box
5816     *
5817     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5818     * The order of the list corresponds to the packing order the box uses.
5819     *
5820     * You must free this list with eina_list_free() once you are done with it.
5821     *
5822     * @param obj The box object
5823     */
5824    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5825    /**
5826     * Set the space (padding) between the box's elements.
5827     *
5828     * Extra space in pixels that will be added between a box child and its
5829     * neighbors after its containing cell has been calculated. This padding
5830     * is set for all elements in the box, besides any possible padding that
5831     * individual elements may have through their size hints.
5832     *
5833     * @param obj The box object
5834     * @param horizontal The horizontal space between elements
5835     * @param vertical The vertical space between elements
5836     */
5837    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5838    /**
5839     * Get the space (padding) between the box's elements.
5840     *
5841     * @param obj The box object
5842     * @param horizontal The horizontal space between elements
5843     * @param vertical The vertical space between elements
5844     *
5845     * @see elm_box_padding_set()
5846     */
5847    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5848    /**
5849     * Set the alignment of the whole bouding box of contents.
5850     *
5851     * Sets how the bounding box containing all the elements of the box, after
5852     * their sizes and position has been calculated, will be aligned within
5853     * the space given for the whole box widget.
5854     *
5855     * @param obj The box object
5856     * @param horizontal The horizontal alignment of elements
5857     * @param vertical The vertical alignment of elements
5858     */
5859    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5860    /**
5861     * Get the alignment of the whole bouding box of contents.
5862     *
5863     * @param obj The box object
5864     * @param horizontal The horizontal alignment of elements
5865     * @param vertical The vertical alignment of elements
5866     *
5867     * @see elm_box_align_set()
5868     */
5869    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5870
5871    /**
5872     * Force the box to recalculate its children packing.
5873     *
5874     * If any children was added or removed, box will not calculate the
5875     * values immediately rather leaving it to the next main loop
5876     * iteration. While this is great as it would save lots of
5877     * recalculation, whenever you need to get the position of a just
5878     * added item you must force recalculate before doing so.
5879     *
5880     * @param obj The box object.
5881     */
5882    EAPI void                 elm_box_recalculate(Evas_Object *obj);
5883
5884    /**
5885     * Set the layout defining function to be used by the box
5886     *
5887     * Whenever anything changes that requires the box in @p obj to recalculate
5888     * the size and position of its elements, the function @p cb will be called
5889     * to determine what the layout of the children will be.
5890     *
5891     * Once a custom function is set, everything about the children layout
5892     * is defined by it. The flags set by elm_box_horizontal_set() and
5893     * elm_box_homogeneous_set() no longer have any meaning, and the values
5894     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5895     * layout function to decide if they are used and how. These last two
5896     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5897     * passed to @p cb. The @c Evas_Object the function receives is not the
5898     * Elementary widget, but the internal Evas Box it uses, so none of the
5899     * functions described here can be used on it.
5900     *
5901     * Any of the layout functions in @c Evas can be used here, as well as the
5902     * special elm_box_layout_transition().
5903     *
5904     * The final @p data argument received by @p cb is the same @p data passed
5905     * here, and the @p free_data function will be called to free it
5906     * whenever the box is destroyed or another layout function is set.
5907     *
5908     * Setting @p cb to NULL will revert back to the default layout function.
5909     *
5910     * @param obj The box object
5911     * @param cb The callback function used for layout
5912     * @param data Data that will be passed to layout function
5913     * @param free_data Function called to free @p data
5914     *
5915     * @see elm_box_layout_transition()
5916     */
5917    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);
5918    /**
5919     * Special layout function that animates the transition from one layout to another
5920     *
5921     * Normally, when switching the layout function for a box, this will be
5922     * reflected immediately on screen on the next render, but it's also
5923     * possible to do this through an animated transition.
5924     *
5925     * This is done by creating an ::Elm_Box_Transition and setting the box
5926     * layout to this function.
5927     *
5928     * For example:
5929     * @code
5930     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5931     *                            evas_object_box_layout_vertical, // start
5932     *                            NULL, // data for initial layout
5933     *                            NULL, // free function for initial data
5934     *                            evas_object_box_layout_horizontal, // end
5935     *                            NULL, // data for final layout
5936     *                            NULL, // free function for final data
5937     *                            anim_end, // will be called when animation ends
5938     *                            NULL); // data for anim_end function\
5939     * elm_box_layout_set(box, elm_box_layout_transition, t,
5940     *                    elm_box_transition_free);
5941     * @endcode
5942     *
5943     * @note This function can only be used with elm_box_layout_set(). Calling
5944     * it directly will not have the expected results.
5945     *
5946     * @see elm_box_transition_new
5947     * @see elm_box_transition_free
5948     * @see elm_box_layout_set
5949     */
5950    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5951    /**
5952     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5953     *
5954     * If you want to animate the change from one layout to another, you need
5955     * to set the layout function of the box to elm_box_layout_transition(),
5956     * passing as user data to it an instance of ::Elm_Box_Transition with the
5957     * necessary information to perform this animation. The free function to
5958     * set for the layout is elm_box_transition_free().
5959     *
5960     * The parameters to create an ::Elm_Box_Transition sum up to how long
5961     * will it be, in seconds, a layout function to describe the initial point,
5962     * another for the final position of the children and one function to be
5963     * called when the whole animation ends. This last function is useful to
5964     * set the definitive layout for the box, usually the same as the end
5965     * layout for the animation, but could be used to start another transition.
5966     *
5967     * @param start_layout The layout function that will be used to start the animation
5968     * @param start_layout_data The data to be passed the @p start_layout function
5969     * @param start_layout_free_data Function to free @p start_layout_data
5970     * @param end_layout The layout function that will be used to end the animation
5971     * @param end_layout_free_data The data to be passed the @p end_layout function
5972     * @param end_layout_free_data Function to free @p end_layout_data
5973     * @param transition_end_cb Callback function called when animation ends
5974     * @param transition_end_data Data to be passed to @p transition_end_cb
5975     * @return An instance of ::Elm_Box_Transition
5976     *
5977     * @see elm_box_transition_new
5978     * @see elm_box_layout_transition
5979     */
5980    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);
5981    /**
5982     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5983     *
5984     * This function is mostly useful as the @c free_data parameter in
5985     * elm_box_layout_set() when elm_box_layout_transition().
5986     *
5987     * @param data The Elm_Box_Transition instance to be freed.
5988     *
5989     * @see elm_box_transition_new
5990     * @see elm_box_layout_transition
5991     */
5992    EAPI void                elm_box_transition_free(void *data);
5993    /**
5994     * @}
5995     */
5996
5997    /* button */
5998    /**
5999     * @defgroup Button Button
6000     *
6001     * @image html img/widget/button/preview-00.png
6002     * @image latex img/widget/button/preview-00.eps
6003     * @image html img/widget/button/preview-01.png
6004     * @image latex img/widget/button/preview-01.eps
6005     * @image html img/widget/button/preview-02.png
6006     * @image latex img/widget/button/preview-02.eps
6007     *
6008     * This is a push-button. Press it and run some function. It can contain
6009     * a simple label and icon object and it also has an autorepeat feature.
6010     *
6011     * This widgets emits the following signals:
6012     * @li "clicked": the user clicked the button (press/release).
6013     * @li "repeated": the user pressed the button without releasing it.
6014     * @li "pressed": button was pressed.
6015     * @li "unpressed": button was released after being pressed.
6016     * In all three cases, the @c event parameter of the callback will be
6017     * @c NULL.
6018     *
6019     * Also, defined in the default theme, the button has the following styles
6020     * available:
6021     * @li default: a normal button.
6022     * @li anchor: Like default, but the button fades away when the mouse is not
6023     * over it, leaving only the text or icon.
6024     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6025     * continuous look across its options.
6026     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6027     *
6028     * Follow through a complete example @ref button_example_01 "here".
6029     * @{
6030     */
6031    /**
6032     * Add a new button to the parent's canvas
6033     *
6034     * @param parent The parent object
6035     * @return The new object or NULL if it cannot be created
6036     */
6037    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6038    /**
6039     * Set the label used in the button
6040     *
6041     * The passed @p label can be NULL to clean any existing text in it and
6042     * leave the button as an icon only object.
6043     *
6044     * @param obj The button object
6045     * @param label The text will be written on the button
6046     * @deprecated use elm_object_text_set() instead.
6047     */
6048    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6049    /**
6050     * Get the label set for the button
6051     *
6052     * The string returned is an internal pointer and should not be freed or
6053     * altered. It will also become invalid when the button is destroyed.
6054     * The string returned, if not NULL, is a stringshare, so if you need to
6055     * keep it around even after the button is destroyed, you can use
6056     * eina_stringshare_ref().
6057     *
6058     * @param obj The button object
6059     * @return The text set to the label, or NULL if nothing is set
6060     * @deprecated use elm_object_text_set() instead.
6061     */
6062    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6063    /**
6064     * Set the icon used for the button
6065     *
6066     * Setting a new icon will delete any other that was previously set, making
6067     * any reference to them invalid. If you need to maintain the previous
6068     * object alive, unset it first with elm_button_icon_unset().
6069     *
6070     * @param obj The button object
6071     * @param icon The icon object for the button
6072     */
6073    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6074    /**
6075     * Get the icon used for the button
6076     *
6077     * Return the icon object which is set for this widget. If the button is
6078     * destroyed or another icon is set, the returned object will be deleted
6079     * and any reference to it will be invalid.
6080     *
6081     * @param obj The button object
6082     * @return The icon object that is being used
6083     *
6084     * @see elm_button_icon_unset()
6085     */
6086    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6087    /**
6088     * Remove the icon set without deleting it and return the object
6089     *
6090     * This function drops the reference the button holds of the icon object
6091     * and returns this last object. It is used in case you want to remove any
6092     * icon, or set another one, without deleting the actual object. The button
6093     * will be left without an icon set.
6094     *
6095     * @param obj The button object
6096     * @return The icon object that was being used
6097     */
6098    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6099    /**
6100     * Turn on/off the autorepeat event generated when the button is kept pressed
6101     *
6102     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6103     * signal when they are clicked.
6104     *
6105     * When on, keeping a button pressed will continuously emit a @c repeated
6106     * signal until the button is released. The time it takes until it starts
6107     * emitting the signal is given by
6108     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6109     * new emission by elm_button_autorepeat_gap_timeout_set().
6110     *
6111     * @param obj The button object
6112     * @param on  A bool to turn on/off the event
6113     */
6114    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6115    /**
6116     * Get whether the autorepeat feature is enabled
6117     *
6118     * @param obj The button object
6119     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6120     *
6121     * @see elm_button_autorepeat_set()
6122     */
6123    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6124    /**
6125     * Set the initial timeout before the autorepeat event is generated
6126     *
6127     * Sets the timeout, in seconds, since the button is pressed until the
6128     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6129     * won't be any delay and the even will be fired the moment the button is
6130     * pressed.
6131     *
6132     * @param obj The button object
6133     * @param t   Timeout in seconds
6134     *
6135     * @see elm_button_autorepeat_set()
6136     * @see elm_button_autorepeat_gap_timeout_set()
6137     */
6138    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6139    /**
6140     * Get the initial timeout before the autorepeat event is generated
6141     *
6142     * @param obj The button object
6143     * @return Timeout in seconds
6144     *
6145     * @see elm_button_autorepeat_initial_timeout_set()
6146     */
6147    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6148    /**
6149     * Set the interval between each generated autorepeat event
6150     *
6151     * After the first @c repeated event is fired, all subsequent ones will
6152     * follow after a delay of @p t seconds for each.
6153     *
6154     * @param obj The button object
6155     * @param t   Interval in seconds
6156     *
6157     * @see elm_button_autorepeat_initial_timeout_set()
6158     */
6159    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6160    /**
6161     * Get the interval between each generated autorepeat event
6162     *
6163     * @param obj The button object
6164     * @return Interval in seconds
6165     */
6166    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6167    /**
6168     * @}
6169     */
6170
6171    /**
6172     * @defgroup File_Selector_Button File Selector Button
6173     *
6174     * @image html img/widget/fileselector_button/preview-00.png
6175     * @image latex img/widget/fileselector_button/preview-00.eps
6176     * @image html img/widget/fileselector_button/preview-01.png
6177     * @image latex img/widget/fileselector_button/preview-01.eps
6178     * @image html img/widget/fileselector_button/preview-02.png
6179     * @image latex img/widget/fileselector_button/preview-02.eps
6180     *
6181     * This is a button that, when clicked, creates an Elementary
6182     * window (or inner window) <b> with a @ref Fileselector "file
6183     * selector widget" within</b>. When a file is chosen, the (inner)
6184     * window is closed and the button emits a signal having the
6185     * selected file as it's @c event_info.
6186     *
6187     * This widget encapsulates operations on its internal file
6188     * selector on its own API. There is less control over its file
6189     * selector than that one would have instatiating one directly.
6190     *
6191     * The following styles are available for this button:
6192     * @li @c "default"
6193     * @li @c "anchor"
6194     * @li @c "hoversel_vertical"
6195     * @li @c "hoversel_vertical_entry"
6196     *
6197     * Smart callbacks one can register to:
6198     * - @c "file,chosen" - the user has selected a path, whose string
6199     *   pointer comes as the @c event_info data (a stringshared
6200     *   string)
6201     *
6202     * Here is an example on its usage:
6203     * @li @ref fileselector_button_example
6204     *
6205     * @see @ref File_Selector_Entry for a similar widget.
6206     * @{
6207     */
6208
6209    /**
6210     * Add a new file selector button widget to the given parent
6211     * Elementary (container) object
6212     *
6213     * @param parent The parent object
6214     * @return a new file selector button widget handle or @c NULL, on
6215     * errors
6216     */
6217    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6218
6219    /**
6220     * Set the label for a given file selector button widget
6221     *
6222     * @param obj The file selector button widget
6223     * @param label The text label to be displayed on @p obj
6224     *
6225     * @deprecated use elm_object_text_set() instead.
6226     */
6227    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6228
6229    /**
6230     * Get the label set for a given file selector button widget
6231     *
6232     * @param obj The file selector button widget
6233     * @return The button label
6234     *
6235     * @deprecated use elm_object_text_set() instead.
6236     */
6237    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6238
6239    /**
6240     * Set the icon on a given file selector button widget
6241     *
6242     * @param obj The file selector button widget
6243     * @param icon The icon object for the button
6244     *
6245     * Once the icon object is set, a previously set one will be
6246     * deleted. If you want to keep the latter, use the
6247     * elm_fileselector_button_icon_unset() function.
6248     *
6249     * @see elm_fileselector_button_icon_get()
6250     */
6251    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6252
6253    /**
6254     * Get the icon set for a given file selector button widget
6255     *
6256     * @param obj The file selector button widget
6257     * @return The icon object currently set on @p obj or @c NULL, if
6258     * none is
6259     *
6260     * @see elm_fileselector_button_icon_set()
6261     */
6262    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6263
6264    /**
6265     * Unset the icon used in a given file selector button widget
6266     *
6267     * @param obj The file selector button widget
6268     * @return The icon object that was being used on @p obj or @c
6269     * NULL, on errors
6270     *
6271     * Unparent and return the icon object which was set for this
6272     * widget.
6273     *
6274     * @see elm_fileselector_button_icon_set()
6275     */
6276    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6277
6278    /**
6279     * Set the title for a given file selector button widget's window
6280     *
6281     * @param obj The file selector button widget
6282     * @param title The title string
6283     *
6284     * This will change the window's title, when the file selector pops
6285     * out after a click on the button. Those windows have the default
6286     * (unlocalized) value of @c "Select a file" as titles.
6287     *
6288     * @note It will only take any effect if the file selector
6289     * button widget is @b not under "inwin mode".
6290     *
6291     * @see elm_fileselector_button_window_title_get()
6292     */
6293    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6294
6295    /**
6296     * Get the title set for a given file selector button widget's
6297     * window
6298     *
6299     * @param obj The file selector button widget
6300     * @return Title of the file selector button's window
6301     *
6302     * @see elm_fileselector_button_window_title_get() for more details
6303     */
6304    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6305
6306    /**
6307     * Set the size of a given file selector button widget's window,
6308     * holding the file selector itself.
6309     *
6310     * @param obj The file selector button widget
6311     * @param width The window's width
6312     * @param height The window's height
6313     *
6314     * @note it will only take any effect if the file selector button
6315     * widget is @b not under "inwin mode". The default size for the
6316     * window (when applicable) is 400x400 pixels.
6317     *
6318     * @see elm_fileselector_button_window_size_get()
6319     */
6320    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6321
6322    /**
6323     * Get the size of a given file selector button widget's window,
6324     * holding the file selector itself.
6325     *
6326     * @param obj The file selector button widget
6327     * @param width Pointer into which to store the width value
6328     * @param height Pointer into which to store the height value
6329     *
6330     * @note Use @c NULL pointers on the size values you're not
6331     * interested in: they'll be ignored by the function.
6332     *
6333     * @see elm_fileselector_button_window_size_set(), for more details
6334     */
6335    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6336
6337    /**
6338     * Set the initial file system path for a given file selector
6339     * button widget
6340     *
6341     * @param obj The file selector button widget
6342     * @param path The path string
6343     *
6344     * It must be a <b>directory</b> path, which will have the contents
6345     * displayed initially in the file selector's view, when invoked
6346     * from @p obj. The default initial path is the @c "HOME"
6347     * environment variable's value.
6348     *
6349     * @see elm_fileselector_button_path_get()
6350     */
6351    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6352
6353    /**
6354     * Get the initial file system path set for a given file selector
6355     * button widget
6356     *
6357     * @param obj The file selector button widget
6358     * @return path The path string
6359     *
6360     * @see elm_fileselector_button_path_set() for more details
6361     */
6362    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6363
6364    /**
6365     * Enable/disable a tree view in the given file selector button
6366     * widget's internal file selector
6367     *
6368     * @param obj The file selector button widget
6369     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6370     * disable
6371     *
6372     * This has the same effect as elm_fileselector_expandable_set(),
6373     * but now applied to a file selector button's internal file
6374     * selector.
6375     *
6376     * @note There's no way to put a file selector button's internal
6377     * file selector in "grid mode", as one may do with "pure" file
6378     * selectors.
6379     *
6380     * @see elm_fileselector_expandable_get()
6381     */
6382    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6383
6384    /**
6385     * Get whether tree view is enabled for the given file selector
6386     * button widget's internal file selector
6387     *
6388     * @param obj The file selector button widget
6389     * @return @c EINA_TRUE if @p obj widget's internal file selector
6390     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6391     *
6392     * @see elm_fileselector_expandable_set() for more details
6393     */
6394    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6395
6396    /**
6397     * Set whether a given file selector button widget's internal file
6398     * selector is to display folders only or the directory contents,
6399     * as well.
6400     *
6401     * @param obj The file selector button widget
6402     * @param only @c EINA_TRUE to make @p obj widget's internal file
6403     * selector only display directories, @c EINA_FALSE to make files
6404     * to be displayed in it too
6405     *
6406     * This has the same effect as elm_fileselector_folder_only_set(),
6407     * but now applied to a file selector button's internal file
6408     * selector.
6409     *
6410     * @see elm_fileselector_folder_only_get()
6411     */
6412    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6413
6414    /**
6415     * Get whether a given file selector button widget's internal file
6416     * selector is displaying folders only or the directory contents,
6417     * as well.
6418     *
6419     * @param obj The file selector button widget
6420     * @return @c EINA_TRUE if @p obj widget's internal file
6421     * selector is only displaying directories, @c EINA_FALSE if files
6422     * are being displayed in it too (and on errors)
6423     *
6424     * @see elm_fileselector_button_folder_only_set() for more details
6425     */
6426    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6427
6428    /**
6429     * Enable/disable the file name entry box where the user can type
6430     * in a name for a file, in a given file selector button widget's
6431     * internal file selector.
6432     *
6433     * @param obj The file selector button widget
6434     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6435     * file selector a "saving dialog", @c EINA_FALSE otherwise
6436     *
6437     * This has the same effect as elm_fileselector_is_save_set(),
6438     * but now applied to a file selector button's internal file
6439     * selector.
6440     *
6441     * @see elm_fileselector_is_save_get()
6442     */
6443    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6444
6445    /**
6446     * Get whether the given file selector button widget's internal
6447     * file selector is in "saving dialog" mode
6448     *
6449     * @param obj The file selector button widget
6450     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6451     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6452     * errors)
6453     *
6454     * @see elm_fileselector_button_is_save_set() for more details
6455     */
6456    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6457
6458    /**
6459     * Set whether a given file selector button widget's internal file
6460     * selector will raise an Elementary "inner window", instead of a
6461     * dedicated Elementary window. By default, it won't.
6462     *
6463     * @param obj The file selector button widget
6464     * @param value @c EINA_TRUE to make it use an inner window, @c
6465     * EINA_TRUE to make it use a dedicated window
6466     *
6467     * @see elm_win_inwin_add() for more information on inner windows
6468     * @see elm_fileselector_button_inwin_mode_get()
6469     */
6470    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6471
6472    /**
6473     * Get whether a given file selector button widget's internal file
6474     * selector will raise an Elementary "inner window", instead of a
6475     * dedicated Elementary window.
6476     *
6477     * @param obj The file selector button widget
6478     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6479     * if it will use a dedicated window
6480     *
6481     * @see elm_fileselector_button_inwin_mode_set() for more details
6482     */
6483    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6484
6485    /**
6486     * @}
6487     */
6488
6489     /**
6490     * @defgroup File_Selector_Entry File Selector Entry
6491     *
6492     * @image html img/widget/fileselector_entry/preview-00.png
6493     * @image latex img/widget/fileselector_entry/preview-00.eps
6494     *
6495     * This is an entry made to be filled with or display a <b>file
6496     * system path string</b>. Besides the entry itself, the widget has
6497     * a @ref File_Selector_Button "file selector button" on its side,
6498     * which will raise an internal @ref Fileselector "file selector widget",
6499     * when clicked, for path selection aided by file system
6500     * navigation.
6501     *
6502     * This file selector may appear in an Elementary window or in an
6503     * inner window. When a file is chosen from it, the (inner) window
6504     * is closed and the selected file's path string is exposed both as
6505     * an smart event and as the new text on the entry.
6506     *
6507     * This widget encapsulates operations on its internal file
6508     * selector on its own API. There is less control over its file
6509     * selector than that one would have instatiating one directly.
6510     *
6511     * Smart callbacks one can register to:
6512     * - @c "changed" - The text within the entry was changed
6513     * - @c "activated" - The entry has had editing finished and
6514     *   changes are to be "committed"
6515     * - @c "press" - The entry has been clicked
6516     * - @c "longpressed" - The entry has been clicked (and held) for a
6517     *   couple seconds
6518     * - @c "clicked" - The entry has been clicked
6519     * - @c "clicked,double" - The entry has been double clicked
6520     * - @c "focused" - The entry has received focus
6521     * - @c "unfocused" - The entry has lost focus
6522     * - @c "selection,paste" - A paste action has occurred on the
6523     *   entry
6524     * - @c "selection,copy" - A copy action has occurred on the entry
6525     * - @c "selection,cut" - A cut action has occurred on the entry
6526     * - @c "unpressed" - The file selector entry's button was released
6527     *   after being pressed.
6528     * - @c "file,chosen" - The user has selected a path via the file
6529     *   selector entry's internal file selector, whose string pointer
6530     *   comes as the @c event_info data (a stringshared string)
6531     *
6532     * Here is an example on its usage:
6533     * @li @ref fileselector_entry_example
6534     *
6535     * @see @ref File_Selector_Button for a similar widget.
6536     * @{
6537     */
6538
6539    /**
6540     * Add a new file selector entry widget to the given parent
6541     * Elementary (container) object
6542     *
6543     * @param parent The parent object
6544     * @return a new file selector entry widget handle or @c NULL, on
6545     * errors
6546     */
6547    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6548
6549    /**
6550     * Set the label for a given file selector entry widget's button
6551     *
6552     * @param obj The file selector entry widget
6553     * @param label The text label to be displayed on @p obj widget's
6554     * button
6555     *
6556     * @deprecated use elm_object_text_set() instead.
6557     */
6558    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6559
6560    /**
6561     * Get the label set for a given file selector entry widget's button
6562     *
6563     * @param obj The file selector entry widget
6564     * @return The widget button's label
6565     *
6566     * @deprecated use elm_object_text_set() instead.
6567     */
6568    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569
6570    /**
6571     * Set the icon on a given file selector entry widget's button
6572     *
6573     * @param obj The file selector entry widget
6574     * @param icon The icon object for the entry's button
6575     *
6576     * Once the icon object is set, a previously set one will be
6577     * deleted. If you want to keep the latter, use the
6578     * elm_fileselector_entry_button_icon_unset() function.
6579     *
6580     * @see elm_fileselector_entry_button_icon_get()
6581     */
6582    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6583
6584    /**
6585     * Get the icon set for a given file selector entry widget's button
6586     *
6587     * @param obj The file selector entry widget
6588     * @return The icon object currently set on @p obj widget's button
6589     * or @c NULL, if none is
6590     *
6591     * @see elm_fileselector_entry_button_icon_set()
6592     */
6593    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6594
6595    /**
6596     * Unset the icon used in a given file selector entry widget's
6597     * button
6598     *
6599     * @param obj The file selector entry widget
6600     * @return The icon object that was being used on @p obj widget's
6601     * button or @c NULL, on errors
6602     *
6603     * Unparent and return the icon object which was set for this
6604     * widget's button.
6605     *
6606     * @see elm_fileselector_entry_button_icon_set()
6607     */
6608    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6609
6610    /**
6611     * Set the title for a given file selector entry widget's window
6612     *
6613     * @param obj The file selector entry widget
6614     * @param title The title string
6615     *
6616     * This will change the window's title, when the file selector pops
6617     * out after a click on the entry's button. Those windows have the
6618     * default (unlocalized) value of @c "Select a file" as titles.
6619     *
6620     * @note It will only take any effect if the file selector
6621     * entry widget is @b not under "inwin mode".
6622     *
6623     * @see elm_fileselector_entry_window_title_get()
6624     */
6625    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6626
6627    /**
6628     * Get the title set for a given file selector entry widget's
6629     * window
6630     *
6631     * @param obj The file selector entry widget
6632     * @return Title of the file selector entry's window
6633     *
6634     * @see elm_fileselector_entry_window_title_get() for more details
6635     */
6636    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6637
6638    /**
6639     * Set the size of a given file selector entry widget's window,
6640     * holding the file selector itself.
6641     *
6642     * @param obj The file selector entry widget
6643     * @param width The window's width
6644     * @param height The window's height
6645     *
6646     * @note it will only take any effect if the file selector entry
6647     * widget is @b not under "inwin mode". The default size for the
6648     * window (when applicable) is 400x400 pixels.
6649     *
6650     * @see elm_fileselector_entry_window_size_get()
6651     */
6652    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6653
6654    /**
6655     * Get the size of a given file selector entry widget's window,
6656     * holding the file selector itself.
6657     *
6658     * @param obj The file selector entry widget
6659     * @param width Pointer into which to store the width value
6660     * @param height Pointer into which to store the height value
6661     *
6662     * @note Use @c NULL pointers on the size values you're not
6663     * interested in: they'll be ignored by the function.
6664     *
6665     * @see elm_fileselector_entry_window_size_set(), for more details
6666     */
6667    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6668
6669    /**
6670     * Set the initial file system path and the entry's path string for
6671     * a given file selector entry widget
6672     *
6673     * @param obj The file selector entry widget
6674     * @param path The path string
6675     *
6676     * It must be a <b>directory</b> path, which will have the contents
6677     * displayed initially in the file selector's view, when invoked
6678     * from @p obj. The default initial path is the @c "HOME"
6679     * environment variable's value.
6680     *
6681     * @see elm_fileselector_entry_path_get()
6682     */
6683    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6684
6685    /**
6686     * Get the entry's path string for a given file selector entry
6687     * widget
6688     *
6689     * @param obj The file selector entry widget
6690     * @return path The path string
6691     *
6692     * @see elm_fileselector_entry_path_set() for more details
6693     */
6694    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6695
6696    /**
6697     * Enable/disable a tree view in the given file selector entry
6698     * widget's internal file selector
6699     *
6700     * @param obj The file selector entry widget
6701     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6702     * disable
6703     *
6704     * This has the same effect as elm_fileselector_expandable_set(),
6705     * but now applied to a file selector entry's internal file
6706     * selector.
6707     *
6708     * @note There's no way to put a file selector entry's internal
6709     * file selector in "grid mode", as one may do with "pure" file
6710     * selectors.
6711     *
6712     * @see elm_fileselector_expandable_get()
6713     */
6714    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6715
6716    /**
6717     * Get whether tree view is enabled for the given file selector
6718     * entry widget's internal file selector
6719     *
6720     * @param obj The file selector entry widget
6721     * @return @c EINA_TRUE if @p obj widget's internal file selector
6722     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6723     *
6724     * @see elm_fileselector_expandable_set() for more details
6725     */
6726    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6727
6728    /**
6729     * Set whether a given file selector entry widget's internal file
6730     * selector is to display folders only or the directory contents,
6731     * as well.
6732     *
6733     * @param obj The file selector entry widget
6734     * @param only @c EINA_TRUE to make @p obj widget's internal file
6735     * selector only display directories, @c EINA_FALSE to make files
6736     * to be displayed in it too
6737     *
6738     * This has the same effect as elm_fileselector_folder_only_set(),
6739     * but now applied to a file selector entry's internal file
6740     * selector.
6741     *
6742     * @see elm_fileselector_folder_only_get()
6743     */
6744    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6745
6746    /**
6747     * Get whether a given file selector entry widget's internal file
6748     * selector is displaying folders only or the directory contents,
6749     * as well.
6750     *
6751     * @param obj The file selector entry widget
6752     * @return @c EINA_TRUE if @p obj widget's internal file
6753     * selector is only displaying directories, @c EINA_FALSE if files
6754     * are being displayed in it too (and on errors)
6755     *
6756     * @see elm_fileselector_entry_folder_only_set() for more details
6757     */
6758    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6759
6760    /**
6761     * Enable/disable the file name entry box where the user can type
6762     * in a name for a file, in a given file selector entry widget's
6763     * internal file selector.
6764     *
6765     * @param obj The file selector entry widget
6766     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6767     * file selector a "saving dialog", @c EINA_FALSE otherwise
6768     *
6769     * This has the same effect as elm_fileselector_is_save_set(),
6770     * but now applied to a file selector entry's internal file
6771     * selector.
6772     *
6773     * @see elm_fileselector_is_save_get()
6774     */
6775    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6776
6777    /**
6778     * Get whether the given file selector entry widget's internal
6779     * file selector is in "saving dialog" mode
6780     *
6781     * @param obj The file selector entry widget
6782     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6783     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6784     * errors)
6785     *
6786     * @see elm_fileselector_entry_is_save_set() for more details
6787     */
6788    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6789
6790    /**
6791     * Set whether a given file selector entry widget's internal file
6792     * selector will raise an Elementary "inner window", instead of a
6793     * dedicated Elementary window. By default, it won't.
6794     *
6795     * @param obj The file selector entry widget
6796     * @param value @c EINA_TRUE to make it use an inner window, @c
6797     * EINA_TRUE to make it use a dedicated window
6798     *
6799     * @see elm_win_inwin_add() for more information on inner windows
6800     * @see elm_fileselector_entry_inwin_mode_get()
6801     */
6802    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6803
6804    /**
6805     * Get whether a given file selector entry widget's internal file
6806     * selector will raise an Elementary "inner window", instead of a
6807     * dedicated Elementary window.
6808     *
6809     * @param obj The file selector entry widget
6810     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6811     * if it will use a dedicated window
6812     *
6813     * @see elm_fileselector_entry_inwin_mode_set() for more details
6814     */
6815    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6816
6817    /**
6818     * Set the initial file system path for a given file selector entry
6819     * widget
6820     *
6821     * @param obj The file selector entry widget
6822     * @param path The path string
6823     *
6824     * It must be a <b>directory</b> path, which will have the contents
6825     * displayed initially in the file selector's view, when invoked
6826     * from @p obj. The default initial path is the @c "HOME"
6827     * environment variable's value.
6828     *
6829     * @see elm_fileselector_entry_path_get()
6830     */
6831    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6832
6833    /**
6834     * Get the parent directory's path to the latest file selection on
6835     * a given filer selector entry widget
6836     *
6837     * @param obj The file selector object
6838     * @return The (full) path of the directory of the last selection
6839     * on @p obj widget, a @b stringshared string
6840     *
6841     * @see elm_fileselector_entry_path_set()
6842     */
6843    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6844
6845    /**
6846     * @}
6847     */
6848
6849    /**
6850     * @defgroup Scroller Scroller
6851     *
6852     * A scroller holds a single object and "scrolls it around". This means that
6853     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6854     * region around, allowing to move through a much larger object that is
6855     * contained in the scroller. The scroiller will always have a small minimum
6856     * size by default as it won't be limited by the contents of the scroller.
6857     *
6858     * Signals that you can add callbacks for are:
6859     * @li "edge,left" - the left edge of the content has been reached
6860     * @li "edge,right" - the right edge of the content has been reached
6861     * @li "edge,top" - the top edge of the content has been reached
6862     * @li "edge,bottom" - the bottom edge of the content has been reached
6863     * @li "scroll" - the content has been scrolled (moved)
6864     * @li "scroll,anim,start" - scrolling animation has started
6865     * @li "scroll,anim,stop" - scrolling animation has stopped
6866     * @li "scroll,drag,start" - dragging the contents around has started
6867     * @li "scroll,drag,stop" - dragging the contents around has stopped
6868     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6869     * user intervetion.
6870     *
6871     * @note When Elemementary is in embedded mode the scrollbars will not be
6872     * dragable, they appear merely as indicators of how much has been scrolled.
6873     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6874     * fingerscroll) won't work.
6875     *
6876     * In @ref tutorial_scroller you'll find an example of how to use most of
6877     * this API.
6878     * @{
6879     */
6880    /**
6881     * @brief Type that controls when scrollbars should appear.
6882     *
6883     * @see elm_scroller_policy_set()
6884     */
6885    typedef enum _Elm_Scroller_Policy
6886      {
6887         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6888         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6889         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6890         ELM_SCROLLER_POLICY_LAST
6891      } Elm_Scroller_Policy;
6892    /**
6893     * @brief Add a new scroller to the parent
6894     *
6895     * @param parent The parent object
6896     * @return The new object or NULL if it cannot be created
6897     */
6898    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6899    /**
6900     * @brief Set the content of the scroller widget (the object to be scrolled around).
6901     *
6902     * @param obj The scroller object
6903     * @param content The new content object
6904     *
6905     * Once the content object is set, a previously set one will be deleted.
6906     * If you want to keep that old content object, use the
6907     * elm_scroller_content_unset() function.
6908     */
6909    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6910    /**
6911     * @brief Get the content of the scroller widget
6912     *
6913     * @param obj The slider object
6914     * @return The content that is being used
6915     *
6916     * Return the content object which is set for this widget
6917     *
6918     * @see elm_scroller_content_set()
6919     */
6920    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6921    /**
6922     * @brief Unset the content of the scroller widget
6923     *
6924     * @param obj The slider object
6925     * @return The content that was being used
6926     *
6927     * Unparent and return the content object which was set for this widget
6928     *
6929     * @see elm_scroller_content_set()
6930     */
6931    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6932    /**
6933     * @brief Set custom theme elements for the scroller
6934     *
6935     * @param obj The scroller object
6936     * @param widget The widget name to use (default is "scroller")
6937     * @param base The base name to use (default is "base")
6938     */
6939    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6940    /**
6941     * @brief Make the scroller minimum size limited to the minimum size of the content
6942     *
6943     * @param obj The scroller object
6944     * @param w Enable limiting minimum size horizontally
6945     * @param h Enable limiting minimum size vertically
6946     *
6947     * By default the scroller will be as small as its design allows,
6948     * irrespective of its content. This will make the scroller minimum size the
6949     * right size horizontally and/or vertically to perfectly fit its content in
6950     * that direction.
6951     */
6952    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6953    /**
6954     * @brief Show a specific virtual region within the scroller content object
6955     *
6956     * @param obj The scroller object
6957     * @param x X coordinate of the region
6958     * @param y Y coordinate of the region
6959     * @param w Width of the region
6960     * @param h Height of the region
6961     *
6962     * This will ensure all (or part if it does not fit) of the designated
6963     * region in the virtual content object (0, 0 starting at the top-left of the
6964     * virtual content object) is shown within the scroller.
6965     */
6966    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);
6967    /**
6968     * @brief Set the scrollbar visibility policy
6969     *
6970     * @param obj The scroller object
6971     * @param policy_h Horizontal scrollbar policy
6972     * @param policy_v Vertical scrollbar policy
6973     *
6974     * This sets the scrollbar visibility policy for the given scroller.
6975     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6976     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6977     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6978     * respectively for the horizontal and vertical scrollbars.
6979     */
6980    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6981    /**
6982     * @brief Gets scrollbar visibility policy
6983     *
6984     * @param obj The scroller object
6985     * @param policy_h Horizontal scrollbar policy
6986     * @param policy_v Vertical scrollbar policy
6987     *
6988     * @see elm_scroller_policy_set()
6989     */
6990    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6991    /**
6992     * @brief Get the currently visible content region
6993     *
6994     * @param obj The scroller object
6995     * @param x X coordinate of the region
6996     * @param y Y coordinate of the region
6997     * @param w Width of the region
6998     * @param h Height of the region
6999     *
7000     * This gets the current region in the content object that is visible through
7001     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7002     * w, @p h values pointed to.
7003     *
7004     * @note All coordinates are relative to the content.
7005     *
7006     * @see elm_scroller_region_show()
7007     */
7008    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);
7009    /**
7010     * @brief Get the size of the content object
7011     *
7012     * @param obj The scroller object
7013     * @param w Width return
7014     * @param h Height return
7015     *
7016     * This gets the size of the content object of the scroller.
7017     */
7018    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7019    /**
7020     * @brief Set bouncing behavior
7021     *
7022     * @param obj The scroller object
7023     * @param h_bounce Will the scroller bounce horizontally or not
7024     * @param v_bounce Will the scroller bounce vertically or not
7025     *
7026     * When scrolling, the scroller may "bounce" when reaching an edge of the
7027     * content object. This is a visual way to indicate the end has been reached.
7028     * This is enabled by default for both axis. This will set if it is enabled
7029     * for that axis with the boolean parameters for each axis.
7030     */
7031    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7032    /**
7033     * @brief Get the bounce mode
7034     *
7035     * @param obj The Scroller object
7036     * @param h_bounce Allow bounce horizontally
7037     * @param v_bounce Allow bounce vertically
7038     *
7039     * @see elm_scroller_bounce_set()
7040     */
7041    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7042    /**
7043     * @brief Set scroll page size relative to viewport size.
7044     *
7045     * @param obj The scroller object
7046     * @param h_pagerel The horizontal page relative size
7047     * @param v_pagerel The vertical page relative size
7048     *
7049     * The scroller is capable of limiting scrolling by the user to "pages". That
7050     * is to jump by and only show a "whole page" at a time as if the continuous
7051     * area of the scroller content is split into page sized pieces. This sets
7052     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7053     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7054     * axis. This is mutually exclusive with page size
7055     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7056     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7057     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7058     * the other axis.
7059     */
7060    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7061    /**
7062     * @brief Set scroll page size.
7063     *
7064     * @param obj The scroller object
7065     * @param h_pagesize The horizontal page size
7066     * @param v_pagesize The vertical page size
7067     *
7068     * This sets the page size to an absolute fixed value, with 0 turning it off
7069     * for that axis.
7070     *
7071     * @see elm_scroller_page_relative_set()
7072     */
7073    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7074    /**
7075     * @brief Get scroll current page number.
7076     *
7077     * @param obj The scroller object
7078     * @param h_pagenumber The horizontal page number
7079     * @param v_pagenumber The vertical page number
7080     *
7081     * The page number starts from 0. 0 is the first page.
7082     * Current page means the page which meet the top-left of the viewport.
7083     * If there are two or more pages in the viewport, it returns the number of page
7084     * which meet the top-left of the viewport.
7085     *
7086     * @see elm_scroller_last_page_get()
7087     * @see elm_scroller_page_show()
7088     * @see elm_scroller_page_brint_in()
7089     */
7090    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7091    /**
7092     * @brief Get scroll last page number.
7093     *
7094     * @param obj The scroller object
7095     * @param h_pagenumber The horizontal page number
7096     * @param v_pagenumber The vertical page number
7097     *
7098     * The page number starts from 0. 0 is the first page.
7099     * This returns the last page number among the pages.
7100     *
7101     * @see elm_scroller_current_page_get()
7102     * @see elm_scroller_page_show()
7103     * @see elm_scroller_page_brint_in()
7104     */
7105    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7106    /**
7107     * Show a specific virtual region within the scroller content object by page number.
7108     *
7109     * @param obj The scroller object
7110     * @param h_pagenumber The horizontal page number
7111     * @param v_pagenumber The vertical page number
7112     *
7113     * 0, 0 of the indicated page is located at the top-left of the viewport.
7114     * This will jump to the page directly without animation.
7115     *
7116     * Example of usage:
7117     *
7118     * @code
7119     * sc = elm_scroller_add(win);
7120     * elm_scroller_content_set(sc, content);
7121     * elm_scroller_page_relative_set(sc, 1, 0);
7122     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7123     * elm_scroller_page_show(sc, h_page + 1, v_page);
7124     * @endcode
7125     *
7126     * @see elm_scroller_page_bring_in()
7127     */
7128    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7129    /**
7130     * Show a specific virtual region within the scroller content object by page number.
7131     *
7132     * @param obj The scroller object
7133     * @param h_pagenumber The horizontal page number
7134     * @param v_pagenumber The vertical page number
7135     *
7136     * 0, 0 of the indicated page is located at the top-left of the viewport.
7137     * This will slide to the page with animation.
7138     *
7139     * Example of usage:
7140     *
7141     * @code
7142     * sc = elm_scroller_add(win);
7143     * elm_scroller_content_set(sc, content);
7144     * elm_scroller_page_relative_set(sc, 1, 0);
7145     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7146     * elm_scroller_page_bring_in(sc, h_page, v_page);
7147     * @endcode
7148     *
7149     * @see elm_scroller_page_show()
7150     */
7151    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7152    /**
7153     * @brief Show a specific virtual region within the scroller content object.
7154     *
7155     * @param obj The scroller object
7156     * @param x X coordinate of the region
7157     * @param y Y coordinate of the region
7158     * @param w Width of the region
7159     * @param h Height of the region
7160     *
7161     * This will ensure all (or part if it does not fit) of the designated
7162     * region in the virtual content object (0, 0 starting at the top-left of the
7163     * virtual content object) is shown within the scroller. Unlike
7164     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7165     * to this location (if configuration in general calls for transitions). It
7166     * may not jump immediately to the new location and make take a while and
7167     * show other content along the way.
7168     *
7169     * @see elm_scroller_region_show()
7170     */
7171    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);
7172    /**
7173     * @brief Set event propagation on a scroller
7174     *
7175     * @param obj The scroller object
7176     * @param propagation If propagation is enabled or not
7177     *
7178     * This enables or disabled event propagation from the scroller content to
7179     * the scroller and its parent. By default event propagation is disabled.
7180     */
7181    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7182    /**
7183     * @brief Get event propagation for a scroller
7184     *
7185     * @param obj The scroller object
7186     * @return The propagation state
7187     *
7188     * This gets the event propagation for a scroller.
7189     *
7190     * @see elm_scroller_propagate_events_set()
7191     */
7192    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7193    /**
7194     * @}
7195     */
7196
7197    /**
7198     * @defgroup Label Label
7199     *
7200     * @image html img/widget/label/preview-00.png
7201     * @image latex img/widget/label/preview-00.eps
7202     *
7203     * @brief Widget to display text, with simple html-like markup.
7204     *
7205     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7206     * text doesn't fit the geometry of the label it will be ellipsized or be
7207     * cut. Elementary provides several themes for this widget:
7208     * @li default - No animation
7209     * @li marker - Centers the text in the label and make it bold by default
7210     * @li slide_long - The entire text appears from the right of the screen and
7211     * slides until it disappears in the left of the screen(reappering on the
7212     * right again).
7213     * @li slide_short - The text appears in the left of the label and slides to
7214     * the right to show the overflow. When all of the text has been shown the
7215     * position is reset.
7216     * @li slide_bounce - The text appears in the left of the label and slides to
7217     * the right to show the overflow. When all of the text has been shown the
7218     * animation reverses, moving the text to the left.
7219     *
7220     * Custom themes can of course invent new markup tags and style them any way
7221     * they like.
7222     *
7223     * See @ref tutorial_label for a demonstration of how to use a label widget.
7224     * @{
7225     */
7226    /**
7227     * @brief Add a new label to the parent
7228     *
7229     * @param parent The parent object
7230     * @return The new object or NULL if it cannot be created
7231     */
7232    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7233    /**
7234     * @brief Set the label on the label object
7235     *
7236     * @param obj The label object
7237     * @param label The label will be used on the label object
7238     * @deprecated See elm_object_text_set()
7239     */
7240    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 */
7241    /**
7242     * @brief Get the label used on the label object
7243     *
7244     * @param obj The label object
7245     * @return The string inside the label
7246     * @deprecated See elm_object_text_get()
7247     */
7248    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7249    /**
7250     * @brief Set the wrapping behavior of the label
7251     *
7252     * @param obj The label object
7253     * @param wrap To wrap text or not
7254     *
7255     * By default no wrapping is done. Possible values for @p wrap are:
7256     * @li ELM_WRAP_NONE - No wrapping
7257     * @li ELM_WRAP_CHAR - wrap between characters
7258     * @li ELM_WRAP_WORD - wrap between words
7259     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7260     */
7261    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7262    /**
7263     * @brief Get the wrapping behavior of the label
7264     *
7265     * @param obj The label object
7266     * @return Wrap type
7267     *
7268     * @see elm_label_line_wrap_set()
7269     */
7270    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7271    /**
7272     * @brief Set wrap width of the label
7273     *
7274     * @param obj The label object
7275     * @param w The wrap width in pixels at a minimum where words need to wrap
7276     *
7277     * This function sets the maximum width size hint of the label.
7278     *
7279     * @warning This is only relevant if the label is inside a container.
7280     */
7281    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7282    /**
7283     * @brief Get wrap width of the label
7284     *
7285     * @param obj The label object
7286     * @return The wrap width in pixels at a minimum where words need to wrap
7287     *
7288     * @see elm_label_wrap_width_set()
7289     */
7290    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7291    /**
7292     * @brief Set wrap height of the label
7293     *
7294     * @param obj The label object
7295     * @param h The wrap height in pixels at a minimum where words need to wrap
7296     *
7297     * This function sets the maximum height size hint of the label.
7298     *
7299     * @warning This is only relevant if the label is inside a container.
7300     */
7301    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7302    /**
7303     * @brief get wrap width of the label
7304     *
7305     * @param obj The label object
7306     * @return The wrap height in pixels at a minimum where words need to wrap
7307     */
7308    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7309    /**
7310     * @brief Set the font size on the label object.
7311     *
7312     * @param obj The label object
7313     * @param size font size
7314     *
7315     * @warning NEVER use this. It is for hyper-special cases only. use styles
7316     * instead. e.g. "big", "medium", "small" - or better name them by use:
7317     * "title", "footnote", "quote" etc.
7318     */
7319    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7320    /**
7321     * @brief Set the text color on the label object
7322     *
7323     * @param obj The label object
7324     * @param r Red property background color of The label object
7325     * @param g Green property background color of The label object
7326     * @param b Blue property background color of The label object
7327     * @param a Alpha property background color of The label object
7328     *
7329     * @warning NEVER use this. It is for hyper-special cases only. use styles
7330     * instead. e.g. "big", "medium", "small" - or better name them by use:
7331     * "title", "footnote", "quote" etc.
7332     */
7333    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);
7334    /**
7335     * @brief Set the text align on the label object
7336     *
7337     * @param obj The label object
7338     * @param align align mode ("left", "center", "right")
7339     *
7340     * @warning NEVER use this. It is for hyper-special cases only. use styles
7341     * instead. e.g. "big", "medium", "small" - or better name them by use:
7342     * "title", "footnote", "quote" etc.
7343     */
7344    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7345    /**
7346     * @brief Set background color of the label
7347     *
7348     * @param obj The label object
7349     * @param r Red property background color of The label object
7350     * @param g Green property background color of The label object
7351     * @param b Blue property background color of The label object
7352     * @param a Alpha property background alpha of The label object
7353     *
7354     * @warning NEVER use this. It is for hyper-special cases only. use styles
7355     * instead. e.g. "big", "medium", "small" - or better name them by use:
7356     * "title", "footnote", "quote" etc.
7357     */
7358    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);
7359    /**
7360     * @brief Set the ellipsis behavior of the label
7361     *
7362     * @param obj The label object
7363     * @param ellipsis To ellipsis text or not
7364     *
7365     * If set to true and the text doesn't fit in the label an ellipsis("...")
7366     * will be shown at the end of the widget.
7367     *
7368     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7369     * choosen wrap method was ELM_WRAP_WORD.
7370     */
7371    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7372    /**
7373     * @brief Set the text slide of the label
7374     *
7375     * @param obj The label object
7376     * @param slide To start slide or stop
7377     *
7378     * If set to true the text of the label will slide throught the length of
7379     * label.
7380     *
7381     * @warning This only work with the themes "slide_short", "slide_long" and
7382     * "slide_bounce".
7383     */
7384    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7385    /**
7386     * @brief Get the text slide mode of the label
7387     *
7388     * @param obj The label object
7389     * @return slide slide mode value
7390     *
7391     * @see elm_label_slide_set()
7392     */
7393    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7394    /**
7395     * @brief Set the slide duration(speed) of the label
7396     *
7397     * @param obj The label object
7398     * @return The duration in seconds in moving text from slide begin position
7399     * to slide end position
7400     */
7401    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7402    /**
7403     * @brief Get the slide duration(speed) of the label
7404     *
7405     * @param obj The label object
7406     * @return The duration time in moving text from slide begin position to slide end position
7407     *
7408     * @see elm_label_slide_duration_set()
7409     */
7410    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7411    /**
7412     * @}
7413     */
7414
7415    /**
7416     * @defgroup Toggle Toggle
7417     *
7418     * @image html img/widget/toggle/preview-00.png
7419     * @image latex img/widget/toggle/preview-00.eps
7420     *
7421     * @brief A toggle is a slider which can be used to toggle between
7422     * two values.  It has two states: on and off.
7423     *
7424     * Signals that you can add callbacks for are:
7425     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7426     *                 until the toggle is released by the cursor (assuming it
7427     *                 has been triggered by the cursor in the first place).
7428     *
7429     * @ref tutorial_toggle show how to use a toggle.
7430     * @{
7431     */
7432    /**
7433     * @brief Add a toggle to @p parent.
7434     *
7435     * @param parent The parent object
7436     *
7437     * @return The toggle object
7438     */
7439    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7440    /**
7441     * @brief Sets the label to be displayed with the toggle.
7442     *
7443     * @param obj The toggle object
7444     * @param label The label to be displayed
7445     *
7446     * @deprecated use elm_object_text_set() instead.
7447     */
7448    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7449    /**
7450     * @brief Gets the label of the toggle
7451     *
7452     * @param obj  toggle object
7453     * @return The label of the toggle
7454     *
7455     * @deprecated use elm_object_text_get() instead.
7456     */
7457    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7458    /**
7459     * @brief Set the icon used for the toggle
7460     *
7461     * @param obj The toggle object
7462     * @param icon The icon object for the button
7463     *
7464     * Once the icon object is set, a previously set one will be deleted
7465     * If you want to keep that old content object, use the
7466     * elm_toggle_icon_unset() function.
7467     */
7468    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7469    /**
7470     * @brief Get the icon used for the toggle
7471     *
7472     * @param obj The toggle object
7473     * @return The icon object that is being used
7474     *
7475     * Return the icon object which is set for this widget.
7476     *
7477     * @see elm_toggle_icon_set()
7478     */
7479    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7480    /**
7481     * @brief Unset the icon used for the toggle
7482     *
7483     * @param obj The toggle object
7484     * @return The icon object that was being used
7485     *
7486     * Unparent and return the icon object which was set for this widget.
7487     *
7488     * @see elm_toggle_icon_set()
7489     */
7490    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7491    /**
7492     * @brief Sets the labels to be associated with the on and off states of the toggle.
7493     *
7494     * @param obj The toggle object
7495     * @param onlabel The label displayed when the toggle is in the "on" state
7496     * @param offlabel The label displayed when the toggle is in the "off" state
7497     */
7498    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7499    /**
7500     * @brief Gets the labels associated with the on and off states of the toggle.
7501     *
7502     * @param obj The toggle object
7503     * @param onlabel A char** to place the onlabel of @p obj into
7504     * @param offlabel A char** to place the offlabel of @p obj into
7505     */
7506    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7507    /**
7508     * @brief Sets the state of the toggle to @p state.
7509     *
7510     * @param obj The toggle object
7511     * @param state The state of @p obj
7512     */
7513    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7514    /**
7515     * @brief Gets the state of the toggle to @p state.
7516     *
7517     * @param obj The toggle object
7518     * @return The state of @p obj
7519     */
7520    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7521    /**
7522     * @brief Sets the state pointer of the toggle to @p statep.
7523     *
7524     * @param obj The toggle object
7525     * @param statep The state pointer of @p obj
7526     */
7527    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7528    /**
7529     * @}
7530     */
7531
7532    /**
7533     * @defgroup Frame Frame
7534     *
7535     * @image html img/widget/frame/preview-00.png
7536     * @image latex img/widget/frame/preview-00.eps
7537     *
7538     * @brief Frame is a widget that holds some content and has a title.
7539     *
7540     * The default look is a frame with a title, but Frame supports multple
7541     * styles:
7542     * @li default
7543     * @li pad_small
7544     * @li pad_medium
7545     * @li pad_large
7546     * @li pad_huge
7547     * @li outdent_top
7548     * @li outdent_bottom
7549     *
7550     * Of all this styles only default shows the title. Frame emits no signals.
7551     *
7552     * For a detailed example see the @ref tutorial_frame.
7553     *
7554     * @{
7555     */
7556    /**
7557     * @brief Add a new frame to the parent
7558     *
7559     * @param parent The parent object
7560     * @return The new object or NULL if it cannot be created
7561     */
7562    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7563    /**
7564     * @brief Set the frame label
7565     *
7566     * @param obj The frame object
7567     * @param label The label of this frame object
7568     *
7569     * @deprecated use elm_object_text_set() instead.
7570     */
7571    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7572    /**
7573     * @brief Get the frame label
7574     *
7575     * @param obj The frame object
7576     *
7577     * @return The label of this frame objet or NULL if unable to get frame
7578     *
7579     * @deprecated use elm_object_text_get() instead.
7580     */
7581    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7582    /**
7583     * @brief Set the content of the frame widget
7584     *
7585     * Once the content object is set, a previously set one will be deleted.
7586     * If you want to keep that old content object, use the
7587     * elm_frame_content_unset() function.
7588     *
7589     * @param obj The frame object
7590     * @param content The content will be filled in this frame object
7591     */
7592    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7593    /**
7594     * @brief Get the content of the frame widget
7595     *
7596     * Return the content object which is set for this widget
7597     *
7598     * @param obj The frame object
7599     * @return The content that is being used
7600     */
7601    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7602    /**
7603     * @brief Unset the content of the frame widget
7604     *
7605     * Unparent and return the content object which was set for this widget
7606     *
7607     * @param obj The frame object
7608     * @return The content that was being used
7609     */
7610    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7611    /**
7612     * @}
7613     */
7614
7615    /**
7616     * @defgroup Table Table
7617     *
7618     * A container widget to arrange other widgets in a table where items can
7619     * also span multiple columns or rows - even overlap (and then be raised or
7620     * lowered accordingly to adjust stacking if they do overlap).
7621     *
7622     * The followin are examples of how to use a table:
7623     * @li @ref tutorial_table_01
7624     * @li @ref tutorial_table_02
7625     *
7626     * @{
7627     */
7628    /**
7629     * @brief Add a new table to the parent
7630     *
7631     * @param parent The parent object
7632     * @return The new object or NULL if it cannot be created
7633     */
7634    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7635    /**
7636     * @brief Set the homogeneous layout in the table
7637     *
7638     * @param obj The layout object
7639     * @param homogeneous A boolean to set if the layout is homogeneous in the
7640     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7641     */
7642    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7643    /**
7644     * @brief Get the current table homogeneous mode.
7645     *
7646     * @param obj The table object
7647     * @return A boolean to indicating if the layout is homogeneous in the table
7648     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7649     */
7650    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7651    /**
7652     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7653     */
7654    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7655    /**
7656     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7657     */
7658    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7659    /**
7660     * @brief Set padding between cells.
7661     *
7662     * @param obj The layout object.
7663     * @param horizontal set the horizontal padding.
7664     * @param vertical set the vertical padding.
7665     *
7666     * Default value is 0.
7667     */
7668    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7669    /**
7670     * @brief Get padding between cells.
7671     *
7672     * @param obj The layout object.
7673     * @param horizontal set the horizontal padding.
7674     * @param vertical set the vertical padding.
7675     */
7676    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7677    /**
7678     * @brief Add a subobject on the table with the coordinates passed
7679     *
7680     * @param obj The table object
7681     * @param subobj The subobject to be added to the table
7682     * @param x Row number
7683     * @param y Column number
7684     * @param w rowspan
7685     * @param h colspan
7686     *
7687     * @note All positioning inside the table is relative to rows and columns, so
7688     * a value of 0 for x and y, means the top left cell of the table, and a
7689     * value of 1 for w and h means @p subobj only takes that 1 cell.
7690     */
7691    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7692    /**
7693     * @brief Remove child from table.
7694     *
7695     * @param obj The table object
7696     * @param subobj The subobject
7697     */
7698    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7699    /**
7700     * @brief Faster way to remove all child objects from a table object.
7701     *
7702     * @param obj The table object
7703     * @param clear If true, will delete children, else just remove from table.
7704     */
7705    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7706    /**
7707     * @brief Set the packing location of an existing child of the table
7708     *
7709     * @param subobj The subobject to be modified in the table
7710     * @param x Row number
7711     * @param y Column number
7712     * @param w rowspan
7713     * @param h colspan
7714     *
7715     * Modifies the position of an object already in the table.
7716     *
7717     * @note All positioning inside the table is relative to rows and columns, so
7718     * a value of 0 for x and y, means the top left cell of the table, and a
7719     * value of 1 for w and h means @p subobj only takes that 1 cell.
7720     */
7721    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7722    /**
7723     * @brief Get the packing location of an existing child of the table
7724     *
7725     * @param subobj The subobject to be modified in the table
7726     * @param x Row number
7727     * @param y Column number
7728     * @param w rowspan
7729     * @param h colspan
7730     *
7731     * @see elm_table_pack_set()
7732     */
7733    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7734    /**
7735     * @}
7736     */
7737
7738    /**
7739     * @defgroup Gengrid Gengrid (Generic grid)
7740     *
7741     * This widget aims to position objects in a grid layout while
7742     * actually creating and rendering only the visible ones, using the
7743     * same idea as the @ref Genlist "genlist": the user defines a @b
7744     * class for each item, specifying functions that will be called at
7745     * object creation, deletion, etc. When those items are selected by
7746     * the user, a callback function is issued. Users may interact with
7747     * a gengrid via the mouse (by clicking on items to select them and
7748     * clicking on the grid's viewport and swiping to pan the whole
7749     * view) or via the keyboard, navigating through item with the
7750     * arrow keys.
7751     *
7752     * @section Gengrid_Layouts Gengrid layouts
7753     *
7754     * Gengrids may layout its items in one of two possible layouts:
7755     * - horizontal or
7756     * - vertical.
7757     *
7758     * When in "horizontal mode", items will be placed in @b columns,
7759     * from top to bottom and, when the space for a column is filled,
7760     * another one is started on the right, thus expanding the grid
7761     * horizontally, making for horizontal scrolling. When in "vertical
7762     * mode" , though, items will be placed in @b rows, from left to
7763     * right and, when the space for a row is filled, another one is
7764     * started below, thus expanding the grid vertically (and making
7765     * for vertical scrolling).
7766     *
7767     * @section Gengrid_Items Gengrid items
7768     *
7769     * An item in a gengrid can have 0 or more text labels (they can be
7770     * regular text or textblock Evas objects - that's up to the style
7771     * to determine), 0 or more icons (which are simply objects
7772     * swallowed into the gengrid item's theming Edje object) and 0 or
7773     * more <b>boolean states</b>, which have the behavior left to the
7774     * user to define. The Edje part names for each of these properties
7775     * will be looked up, in the theme file for the gengrid, under the
7776     * Edje (string) data items named @c "labels", @c "icons" and @c
7777     * "states", respectively. For each of those properties, if more
7778     * than one part is provided, they must have names listed separated
7779     * by spaces in the data fields. For the default gengrid item
7780     * theme, we have @b one label part (@c "elm.text"), @b two icon
7781     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7782     * no state parts.
7783     *
7784     * A gengrid item may be at one of several styles. Elementary
7785     * provides one by default - "default", but this can be extended by
7786     * system or application custom themes/overlays/extensions (see
7787     * @ref Theme "themes" for more details).
7788     *
7789     * @section Gengrid_Item_Class Gengrid item classes
7790     *
7791     * In order to have the ability to add and delete items on the fly,
7792     * gengrid implements a class (callback) system where the
7793     * application provides a structure with information about that
7794     * type of item (gengrid may contain multiple different items with
7795     * different classes, states and styles). Gengrid will call the
7796     * functions in this struct (methods) when an item is "realized"
7797     * (i.e., created dynamically, while the user is scrolling the
7798     * grid). All objects will simply be deleted when no longer needed
7799     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7800     * contains the following members:
7801     * - @c item_style - This is a constant string and simply defines
7802     * the name of the item style. It @b must be specified and the
7803     * default should be @c "default".
7804     * - @c func.label_get - This function is called when an item
7805     * object is actually created. The @c data parameter will point to
7806     * the same data passed to elm_gengrid_item_append() and related
7807     * item creation functions. The @c obj parameter is the gengrid
7808     * object itself, while the @c part one is the name string of one
7809     * of the existing text parts in the Edje group implementing the
7810     * item's theme. This function @b must return a strdup'()ed string,
7811     * as the caller will free() it when done. See
7812     * #Elm_Gengrid_Item_Label_Get_Cb.
7813     * - @c func.icon_get - This function is called when an item object
7814     * is actually created. The @c data parameter will point to the
7815     * same data passed to elm_gengrid_item_append() and related item
7816     * creation functions. The @c obj parameter is the gengrid object
7817     * itself, while the @c part one is the name string of one of the
7818     * existing (icon) swallow parts in the Edje group implementing the
7819     * item's theme. It must return @c NULL, when no icon is desired,
7820     * or a valid object handle, otherwise. The object will be deleted
7821     * by the gengrid on its deletion or when the item is "unrealized".
7822     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7823     * - @c func.state_get - This function is called when an item
7824     * object is actually created. The @c data parameter will point to
7825     * the same data passed to elm_gengrid_item_append() and related
7826     * item creation functions. The @c obj parameter is the gengrid
7827     * object itself, while the @c part one is the name string of one
7828     * of the state parts in the Edje group implementing the item's
7829     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7830     * true/on. Gengrids will emit a signal to its theming Edje object
7831     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7832     * "source" arguments, respectively, when the state is true (the
7833     * default is false), where @c XXX is the name of the (state) part.
7834     * See #Elm_Gengrid_Item_State_Get_Cb.
7835     * - @c func.del - This is called when elm_gengrid_item_del() is
7836     * called on an item or elm_gengrid_clear() is called on the
7837     * gengrid. This is intended for use when gengrid items are
7838     * deleted, so any data attached to the item (e.g. its data
7839     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7840     *
7841     * @section Gengrid_Usage_Hints Usage hints
7842     *
7843     * If the user wants to have multiple items selected at the same
7844     * time, elm_gengrid_multi_select_set() will permit it. If the
7845     * gengrid is single-selection only (the default), then
7846     * elm_gengrid_select_item_get() will return the selected item or
7847     * @c NULL, if none is selected. If the gengrid is under
7848     * multi-selection, then elm_gengrid_selected_items_get() will
7849     * return a list (that is only valid as long as no items are
7850     * modified (added, deleted, selected or unselected) of child items
7851     * on a gengrid.
7852     *
7853     * If an item changes (internal (boolean) state, label or icon
7854     * changes), then use elm_gengrid_item_update() to have gengrid
7855     * update the item with the new state. A gengrid will re-"realize"
7856     * the item, thus calling the functions in the
7857     * #Elm_Gengrid_Item_Class set for that item.
7858     *
7859     * To programmatically (un)select an item, use
7860     * elm_gengrid_item_selected_set(). To get its selected state use
7861     * elm_gengrid_item_selected_get(). To make an item disabled
7862     * (unable to be selected and appear differently) use
7863     * elm_gengrid_item_disabled_set() to set this and
7864     * elm_gengrid_item_disabled_get() to get the disabled state.
7865     *
7866     * Grid cells will only have their selection smart callbacks called
7867     * when firstly getting selected. Any further clicks will do
7868     * nothing, unless you enable the "always select mode", with
7869     * elm_gengrid_always_select_mode_set(), thus making every click to
7870     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7871     * turn off the ability to select items entirely in the widget and
7872     * they will neither appear selected nor call the selection smart
7873     * callbacks.
7874     *
7875     * Remember that you can create new styles and add your own theme
7876     * augmentation per application with elm_theme_extension_add(). If
7877     * you absolutely must have a specific style that overrides any
7878     * theme the user or system sets up you can use
7879     * elm_theme_overlay_add() to add such a file.
7880     *
7881     * @section Gengrid_Smart_Events Gengrid smart events
7882     *
7883     * Smart events that you can add callbacks for are:
7884     * - @c "activated" - The user has double-clicked or pressed
7885     *   (enter|return|spacebar) on an item. The @c event_info parameter
7886     *   is the gengrid item that was activated.
7887     * - @c "clicked,double" - The user has double-clicked an item.
7888     *   The @c event_info parameter is the gengrid item that was double-clicked.
7889     * - @c "longpressed" - This is called when the item is pressed for a certain
7890     *   amount of time. By default it's 1 second.
7891     * - @c "selected" - The user has made an item selected. The
7892     *   @c event_info parameter is the gengrid item that was selected.
7893     * - @c "unselected" - The user has made an item unselected. The
7894     *   @c event_info parameter is the gengrid item that was unselected.
7895     * - @c "realized" - This is called when the item in the gengrid
7896     *   has its implementing Evas object instantiated, de facto. @c
7897     *   event_info is the gengrid item that was created. The object
7898     *   may be deleted at any time, so it is highly advised to the
7899     *   caller @b not to use the object pointer returned from
7900     *   elm_gengrid_item_object_get(), because it may point to freed
7901     *   objects.
7902     * - @c "unrealized" - This is called when the implementing Evas
7903     *   object for this item is deleted. @c event_info is the gengrid
7904     *   item that was deleted.
7905     * - @c "changed" - Called when an item is added, removed, resized
7906     *   or moved and when the gengrid is resized or gets "horizontal"
7907     *   property changes.
7908     * - @c "scroll,anim,start" - This is called when scrolling animation has
7909     *   started.
7910     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7911     *   stopped.
7912     * - @c "drag,start,up" - Called when the item in the gengrid has
7913     *   been dragged (not scrolled) up.
7914     * - @c "drag,start,down" - Called when the item in the gengrid has
7915     *   been dragged (not scrolled) down.
7916     * - @c "drag,start,left" - Called when the item in the gengrid has
7917     *   been dragged (not scrolled) left.
7918     * - @c "drag,start,right" - Called when the item in the gengrid has
7919     *   been dragged (not scrolled) right.
7920     * - @c "drag,stop" - Called when the item in the gengrid has
7921     *   stopped being dragged.
7922     * - @c "drag" - Called when the item in the gengrid is being
7923     *   dragged.
7924     * - @c "scroll" - called when the content has been scrolled
7925     *   (moved).
7926     * - @c "scroll,drag,start" - called when dragging the content has
7927     *   started.
7928     * - @c "scroll,drag,stop" - called when dragging the content has
7929     *   stopped.
7930     * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
7931     *   the top edge.
7932     * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
7933     *   until the bottom edge.
7934     * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
7935     *   until the left edge.
7936     * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
7937     *   until the right edge.
7938     *
7939     * List of gengrid examples:
7940     * @li @ref gengrid_example
7941     */
7942
7943    /**
7944     * @addtogroup Gengrid
7945     * @{
7946     */
7947
7948    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7949    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7950    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7951    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7952    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. */
7953    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. */
7954    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7955
7956    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7957    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7958    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7959    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7960
7961    /**
7962     * @struct _Elm_Gengrid_Item_Class
7963     *
7964     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7965     * field details.
7966     */
7967    struct _Elm_Gengrid_Item_Class
7968      {
7969         const char             *item_style;
7970         struct _Elm_Gengrid_Item_Class_Func
7971           {
7972              Elm_Gengrid_Item_Label_Get_Cb label_get;
7973              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7974              Elm_Gengrid_Item_State_Get_Cb state_get;
7975              Elm_Gengrid_Item_Del_Cb       del;
7976           } func;
7977      }; /**< #Elm_Gengrid_Item_Class member definitions */
7978
7979    /**
7980     * Add a new gengrid widget to the given parent Elementary
7981     * (container) object
7982     *
7983     * @param parent The parent object
7984     * @return a new gengrid widget handle or @c NULL, on errors
7985     *
7986     * This function inserts a new gengrid widget on the canvas.
7987     *
7988     * @see elm_gengrid_item_size_set()
7989     * @see elm_gengrid_group_item_size_set()
7990     * @see elm_gengrid_horizontal_set()
7991     * @see elm_gengrid_item_append()
7992     * @see elm_gengrid_item_del()
7993     * @see elm_gengrid_clear()
7994     *
7995     * @ingroup Gengrid
7996     */
7997    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7998
7999    /**
8000     * Set the size for the items of a given gengrid widget
8001     *
8002     * @param obj The gengrid object.
8003     * @param w The items' width.
8004     * @param h The items' height;
8005     *
8006     * A gengrid, after creation, has still no information on the size
8007     * to give to each of its cells. So, you most probably will end up
8008     * with squares one @ref Fingers "finger" wide, the default
8009     * size. Use this function to force a custom size for you items,
8010     * making them as big as you wish.
8011     *
8012     * @see elm_gengrid_item_size_get()
8013     *
8014     * @ingroup Gengrid
8015     */
8016    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8017
8018    /**
8019     * Get the size set for the items of a given gengrid widget
8020     *
8021     * @param obj The gengrid object.
8022     * @param w Pointer to a variable where to store the items' width.
8023     * @param h Pointer to a variable where to store the items' height.
8024     *
8025     * @note Use @c NULL pointers on the size values you're not
8026     * interested in: they'll be ignored by the function.
8027     *
8028     * @see elm_gengrid_item_size_get() for more details
8029     *
8030     * @ingroup Gengrid
8031     */
8032    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8033
8034    /**
8035     * Set the size for the group items of a given gengrid widget
8036     *
8037     * @param obj The gengrid object.
8038     * @param w The group items' width.
8039     * @param h The group items' height;
8040     *
8041     * A gengrid, after creation, has still no information on the size
8042     * to give to each of its cells. So, you most probably will end up
8043     * with squares one @ref Fingers "finger" wide, the default
8044     * size. Use this function to force a custom size for you group items,
8045     * making them as big as you wish.
8046     *
8047     * @see elm_gengrid_group_item_size_get()
8048     *
8049     * @ingroup Gengrid
8050     */
8051    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8052
8053    /**
8054     * Get the size set for the group items of a given gengrid widget
8055     *
8056     * @param obj The gengrid object.
8057     * @param w Pointer to a variable where to store the group items' width.
8058     * @param h Pointer to a variable where to store the group items' height.
8059     *
8060     * @note Use @c NULL pointers on the size values you're not
8061     * interested in: they'll be ignored by the function.
8062     *
8063     * @see elm_gengrid_group_item_size_get() for more details
8064     *
8065     * @ingroup Gengrid
8066     */
8067    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8068
8069    /**
8070     * Set the items grid's alignment within a given gengrid widget
8071     *
8072     * @param obj The gengrid object.
8073     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8074     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8075     *
8076     * This sets the alignment of the whole grid of items of a gengrid
8077     * within its given viewport. By default, those values are both
8078     * 0.5, meaning that the gengrid will have its items grid placed
8079     * exactly in the middle of its viewport.
8080     *
8081     * @note If given alignment values are out of the cited ranges,
8082     * they'll be changed to the nearest boundary values on the valid
8083     * ranges.
8084     *
8085     * @see elm_gengrid_align_get()
8086     *
8087     * @ingroup Gengrid
8088     */
8089    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8090
8091    /**
8092     * Get the items grid's alignment values within a given gengrid
8093     * widget
8094     *
8095     * @param obj The gengrid object.
8096     * @param align_x Pointer to a variable where to store the
8097     * horizontal alignment.
8098     * @param align_y Pointer to a variable where to store the vertical
8099     * alignment.
8100     *
8101     * @note Use @c NULL pointers on the alignment values you're not
8102     * interested in: they'll be ignored by the function.
8103     *
8104     * @see elm_gengrid_align_set() for more details
8105     *
8106     * @ingroup Gengrid
8107     */
8108    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8109
8110    /**
8111     * Set whether a given gengrid widget is or not able have items
8112     * @b reordered
8113     *
8114     * @param obj The gengrid object
8115     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8116     * @c EINA_FALSE to turn it off
8117     *
8118     * If a gengrid is set to allow reordering, a click held for more
8119     * than 0.5 over a given item will highlight it specially,
8120     * signalling the gengrid has entered the reordering state. From
8121     * that time on, the user will be able to, while still holding the
8122     * mouse button down, move the item freely in the gengrid's
8123     * viewport, replacing to said item to the locations it goes to.
8124     * The replacements will be animated and, whenever the user
8125     * releases the mouse button, the item being replaced gets a new
8126     * definitive place in the grid.
8127     *
8128     * @see elm_gengrid_reorder_mode_get()
8129     *
8130     * @ingroup Gengrid
8131     */
8132    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8133
8134    /**
8135     * Get whether a given gengrid widget is or not able have items
8136     * @b reordered
8137     *
8138     * @param obj The gengrid object
8139     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8140     * off
8141     *
8142     * @see elm_gengrid_reorder_mode_set() for more details
8143     *
8144     * @ingroup Gengrid
8145     */
8146    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8147
8148    /**
8149     * Append a new item in a given gengrid widget.
8150     *
8151     * @param obj The gengrid object.
8152     * @param gic The item class for the item.
8153     * @param data The item data.
8154     * @param func Convenience function called when the item is
8155     * selected.
8156     * @param func_data Data to be passed to @p func.
8157     * @return A handle to the item added or @c NULL, on errors.
8158     *
8159     * This adds an item to the beginning of the gengrid.
8160     *
8161     * @see elm_gengrid_item_prepend()
8162     * @see elm_gengrid_item_insert_before()
8163     * @see elm_gengrid_item_insert_after()
8164     * @see elm_gengrid_item_del()
8165     *
8166     * @ingroup Gengrid
8167     */
8168    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);
8169
8170    /**
8171     * Prepend a new item in a given gengrid widget.
8172     *
8173     * @param obj The gengrid object.
8174     * @param gic The item class for the item.
8175     * @param data The item data.
8176     * @param func Convenience function called when the item is
8177     * selected.
8178     * @param func_data Data to be passed to @p func.
8179     * @return A handle to the item added or @c NULL, on errors.
8180     *
8181     * This adds an item to the end of the gengrid.
8182     *
8183     * @see elm_gengrid_item_append()
8184     * @see elm_gengrid_item_insert_before()
8185     * @see elm_gengrid_item_insert_after()
8186     * @see elm_gengrid_item_del()
8187     *
8188     * @ingroup Gengrid
8189     */
8190    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);
8191
8192    /**
8193     * Insert an item before another in a gengrid widget
8194     *
8195     * @param obj The gengrid object.
8196     * @param gic The item class for the item.
8197     * @param data The item data.
8198     * @param relative The item to place this new one before.
8199     * @param func Convenience function called when the item is
8200     * selected.
8201     * @param func_data Data to be passed to @p func.
8202     * @return A handle to the item added or @c NULL, on errors.
8203     *
8204     * This inserts an item before another in the gengrid.
8205     *
8206     * @see elm_gengrid_item_append()
8207     * @see elm_gengrid_item_prepend()
8208     * @see elm_gengrid_item_insert_after()
8209     * @see elm_gengrid_item_del()
8210     *
8211     * @ingroup Gengrid
8212     */
8213    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);
8214
8215    /**
8216     * Insert an item after another in a gengrid widget
8217     *
8218     * @param obj The gengrid object.
8219     * @param gic The item class for the item.
8220     * @param data The item data.
8221     * @param relative The item to place this new one after.
8222     * @param func Convenience function called when the item is
8223     * selected.
8224     * @param func_data Data to be passed to @p func.
8225     * @return A handle to the item added or @c NULL, on errors.
8226     *
8227     * This inserts an item after another in the gengrid.
8228     *
8229     * @see elm_gengrid_item_append()
8230     * @see elm_gengrid_item_prepend()
8231     * @see elm_gengrid_item_insert_after()
8232     * @see elm_gengrid_item_del()
8233     *
8234     * @ingroup Gengrid
8235     */
8236    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);
8237
8238    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);
8239
8240    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);
8241
8242    /**
8243     * Set whether items on a given gengrid widget are to get their
8244     * selection callbacks issued for @b every subsequent selection
8245     * click on them or just for the first click.
8246     *
8247     * @param obj The gengrid object
8248     * @param always_select @c EINA_TRUE to make items "always
8249     * selected", @c EINA_FALSE, otherwise
8250     *
8251     * By default, grid items will only call their selection callback
8252     * function when firstly getting selected, any subsequent further
8253     * clicks will do nothing. With this call, you make those
8254     * subsequent clicks also to issue the selection callbacks.
8255     *
8256     * @note <b>Double clicks</b> will @b always be reported on items.
8257     *
8258     * @see elm_gengrid_always_select_mode_get()
8259     *
8260     * @ingroup Gengrid
8261     */
8262    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8263
8264    /**
8265     * Get whether items on a given gengrid widget have their selection
8266     * callbacks issued for @b every subsequent selection click on them
8267     * or just for the first click.
8268     *
8269     * @param obj The gengrid object.
8270     * @return @c EINA_TRUE if the gengrid items are "always selected",
8271     * @c EINA_FALSE, otherwise
8272     *
8273     * @see elm_gengrid_always_select_mode_set() for more details
8274     *
8275     * @ingroup Gengrid
8276     */
8277    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8278
8279    /**
8280     * Set whether items on a given gengrid widget can be selected or not.
8281     *
8282     * @param obj The gengrid object
8283     * @param no_select @c EINA_TRUE to make items selectable,
8284     * @c EINA_FALSE otherwise
8285     *
8286     * This will make items in @p obj selectable or not. In the latter
8287     * case, any user interaction on the gengrid items will neither make
8288     * them appear selected nor them call their selection callback
8289     * functions.
8290     *
8291     * @see elm_gengrid_no_select_mode_get()
8292     *
8293     * @ingroup Gengrid
8294     */
8295    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8296
8297    /**
8298     * Get whether items on a given gengrid widget can be selected or
8299     * not.
8300     *
8301     * @param obj The gengrid object
8302     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8303     * otherwise
8304     *
8305     * @see elm_gengrid_no_select_mode_set() for more details
8306     *
8307     * @ingroup Gengrid
8308     */
8309    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8310
8311    /**
8312     * Enable or disable multi-selection in a given gengrid widget
8313     *
8314     * @param obj The gengrid object.
8315     * @param multi @c EINA_TRUE, to enable multi-selection,
8316     * @c EINA_FALSE to disable it.
8317     *
8318     * Multi-selection is the ability for one to have @b more than one
8319     * item selected, on a given gengrid, simultaneously. When it is
8320     * enabled, a sequence of clicks on different items will make them
8321     * all selected, progressively. A click on an already selected item
8322     * will unselect it. If interecting via the keyboard,
8323     * multi-selection is enabled while holding the "Shift" key.
8324     *
8325     * @note By default, multi-selection is @b disabled on gengrids
8326     *
8327     * @see elm_gengrid_multi_select_get()
8328     *
8329     * @ingroup Gengrid
8330     */
8331    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8332
8333    /**
8334     * Get whether multi-selection is enabled or disabled for a given
8335     * gengrid widget
8336     *
8337     * @param obj The gengrid object.
8338     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8339     * EINA_FALSE otherwise
8340     *
8341     * @see elm_gengrid_multi_select_set() for more details
8342     *
8343     * @ingroup Gengrid
8344     */
8345    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8346
8347    /**
8348     * Enable or disable bouncing effect for a given gengrid widget
8349     *
8350     * @param obj The gengrid object
8351     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8352     * @c EINA_FALSE to disable it
8353     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8354     * @c EINA_FALSE to disable it
8355     *
8356     * The bouncing effect occurs whenever one reaches the gengrid's
8357     * edge's while panning it -- it will scroll past its limits a
8358     * little bit and return to the edge again, in a animated for,
8359     * automatically.
8360     *
8361     * @note By default, gengrids have bouncing enabled on both axis
8362     *
8363     * @see elm_gengrid_bounce_get()
8364     *
8365     * @ingroup Gengrid
8366     */
8367    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8368
8369    /**
8370     * Get whether bouncing effects are enabled or disabled, for a
8371     * given gengrid widget, on each axis
8372     *
8373     * @param obj The gengrid object
8374     * @param h_bounce Pointer to a variable where to store the
8375     * horizontal bouncing flag.
8376     * @param v_bounce Pointer to a variable where to store the
8377     * vertical bouncing flag.
8378     *
8379     * @see elm_gengrid_bounce_set() for more details
8380     *
8381     * @ingroup Gengrid
8382     */
8383    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8384
8385    /**
8386     * Set a given gengrid widget's scrolling page size, relative to
8387     * its viewport size.
8388     *
8389     * @param obj The gengrid object
8390     * @param h_pagerel The horizontal page (relative) size
8391     * @param v_pagerel The vertical page (relative) size
8392     *
8393     * The gengrid's scroller is capable of binding scrolling by the
8394     * user to "pages". It means that, while scrolling and, specially
8395     * after releasing the mouse button, the grid will @b snap to the
8396     * nearest displaying page's area. When page sizes are set, the
8397     * grid's continuous content area is split into (equal) page sized
8398     * pieces.
8399     *
8400     * This function sets the size of a page <b>relatively to the
8401     * viewport dimensions</b> of the gengrid, for each axis. A value
8402     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8403     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8404     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8405     * 1.0. Values beyond those will make it behave behave
8406     * inconsistently. If you only want one axis to snap to pages, use
8407     * the value @c 0.0 for the other one.
8408     *
8409     * There is a function setting page size values in @b absolute
8410     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8411     * is mutually exclusive to this one.
8412     *
8413     * @see elm_gengrid_page_relative_get()
8414     *
8415     * @ingroup Gengrid
8416     */
8417    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8418
8419    /**
8420     * Get a given gengrid widget's scrolling page size, relative to
8421     * its viewport size.
8422     *
8423     * @param obj The gengrid object
8424     * @param h_pagerel Pointer to a variable where to store the
8425     * horizontal page (relative) size
8426     * @param v_pagerel Pointer to a variable where to store the
8427     * vertical page (relative) size
8428     *
8429     * @see elm_gengrid_page_relative_set() for more details
8430     *
8431     * @ingroup Gengrid
8432     */
8433    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8434
8435    /**
8436     * Set a given gengrid widget's scrolling page size
8437     *
8438     * @param obj The gengrid object
8439     * @param h_pagerel The horizontal page size, in pixels
8440     * @param v_pagerel The vertical page size, in pixels
8441     *
8442     * The gengrid's scroller is capable of binding scrolling by the
8443     * user to "pages". It means that, while scrolling and, specially
8444     * after releasing the mouse button, the grid will @b snap to the
8445     * nearest displaying page's area. When page sizes are set, the
8446     * grid's continuous content area is split into (equal) page sized
8447     * pieces.
8448     *
8449     * This function sets the size of a page of the gengrid, in pixels,
8450     * for each axis. Sane usable values are, between @c 0 and the
8451     * dimensions of @p obj, for each axis. Values beyond those will
8452     * make it behave behave inconsistently. If you only want one axis
8453     * to snap to pages, use the value @c 0 for the other one.
8454     *
8455     * There is a function setting page size values in @b relative
8456     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8457     * use is mutually exclusive to this one.
8458     *
8459     * @ingroup Gengrid
8460     */
8461    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8462
8463    /**
8464     * @brief Get gengrid current page number.
8465     *
8466     * @param obj The gengrid object
8467     * @param h_pagenumber The horizontal page number
8468     * @param v_pagenumber The vertical page number
8469     *
8470     * The page number starts from 0. 0 is the first page.
8471     * Current page means the page which meet the top-left of the viewport.
8472     * If there are two or more pages in the viewport, it returns the number of page
8473     * which meet the top-left of the viewport.
8474     *
8475     * @see elm_gengrid_last_page_get()
8476     * @see elm_gengrid_page_show()
8477     * @see elm_gengrid_page_brint_in()
8478     */
8479    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8480
8481    /**
8482     * @brief Get scroll last page number.
8483     *
8484     * @param obj The gengrid object
8485     * @param h_pagenumber The horizontal page number
8486     * @param v_pagenumber The vertical page number
8487     *
8488     * The page number starts from 0. 0 is the first page.
8489     * This returns the last page number among the pages.
8490     *
8491     * @see elm_gengrid_current_page_get()
8492     * @see elm_gengrid_page_show()
8493     * @see elm_gengrid_page_brint_in()
8494     */
8495    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8496
8497    /**
8498     * Show a specific virtual region within the gengrid content object by page number.
8499     *
8500     * @param obj The gengrid object
8501     * @param h_pagenumber The horizontal page number
8502     * @param v_pagenumber The vertical page number
8503     *
8504     * 0, 0 of the indicated page is located at the top-left of the viewport.
8505     * This will jump to the page directly without animation.
8506     *
8507     * Example of usage:
8508     *
8509     * @code
8510     * sc = elm_gengrid_add(win);
8511     * elm_gengrid_content_set(sc, content);
8512     * elm_gengrid_page_relative_set(sc, 1, 0);
8513     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8514     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8515     * @endcode
8516     *
8517     * @see elm_gengrid_page_bring_in()
8518     */
8519    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8520
8521    /**
8522     * Show a specific virtual region within the gengrid content object by page number.
8523     *
8524     * @param obj The gengrid object
8525     * @param h_pagenumber The horizontal page number
8526     * @param v_pagenumber The vertical page number
8527     *
8528     * 0, 0 of the indicated page is located at the top-left of the viewport.
8529     * This will slide to the page with animation.
8530     *
8531     * Example of usage:
8532     *
8533     * @code
8534     * sc = elm_gengrid_add(win);
8535     * elm_gengrid_content_set(sc, content);
8536     * elm_gengrid_page_relative_set(sc, 1, 0);
8537     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8538     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8539     * @endcode
8540     *
8541     * @see elm_gengrid_page_show()
8542     */
8543     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8544
8545    /**
8546     * Set for what direction a given gengrid widget will expand while
8547     * placing its items.
8548     *
8549     * @param obj The gengrid object.
8550     * @param setting @c EINA_TRUE to make the gengrid expand
8551     * horizontally, @c EINA_FALSE to expand vertically.
8552     *
8553     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8554     * in @b columns, from top to bottom and, when the space for a
8555     * column is filled, another one is started on the right, thus
8556     * expanding the grid horizontally. When in "vertical mode"
8557     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8558     * to right and, when the space for a row is filled, another one is
8559     * started below, thus expanding the grid vertically.
8560     *
8561     * @see elm_gengrid_horizontal_get()
8562     *
8563     * @ingroup Gengrid
8564     */
8565    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8566
8567    /**
8568     * Get for what direction a given gengrid widget will expand while
8569     * placing its items.
8570     *
8571     * @param obj The gengrid object.
8572     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8573     * @c EINA_FALSE if it's set to expand vertically.
8574     *
8575     * @see elm_gengrid_horizontal_set() for more detais
8576     *
8577     * @ingroup Gengrid
8578     */
8579    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8580
8581    /**
8582     * Get the first item in a given gengrid widget
8583     *
8584     * @param obj The gengrid object
8585     * @return The first item's handle or @c NULL, if there are no
8586     * items in @p obj (and on errors)
8587     *
8588     * This returns the first item in the @p obj's internal list of
8589     * items.
8590     *
8591     * @see elm_gengrid_last_item_get()
8592     *
8593     * @ingroup Gengrid
8594     */
8595    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8596
8597    /**
8598     * Get the last item in a given gengrid widget
8599     *
8600     * @param obj The gengrid object
8601     * @return The last item's handle or @c NULL, if there are no
8602     * items in @p obj (and on errors)
8603     *
8604     * This returns the last item in the @p obj's internal list of
8605     * items.
8606     *
8607     * @see elm_gengrid_first_item_get()
8608     *
8609     * @ingroup Gengrid
8610     */
8611    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8612
8613    /**
8614     * Get the @b next item in a gengrid widget's internal list of items,
8615     * given a handle to one of those items.
8616     *
8617     * @param item The gengrid item to fetch next from
8618     * @return The item after @p item, or @c NULL if there's none (and
8619     * on errors)
8620     *
8621     * This returns the item placed after the @p item, on the container
8622     * gengrid.
8623     *
8624     * @see elm_gengrid_item_prev_get()
8625     *
8626     * @ingroup Gengrid
8627     */
8628    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8629
8630    /**
8631     * Get the @b previous item in a gengrid widget's internal list of items,
8632     * given a handle to one of those items.
8633     *
8634     * @param item The gengrid item to fetch previous from
8635     * @return The item before @p item, or @c NULL if there's none (and
8636     * on errors)
8637     *
8638     * This returns the item placed before the @p item, on the container
8639     * gengrid.
8640     *
8641     * @see elm_gengrid_item_next_get()
8642     *
8643     * @ingroup Gengrid
8644     */
8645    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8646
8647    /**
8648     * Get the gengrid object's handle which contains a given gengrid
8649     * item
8650     *
8651     * @param item The item to fetch the container from
8652     * @return The gengrid (parent) object
8653     *
8654     * This returns the gengrid object itself that an item belongs to.
8655     *
8656     * @ingroup Gengrid
8657     */
8658    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8659
8660    /**
8661     * Remove a gengrid item from the its parent, deleting it.
8662     *
8663     * @param item The item to be removed.
8664     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8665     *
8666     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8667     * once.
8668     *
8669     * @ingroup Gengrid
8670     */
8671    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8672
8673    /**
8674     * Update the contents of a given gengrid item
8675     *
8676     * @param item The gengrid item
8677     *
8678     * This updates an item by calling all the item class functions
8679     * again to get the icons, labels and states. Use this when the
8680     * original item data has changed and you want thta changes to be
8681     * reflected.
8682     *
8683     * @ingroup Gengrid
8684     */
8685    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8686    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8687    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8688
8689    /**
8690     * Return the data associated to a given gengrid item
8691     *
8692     * @param item The gengrid item.
8693     * @return the data associated to this item.
8694     *
8695     * This returns the @c data value passed on the
8696     * elm_gengrid_item_append() and related item addition calls.
8697     *
8698     * @see elm_gengrid_item_append()
8699     * @see elm_gengrid_item_data_set()
8700     *
8701     * @ingroup Gengrid
8702     */
8703    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8704
8705    /**
8706     * Set the data associated to a given gengrid item
8707     *
8708     * @param item The gengrid item
8709     * @param data The new data pointer to set on it
8710     *
8711     * This @b overrides the @c data value passed on the
8712     * elm_gengrid_item_append() and related item addition calls. This
8713     * function @b won't call elm_gengrid_item_update() automatically,
8714     * so you'd issue it afterwards if you want to hove the item
8715     * updated to reflect the that new data.
8716     *
8717     * @see elm_gengrid_item_data_get()
8718     *
8719     * @ingroup Gengrid
8720     */
8721    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8722
8723    /**
8724     * Get a given gengrid item's position, relative to the whole
8725     * gengrid's grid area.
8726     *
8727     * @param item The Gengrid item.
8728     * @param x Pointer to variable where to store the item's <b>row
8729     * number</b>.
8730     * @param y Pointer to variable where to store the item's <b>column
8731     * number</b>.
8732     *
8733     * This returns the "logical" position of the item whithin the
8734     * gengrid. For example, @c (0, 1) would stand for first row,
8735     * second column.
8736     *
8737     * @ingroup Gengrid
8738     */
8739    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8740
8741    /**
8742     * Set whether a given gengrid item is selected or not
8743     *
8744     * @param item The gengrid item
8745     * @param selected Use @c EINA_TRUE, to make it selected, @c
8746     * EINA_FALSE to make it unselected
8747     *
8748     * This sets the selected state of an item. If multi selection is
8749     * not enabled on the containing gengrid and @p selected is @c
8750     * EINA_TRUE, any other previously selected items will get
8751     * unselected in favor of this new one.
8752     *
8753     * @see elm_gengrid_item_selected_get()
8754     *
8755     * @ingroup Gengrid
8756     */
8757    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8758
8759    /**
8760     * Get whether a given gengrid item is selected or not
8761     *
8762     * @param item The gengrid item
8763     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8764     *
8765     * @see elm_gengrid_item_selected_set() for more details
8766     *
8767     * @ingroup Gengrid
8768     */
8769    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8770
8771    /**
8772     * Get the real Evas object created to implement the view of a
8773     * given gengrid item
8774     *
8775     * @param item The gengrid item.
8776     * @return the Evas object implementing this item's view.
8777     *
8778     * This returns the actual Evas object used to implement the
8779     * specified gengrid item's view. This may be @c NULL, as it may
8780     * not have been created or may have been deleted, at any time, by
8781     * the gengrid. <b>Do not modify this object</b> (move, resize,
8782     * show, hide, etc.), as the gengrid is controlling it. This
8783     * function is for querying, emitting custom signals or hooking
8784     * lower level callbacks for events on that object. Do not delete
8785     * this object under any circumstances.
8786     *
8787     * @see elm_gengrid_item_data_get()
8788     *
8789     * @ingroup Gengrid
8790     */
8791    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8792
8793    /**
8794     * Show the portion of a gengrid's internal grid containing a given
8795     * item, @b immediately.
8796     *
8797     * @param item The item to display
8798     *
8799     * This causes gengrid to @b redraw its viewport's contents to the
8800     * region contining the given @p item item, if it is not fully
8801     * visible.
8802     *
8803     * @see elm_gengrid_item_bring_in()
8804     *
8805     * @ingroup Gengrid
8806     */
8807    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8808
8809    /**
8810     * Animatedly bring in, to the visible are of a gengrid, a given
8811     * item on it.
8812     *
8813     * @param item The gengrid item to display
8814     *
8815     * This causes gengrig to jump to the given @p item item and show
8816     * it (by scrolling), if it is not fully visible. This will use
8817     * animation to do so and take a period of time to complete.
8818     *
8819     * @see elm_gengrid_item_show()
8820     *
8821     * @ingroup Gengrid
8822     */
8823    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8824
8825    /**
8826     * Set whether a given gengrid item is disabled or not.
8827     *
8828     * @param item The gengrid item
8829     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8830     * to enable it back.
8831     *
8832     * A disabled item cannot be selected or unselected. It will also
8833     * change its appearance, to signal the user it's disabled.
8834     *
8835     * @see elm_gengrid_item_disabled_get()
8836     *
8837     * @ingroup Gengrid
8838     */
8839    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8840
8841    /**
8842     * Get whether a given gengrid item is disabled or not.
8843     *
8844     * @param item The gengrid item
8845     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8846     * (and on errors).
8847     *
8848     * @see elm_gengrid_item_disabled_set() for more details
8849     *
8850     * @ingroup Gengrid
8851     */
8852    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8853
8854    /**
8855     * Set the text to be shown in a given gengrid item's tooltips.
8856     *
8857     * @param item The gengrid item
8858     * @param text The text to set in the content
8859     *
8860     * This call will setup the text to be used as tooltip to that item
8861     * (analogous to elm_object_tooltip_text_set(), but being item
8862     * tooltips with higher precedence than object tooltips). It can
8863     * have only one tooltip at a time, so any previous tooltip data
8864     * will get removed.
8865     *
8866     * @ingroup Gengrid
8867     */
8868    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8869
8870    /**
8871     * Set the content to be shown in a given gengrid item's tooltips
8872     *
8873     * @param item The gengrid item.
8874     * @param func The function returning the tooltip contents.
8875     * @param data What to provide to @a func as callback data/context.
8876     * @param del_cb Called when data is not needed anymore, either when
8877     *        another callback replaces @p func, the tooltip is unset with
8878     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8879     *        dies. This callback receives as its first parameter the
8880     *        given @p data, being @c event_info the item handle.
8881     *
8882     * This call will setup the tooltip's contents to @p item
8883     * (analogous to elm_object_tooltip_content_cb_set(), but being
8884     * item tooltips with higher precedence than object tooltips). It
8885     * can have only one tooltip at a time, so any previous tooltip
8886     * content will get removed. @p func (with @p data) will be called
8887     * every time Elementary needs to show the tooltip and it should
8888     * return a valid Evas object, which will be fully managed by the
8889     * tooltip system, getting deleted when the tooltip is gone.
8890     *
8891     * @ingroup Gengrid
8892     */
8893    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);
8894
8895    /**
8896     * Unset a tooltip from a given gengrid item
8897     *
8898     * @param item gengrid item to remove a previously set tooltip from.
8899     *
8900     * This call removes any tooltip set on @p item. The callback
8901     * provided as @c del_cb to
8902     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8903     * notify it is not used anymore (and have resources cleaned, if
8904     * need be).
8905     *
8906     * @see elm_gengrid_item_tooltip_content_cb_set()
8907     *
8908     * @ingroup Gengrid
8909     */
8910    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8911
8912    /**
8913     * Set a different @b style for a given gengrid item's tooltip.
8914     *
8915     * @param item gengrid item with tooltip set
8916     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8917     * "default", @c "transparent", etc)
8918     *
8919     * Tooltips can have <b>alternate styles</b> to be displayed on,
8920     * which are defined by the theme set on Elementary. This function
8921     * works analogously as elm_object_tooltip_style_set(), but here
8922     * applied only to gengrid item objects. The default style for
8923     * tooltips is @c "default".
8924     *
8925     * @note before you set a style you should define a tooltip with
8926     *       elm_gengrid_item_tooltip_content_cb_set() or
8927     *       elm_gengrid_item_tooltip_text_set()
8928     *
8929     * @see elm_gengrid_item_tooltip_style_get()
8930     *
8931     * @ingroup Gengrid
8932     */
8933    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8934
8935    /**
8936     * Get the style set a given gengrid item's tooltip.
8937     *
8938     * @param item gengrid item with tooltip already set on.
8939     * @return style the theme style in use, which defaults to
8940     *         "default". If the object does not have a tooltip set,
8941     *         then @c NULL is returned.
8942     *
8943     * @see elm_gengrid_item_tooltip_style_set() for more details
8944     *
8945     * @ingroup Gengrid
8946     */
8947    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8948    /**
8949     * @brief Disable size restrictions on an object's tooltip
8950     * @param item The tooltip's anchor object
8951     * @param disable If EINA_TRUE, size restrictions are disabled
8952     * @return EINA_FALSE on failure, EINA_TRUE on success
8953     *
8954     * This function allows a tooltip to expand beyond its parant window's canvas.
8955     * It will instead be limited only by the size of the display.
8956     */
8957    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8958    /**
8959     * @brief Retrieve size restriction state of an object's tooltip
8960     * @param item The tooltip's anchor object
8961     * @return If EINA_TRUE, size restrictions are disabled
8962     *
8963     * This function returns whether a tooltip is allowed to expand beyond
8964     * its parant window's canvas.
8965     * It will instead be limited only by the size of the display.
8966     */
8967    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8968    /**
8969     * Set the type of mouse pointer/cursor decoration to be shown,
8970     * when the mouse pointer is over the given gengrid widget item
8971     *
8972     * @param item gengrid item to customize cursor on
8973     * @param cursor the cursor type's name
8974     *
8975     * This function works analogously as elm_object_cursor_set(), but
8976     * here the cursor's changing area is restricted to the item's
8977     * area, and not the whole widget's. Note that that item cursors
8978     * have precedence over widget cursors, so that a mouse over @p
8979     * item will always show cursor @p type.
8980     *
8981     * If this function is called twice for an object, a previously set
8982     * cursor will be unset on the second call.
8983     *
8984     * @see elm_object_cursor_set()
8985     * @see elm_gengrid_item_cursor_get()
8986     * @see elm_gengrid_item_cursor_unset()
8987     *
8988     * @ingroup Gengrid
8989     */
8990    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8991
8992    /**
8993     * Get the type of mouse pointer/cursor decoration set to be shown,
8994     * when the mouse pointer is over the given gengrid widget item
8995     *
8996     * @param item gengrid item with custom cursor set
8997     * @return the cursor type's name or @c NULL, if no custom cursors
8998     * were set to @p item (and on errors)
8999     *
9000     * @see elm_object_cursor_get()
9001     * @see elm_gengrid_item_cursor_set() for more details
9002     * @see elm_gengrid_item_cursor_unset()
9003     *
9004     * @ingroup Gengrid
9005     */
9006    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9007
9008    /**
9009     * Unset any custom mouse pointer/cursor decoration set to be
9010     * shown, when the mouse pointer is over the given gengrid widget
9011     * item, thus making it show the @b default cursor again.
9012     *
9013     * @param item a gengrid item
9014     *
9015     * Use this call to undo any custom settings on this item's cursor
9016     * decoration, bringing it back to defaults (no custom style set).
9017     *
9018     * @see elm_object_cursor_unset()
9019     * @see elm_gengrid_item_cursor_set() for more details
9020     *
9021     * @ingroup Gengrid
9022     */
9023    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9024
9025    /**
9026     * Set a different @b style for a given custom cursor set for a
9027     * gengrid item.
9028     *
9029     * @param item gengrid item with custom cursor set
9030     * @param style the <b>theme style</b> to use (e.g. @c "default",
9031     * @c "transparent", etc)
9032     *
9033     * This function only makes sense when one is using custom mouse
9034     * cursor decorations <b>defined in a theme file</b> , which can
9035     * have, given a cursor name/type, <b>alternate styles</b> on
9036     * it. It works analogously as elm_object_cursor_style_set(), but
9037     * here applied only to gengrid item objects.
9038     *
9039     * @warning Before you set a cursor style you should have defined a
9040     *       custom cursor previously on the item, with
9041     *       elm_gengrid_item_cursor_set()
9042     *
9043     * @see elm_gengrid_item_cursor_engine_only_set()
9044     * @see elm_gengrid_item_cursor_style_get()
9045     *
9046     * @ingroup Gengrid
9047     */
9048    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9049
9050    /**
9051     * Get the current @b style set for a given gengrid item's custom
9052     * cursor
9053     *
9054     * @param item gengrid item with custom cursor set.
9055     * @return style the cursor style in use. If the object does not
9056     *         have a cursor set, then @c NULL is returned.
9057     *
9058     * @see elm_gengrid_item_cursor_style_set() for more details
9059     *
9060     * @ingroup Gengrid
9061     */
9062    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9063
9064    /**
9065     * Set if the (custom) cursor for a given gengrid item should be
9066     * searched in its theme, also, or should only rely on the
9067     * rendering engine.
9068     *
9069     * @param item item with custom (custom) cursor already set on
9070     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9071     * only on those provided by the rendering engine, @c EINA_FALSE to
9072     * have them searched on the widget's theme, as well.
9073     *
9074     * @note This call is of use only if you've set a custom cursor
9075     * for gengrid items, with elm_gengrid_item_cursor_set().
9076     *
9077     * @note By default, cursors will only be looked for between those
9078     * provided by the rendering engine.
9079     *
9080     * @ingroup Gengrid
9081     */
9082    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9083
9084    /**
9085     * Get if the (custom) cursor for a given gengrid item is being
9086     * searched in its theme, also, or is only relying on the rendering
9087     * engine.
9088     *
9089     * @param item a gengrid item
9090     * @return @c EINA_TRUE, if cursors are being looked for only on
9091     * those provided by the rendering engine, @c EINA_FALSE if they
9092     * are being searched on the widget's theme, as well.
9093     *
9094     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9095     *
9096     * @ingroup Gengrid
9097     */
9098    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9099
9100    /**
9101     * Remove all items from a given gengrid widget
9102     *
9103     * @param obj The gengrid object.
9104     *
9105     * This removes (and deletes) all items in @p obj, leaving it
9106     * empty.
9107     *
9108     * @see elm_gengrid_item_del(), to remove just one item.
9109     *
9110     * @ingroup Gengrid
9111     */
9112    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9113
9114    /**
9115     * Get the selected item in a given gengrid widget
9116     *
9117     * @param obj The gengrid object.
9118     * @return The selected item's handleor @c NULL, if none is
9119     * selected at the moment (and on errors)
9120     *
9121     * This returns the selected item in @p obj. If multi selection is
9122     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9123     * the first item in the list is selected, which might not be very
9124     * useful. For that case, see elm_gengrid_selected_items_get().
9125     *
9126     * @ingroup Gengrid
9127     */
9128    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9129
9130    /**
9131     * Get <b>a list</b> of selected items in a given gengrid
9132     *
9133     * @param obj The gengrid object.
9134     * @return The list of selected items or @c NULL, if none is
9135     * selected at the moment (and on errors)
9136     *
9137     * This returns a list of the selected items, in the order that
9138     * they appear in the grid. This list is only valid as long as no
9139     * more items are selected or unselected (or unselected implictly
9140     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9141     * data, naturally.
9142     *
9143     * @see elm_gengrid_selected_item_get()
9144     *
9145     * @ingroup Gengrid
9146     */
9147    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9148
9149    /**
9150     * @}
9151     */
9152
9153    /**
9154     * @defgroup Clock Clock
9155     *
9156     * @image html img/widget/clock/preview-00.png
9157     * @image latex img/widget/clock/preview-00.eps
9158     *
9159     * This is a @b digital clock widget. In its default theme, it has a
9160     * vintage "flipping numbers clock" appearance, which will animate
9161     * sheets of individual algarisms individually as time goes by.
9162     *
9163     * A newly created clock will fetch system's time (already
9164     * considering local time adjustments) to start with, and will tick
9165     * accondingly. It may or may not show seconds.
9166     *
9167     * Clocks have an @b edition mode. When in it, the sheets will
9168     * display extra arrow indications on the top and bottom and the
9169     * user may click on them to raise or lower the time values. After
9170     * it's told to exit edition mode, it will keep ticking with that
9171     * new time set (it keeps the difference from local time).
9172     *
9173     * Also, when under edition mode, user clicks on the cited arrows
9174     * which are @b held for some time will make the clock to flip the
9175     * sheet, thus editing the time, continuosly and automatically for
9176     * the user. The interval between sheet flips will keep growing in
9177     * time, so that it helps the user to reach a time which is distant
9178     * from the one set.
9179     *
9180     * The time display is, by default, in military mode (24h), but an
9181     * am/pm indicator may be optionally shown, too, when it will
9182     * switch to 12h.
9183     *
9184     * Smart callbacks one can register to:
9185     * - "changed" - the clock's user changed the time
9186     *
9187     * Here is an example on its usage:
9188     * @li @ref clock_example
9189     */
9190
9191    /**
9192     * @addtogroup Clock
9193     * @{
9194     */
9195
9196    /**
9197     * Identifiers for which clock digits should be editable, when a
9198     * clock widget is in edition mode. Values may be ORed together to
9199     * make a mask, naturally.
9200     *
9201     * @see elm_clock_edit_set()
9202     * @see elm_clock_digit_edit_set()
9203     */
9204    typedef enum _Elm_Clock_Digedit
9205      {
9206         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9207         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9208         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9209         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9210         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9211         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9212         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9213         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9214      } Elm_Clock_Digedit;
9215
9216    /**
9217     * Add a new clock widget to the given parent Elementary
9218     * (container) object
9219     *
9220     * @param parent The parent object
9221     * @return a new clock widget handle or @c NULL, on errors
9222     *
9223     * This function inserts a new clock widget on the canvas.
9224     *
9225     * @ingroup Clock
9226     */
9227    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9228
9229    /**
9230     * Set a clock widget's time, programmatically
9231     *
9232     * @param obj The clock widget object
9233     * @param hrs The hours to set
9234     * @param min The minutes to set
9235     * @param sec The secondes to set
9236     *
9237     * This function updates the time that is showed by the clock
9238     * widget.
9239     *
9240     *  Values @b must be set within the following ranges:
9241     * - 0 - 23, for hours
9242     * - 0 - 59, for minutes
9243     * - 0 - 59, for seconds,
9244     *
9245     * even if the clock is not in "military" mode.
9246     *
9247     * @warning The behavior for values set out of those ranges is @b
9248     * indefined.
9249     *
9250     * @ingroup Clock
9251     */
9252    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9253
9254    /**
9255     * Get a clock widget's time values
9256     *
9257     * @param obj The clock object
9258     * @param[out] hrs Pointer to the variable to get the hours value
9259     * @param[out] min Pointer to the variable to get the minutes value
9260     * @param[out] sec Pointer to the variable to get the seconds value
9261     *
9262     * This function gets the time set for @p obj, returning
9263     * it on the variables passed as the arguments to function
9264     *
9265     * @note Use @c NULL pointers on the time values you're not
9266     * interested in: they'll be ignored by the function.
9267     *
9268     * @ingroup Clock
9269     */
9270    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9271
9272    /**
9273     * Set whether a given clock widget is under <b>edition mode</b> or
9274     * under (default) displaying-only mode.
9275     *
9276     * @param obj The clock object
9277     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9278     * put it back to "displaying only" mode
9279     *
9280     * This function makes a clock's time to be editable or not <b>by
9281     * user interaction</b>. When in edition mode, clocks @b stop
9282     * ticking, until one brings them back to canonical mode. The
9283     * elm_clock_digit_edit_set() function will influence which digits
9284     * of the clock will be editable. By default, all of them will be
9285     * (#ELM_CLOCK_NONE).
9286     *
9287     * @note am/pm sheets, if being shown, will @b always be editable
9288     * under edition mode.
9289     *
9290     * @see elm_clock_edit_get()
9291     *
9292     * @ingroup Clock
9293     */
9294    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9295
9296    /**
9297     * Retrieve whether a given clock widget is under <b>edition
9298     * mode</b> or under (default) displaying-only mode.
9299     *
9300     * @param obj The clock object
9301     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9302     * otherwise
9303     *
9304     * This function retrieves whether the clock's time can be edited
9305     * or not by user interaction.
9306     *
9307     * @see elm_clock_edit_set() for more details
9308     *
9309     * @ingroup Clock
9310     */
9311    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9312
9313    /**
9314     * Set what digits of the given clock widget should be editable
9315     * when in edition mode.
9316     *
9317     * @param obj The clock object
9318     * @param digedit Bit mask indicating the digits to be editable
9319     * (values in #Elm_Clock_Digedit).
9320     *
9321     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9322     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9323     * EINA_FALSE).
9324     *
9325     * @see elm_clock_digit_edit_get()
9326     *
9327     * @ingroup Clock
9328     */
9329    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9330
9331    /**
9332     * Retrieve what digits of the given clock widget should be
9333     * editable when in edition mode.
9334     *
9335     * @param obj The clock object
9336     * @return Bit mask indicating the digits to be editable
9337     * (values in #Elm_Clock_Digedit).
9338     *
9339     * @see elm_clock_digit_edit_set() for more details
9340     *
9341     * @ingroup Clock
9342     */
9343    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9344
9345    /**
9346     * Set if the given clock widget must show hours in military or
9347     * am/pm mode
9348     *
9349     * @param obj The clock object
9350     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9351     * to military mode
9352     *
9353     * This function sets if the clock must show hours in military or
9354     * am/pm mode. In some countries like Brazil the military mode
9355     * (00-24h-format) is used, in opposition to the USA, where the
9356     * am/pm mode is more commonly used.
9357     *
9358     * @see elm_clock_show_am_pm_get()
9359     *
9360     * @ingroup Clock
9361     */
9362    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9363
9364    /**
9365     * Get if the given clock widget shows hours in military or am/pm
9366     * mode
9367     *
9368     * @param obj The clock object
9369     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9370     * military
9371     *
9372     * This function gets if the clock shows hours in military or am/pm
9373     * mode.
9374     *
9375     * @see elm_clock_show_am_pm_set() for more details
9376     *
9377     * @ingroup Clock
9378     */
9379    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9380
9381    /**
9382     * Set if the given clock widget must show time with seconds or not
9383     *
9384     * @param obj The clock object
9385     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9386     *
9387     * This function sets if the given clock must show or not elapsed
9388     * seconds. By default, they are @b not shown.
9389     *
9390     * @see elm_clock_show_seconds_get()
9391     *
9392     * @ingroup Clock
9393     */
9394    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9395
9396    /**
9397     * Get whether the given clock widget is showing time with seconds
9398     * or not
9399     *
9400     * @param obj The clock object
9401     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9402     *
9403     * This function gets whether @p obj is showing or not the elapsed
9404     * seconds.
9405     *
9406     * @see elm_clock_show_seconds_set()
9407     *
9408     * @ingroup Clock
9409     */
9410    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9411
9412    /**
9413     * Set the interval on time updates for an user mouse button hold
9414     * on clock widgets' time edition.
9415     *
9416     * @param obj The clock object
9417     * @param interval The (first) interval value in seconds
9418     *
9419     * This interval value is @b decreased while the user holds the
9420     * mouse pointer either incrementing or decrementing a given the
9421     * clock digit's value.
9422     *
9423     * This helps the user to get to a given time distant from the
9424     * current one easier/faster, as it will start to flip quicker and
9425     * quicker on mouse button holds.
9426     *
9427     * The calculation for the next flip interval value, starting from
9428     * the one set with this call, is the previous interval divided by
9429     * 1.05, so it decreases a little bit.
9430     *
9431     * The default starting interval value for automatic flips is
9432     * @b 0.85 seconds.
9433     *
9434     * @see elm_clock_interval_get()
9435     *
9436     * @ingroup Clock
9437     */
9438    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9439
9440    /**
9441     * Get the interval on time updates for an user mouse button hold
9442     * on clock widgets' time edition.
9443     *
9444     * @param obj The clock object
9445     * @return The (first) interval value, in seconds, set on it
9446     *
9447     * @see elm_clock_interval_set() for more details
9448     *
9449     * @ingroup Clock
9450     */
9451    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9452
9453    /**
9454     * @}
9455     */
9456
9457    /**
9458     * @defgroup Layout Layout
9459     *
9460     * @image html img/widget/layout/preview-00.png
9461     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9462     *
9463     * @image html img/layout-predefined.png
9464     * @image latex img/layout-predefined.eps width=\textwidth
9465     *
9466     * This is a container widget that takes a standard Edje design file and
9467     * wraps it very thinly in a widget.
9468     *
9469     * An Edje design (theme) file has a very wide range of possibilities to
9470     * describe the behavior of elements added to the Layout. Check out the Edje
9471     * documentation and the EDC reference to get more information about what can
9472     * be done with Edje.
9473     *
9474     * Just like @ref List, @ref Box, and other container widgets, any
9475     * object added to the Layout will become its child, meaning that it will be
9476     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9477     *
9478     * The Layout widget can contain as many Contents, Boxes or Tables as
9479     * described in its theme file. For instance, objects can be added to
9480     * different Tables by specifying the respective Table part names. The same
9481     * is valid for Content and Box.
9482     *
9483     * The objects added as child of the Layout will behave as described in the
9484     * part description where they were added. There are 3 possible types of
9485     * parts where a child can be added:
9486     *
9487     * @section secContent Content (SWALLOW part)
9488     *
9489     * Only one object can be added to the @c SWALLOW part (but you still can
9490     * have many @c SWALLOW parts and one object on each of them). Use the @c
9491     * elm_layout_content_* set of functions to set, retrieve and unset objects
9492     * as content of the @c SWALLOW. After being set to this part, the object
9493     * size, position, visibility, clipping and other description properties
9494     * will be totally controled by the description of the given part (inside
9495     * the Edje theme file).
9496     *
9497     * One can use @c evas_object_size_hint_* functions on the child to have some
9498     * kind of control over its behavior, but the resulting behavior will still
9499     * depend heavily on the @c SWALLOW part description.
9500     *
9501     * The Edje theme also can change the part description, based on signals or
9502     * scripts running inside the theme. This change can also be animated. All of
9503     * this will affect the child object set as content accordingly. The object
9504     * size will be changed if the part size is changed, it will animate move if
9505     * the part is moving, and so on.
9506     *
9507     * The following picture demonstrates a Layout widget with a child object
9508     * added to its @c SWALLOW:
9509     *
9510     * @image html layout_swallow.png
9511     * @image latex layout_swallow.eps width=\textwidth
9512     *
9513     * @section secBox Box (BOX part)
9514     *
9515     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9516     * allows one to add objects to the box and have them distributed along its
9517     * area, accordingly to the specified @a layout property (now by @a layout we
9518     * mean the chosen layouting design of the Box, not the Layout widget
9519     * itself).
9520     *
9521     * A similar effect for having a box with its position, size and other things
9522     * controled by the Layout theme would be to create an Elementary @ref Box
9523     * widget and add it as a Content in the @c SWALLOW part.
9524     *
9525     * The main difference of using the Layout Box is that its behavior, the box
9526     * properties like layouting format, padding, align, etc. will be all
9527     * controled by the theme. This means, for example, that a signal could be
9528     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9529     * handled the signal by changing the box padding, or align, or both. Using
9530     * the Elementary @ref Box widget is not necessarily harder or easier, it
9531     * just depends on the circunstances and requirements.
9532     *
9533     * The Layout Box can be used through the @c elm_layout_box_* set of
9534     * functions.
9535     *
9536     * The following picture demonstrates a Layout widget with many child objects
9537     * added to its @c BOX part:
9538     *
9539     * @image html layout_box.png
9540     * @image latex layout_box.eps width=\textwidth
9541     *
9542     * @section secTable Table (TABLE part)
9543     *
9544     * Just like the @ref secBox, the Layout Table is very similar to the
9545     * Elementary @ref Table widget. It allows one to add objects to the Table
9546     * specifying the row and column where the object should be added, and any
9547     * column or row span if necessary.
9548     *
9549     * Again, we could have this design by adding a @ref Table widget to the @c
9550     * SWALLOW part using elm_layout_content_set(). The same difference happens
9551     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9552     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9553     *
9554     * The Layout Table can be used through the @c elm_layout_table_* set of
9555     * functions.
9556     *
9557     * The following picture demonstrates a Layout widget with many child objects
9558     * added to its @c TABLE part:
9559     *
9560     * @image html layout_table.png
9561     * @image latex layout_table.eps width=\textwidth
9562     *
9563     * @section secPredef Predefined Layouts
9564     *
9565     * Another interesting thing about the Layout widget is that it offers some
9566     * predefined themes that come with the default Elementary theme. These
9567     * themes can be set by the call elm_layout_theme_set(), and provide some
9568     * basic functionality depending on the theme used.
9569     *
9570     * Most of them already send some signals, some already provide a toolbar or
9571     * back and next buttons.
9572     *
9573     * These are available predefined theme layouts. All of them have class = @c
9574     * layout, group = @c application, and style = one of the following options:
9575     *
9576     * @li @c toolbar-content - application with toolbar and main content area
9577     * @li @c toolbar-content-back - application with toolbar and main content
9578     * area with a back button and title area
9579     * @li @c toolbar-content-back-next - application with toolbar and main
9580     * content area with a back and next buttons and title area
9581     * @li @c content-back - application with a main content area with a back
9582     * button and title area
9583     * @li @c content-back-next - application with a main content area with a
9584     * back and next buttons and title area
9585     * @li @c toolbar-vbox - application with toolbar and main content area as a
9586     * vertical box
9587     * @li @c toolbar-table - application with toolbar and main content area as a
9588     * table
9589     *
9590     * @section secExamples Examples
9591     *
9592     * Some examples of the Layout widget can be found here:
9593     * @li @ref layout_example_01
9594     * @li @ref layout_example_02
9595     * @li @ref layout_example_03
9596     * @li @ref layout_example_edc
9597     *
9598     */
9599
9600    /**
9601     * Add a new layout to the parent
9602     *
9603     * @param parent The parent object
9604     * @return The new object or NULL if it cannot be created
9605     *
9606     * @see elm_layout_file_set()
9607     * @see elm_layout_theme_set()
9608     *
9609     * @ingroup Layout
9610     */
9611    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9612    /**
9613     * Set the file that will be used as layout
9614     *
9615     * @param obj The layout object
9616     * @param file The path to file (edj) that will be used as layout
9617     * @param group The group that the layout belongs in edje file
9618     *
9619     * @return (1 = success, 0 = error)
9620     *
9621     * @ingroup Layout
9622     */
9623    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9624    /**
9625     * Set the edje group from the elementary theme that will be used as layout
9626     *
9627     * @param obj The layout object
9628     * @param clas the clas of the group
9629     * @param group the group
9630     * @param style the style to used
9631     *
9632     * @return (1 = success, 0 = error)
9633     *
9634     * @ingroup Layout
9635     */
9636    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9637    /**
9638     * Set the layout content.
9639     *
9640     * @param obj The layout object
9641     * @param swallow The swallow part name in the edje file
9642     * @param content The child that will be added in this layout object
9643     *
9644     * Once the content object is set, a previously set one will be deleted.
9645     * If you want to keep that old content object, use the
9646     * elm_layout_content_unset() function.
9647     *
9648     * @note In an Edje theme, the part used as a content container is called @c
9649     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9650     * expected to be a part name just like the second parameter of
9651     * elm_layout_box_append().
9652     *
9653     * @see elm_layout_box_append()
9654     * @see elm_layout_content_get()
9655     * @see elm_layout_content_unset()
9656     * @see @ref secBox
9657     *
9658     * @ingroup Layout
9659     */
9660    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9661    /**
9662     * Get the child object in the given content part.
9663     *
9664     * @param obj The layout object
9665     * @param swallow The SWALLOW part to get its content
9666     *
9667     * @return The swallowed object or NULL if none or an error occurred
9668     *
9669     * @see elm_layout_content_set()
9670     *
9671     * @ingroup Layout
9672     */
9673    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9674    /**
9675     * Unset the layout content.
9676     *
9677     * @param obj The layout object
9678     * @param swallow The swallow part name in the edje file
9679     * @return The content that was being used
9680     *
9681     * Unparent and return the content object which was set for this part.
9682     *
9683     * @see elm_layout_content_set()
9684     *
9685     * @ingroup Layout
9686     */
9687     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9688    /**
9689     * Set the text of the given part
9690     *
9691     * @param obj The layout object
9692     * @param part The TEXT part where to set the text
9693     * @param text The text to set
9694     *
9695     * @ingroup Layout
9696     * @deprecated use elm_object_text_* instead.
9697     */
9698    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9699    /**
9700     * Get the text set in the given part
9701     *
9702     * @param obj The layout object
9703     * @param part The TEXT part to retrieve the text off
9704     *
9705     * @return The text set in @p part
9706     *
9707     * @ingroup Layout
9708     * @deprecated use elm_object_text_* instead.
9709     */
9710    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9711    /**
9712     * Append child to layout box part.
9713     *
9714     * @param obj the layout object
9715     * @param part the box part to which the object will be appended.
9716     * @param child the child object to append to box.
9717     *
9718     * Once the object is appended, it will become child of the layout. Its
9719     * lifetime will be bound to the layout, whenever the layout dies the child
9720     * will be deleted automatically. One should use elm_layout_box_remove() to
9721     * make this layout forget about the object.
9722     *
9723     * @see elm_layout_box_prepend()
9724     * @see elm_layout_box_insert_before()
9725     * @see elm_layout_box_insert_at()
9726     * @see elm_layout_box_remove()
9727     *
9728     * @ingroup Layout
9729     */
9730    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9731    /**
9732     * Prepend child to layout box part.
9733     *
9734     * @param obj the layout object
9735     * @param part the box part to prepend.
9736     * @param child the child object to prepend to box.
9737     *
9738     * Once the object is prepended, it will become child of the layout. Its
9739     * lifetime will be bound to the layout, whenever the layout dies the child
9740     * will be deleted automatically. One should use elm_layout_box_remove() to
9741     * make this layout forget about the object.
9742     *
9743     * @see elm_layout_box_append()
9744     * @see elm_layout_box_insert_before()
9745     * @see elm_layout_box_insert_at()
9746     * @see elm_layout_box_remove()
9747     *
9748     * @ingroup Layout
9749     */
9750    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9751    /**
9752     * Insert child to layout box part before a reference object.
9753     *
9754     * @param obj the layout object
9755     * @param part the box part to insert.
9756     * @param child the child object to insert into box.
9757     * @param reference another reference object to insert before in box.
9758     *
9759     * Once the object is inserted, it will become child of the layout. Its
9760     * lifetime will be bound to the layout, whenever the layout dies the child
9761     * will be deleted automatically. One should use elm_layout_box_remove() to
9762     * make this layout forget about the object.
9763     *
9764     * @see elm_layout_box_append()
9765     * @see elm_layout_box_prepend()
9766     * @see elm_layout_box_insert_before()
9767     * @see elm_layout_box_remove()
9768     *
9769     * @ingroup Layout
9770     */
9771    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9772    /**
9773     * Insert child to layout box part at a given position.
9774     *
9775     * @param obj the layout object
9776     * @param part the box part to insert.
9777     * @param child the child object to insert into box.
9778     * @param pos the numeric position >=0 to insert the child.
9779     *
9780     * Once the object is inserted, it will become child of the layout. Its
9781     * lifetime will be bound to the layout, whenever the layout dies the child
9782     * will be deleted automatically. One should use elm_layout_box_remove() to
9783     * make this layout forget about the object.
9784     *
9785     * @see elm_layout_box_append()
9786     * @see elm_layout_box_prepend()
9787     * @see elm_layout_box_insert_before()
9788     * @see elm_layout_box_remove()
9789     *
9790     * @ingroup Layout
9791     */
9792    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9793    /**
9794     * Remove a child of the given part box.
9795     *
9796     * @param obj The layout object
9797     * @param part The box part name to remove child.
9798     * @param child The object to remove from box.
9799     * @return The object that was being used, or NULL if not found.
9800     *
9801     * The object will be removed from the box part and its lifetime will
9802     * not be handled by the layout anymore. This is equivalent to
9803     * elm_layout_content_unset() for box.
9804     *
9805     * @see elm_layout_box_append()
9806     * @see elm_layout_box_remove_all()
9807     *
9808     * @ingroup Layout
9809     */
9810    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9811    /**
9812     * Remove all child of the given part box.
9813     *
9814     * @param obj The layout object
9815     * @param part The box part name to remove child.
9816     * @param clear If EINA_TRUE, then all objects will be deleted as
9817     *        well, otherwise they will just be removed and will be
9818     *        dangling on the canvas.
9819     *
9820     * The objects will be removed from the box part and their lifetime will
9821     * not be handled by the layout anymore. This is equivalent to
9822     * elm_layout_box_remove() for all box children.
9823     *
9824     * @see elm_layout_box_append()
9825     * @see elm_layout_box_remove()
9826     *
9827     * @ingroup Layout
9828     */
9829    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9830    /**
9831     * Insert child to layout table part.
9832     *
9833     * @param obj the layout object
9834     * @param part the box part to pack child.
9835     * @param child_obj the child object to pack into table.
9836     * @param col the column to which the child should be added. (>= 0)
9837     * @param row the row to which the child should be added. (>= 0)
9838     * @param colspan how many columns should be used to store this object. (>=
9839     *        1)
9840     * @param rowspan how many rows should be used to store this object. (>= 1)
9841     *
9842     * Once the object is inserted, it will become child of the table. Its
9843     * lifetime will be bound to the layout, and whenever the layout dies the
9844     * child will be deleted automatically. One should use
9845     * elm_layout_table_remove() to make this layout forget about the object.
9846     *
9847     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9848     * more space than a single cell. For instance, the following code:
9849     * @code
9850     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9851     * @endcode
9852     *
9853     * Would result in an object being added like the following picture:
9854     *
9855     * @image html layout_colspan.png
9856     * @image latex layout_colspan.eps width=\textwidth
9857     *
9858     * @see elm_layout_table_unpack()
9859     * @see elm_layout_table_clear()
9860     *
9861     * @ingroup Layout
9862     */
9863    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);
9864    /**
9865     * Unpack (remove) a child of the given part table.
9866     *
9867     * @param obj The layout object
9868     * @param part The table part name to remove child.
9869     * @param child_obj The object to remove from table.
9870     * @return The object that was being used, or NULL if not found.
9871     *
9872     * The object will be unpacked from the table part and its lifetime
9873     * will not be handled by the layout anymore. This is equivalent to
9874     * elm_layout_content_unset() for table.
9875     *
9876     * @see elm_layout_table_pack()
9877     * @see elm_layout_table_clear()
9878     *
9879     * @ingroup Layout
9880     */
9881    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9882    /**
9883     * Remove all child of the given part table.
9884     *
9885     * @param obj The layout object
9886     * @param part The table part name to remove child.
9887     * @param clear If EINA_TRUE, then all objects will be deleted as
9888     *        well, otherwise they will just be removed and will be
9889     *        dangling on the canvas.
9890     *
9891     * The objects will be removed from the table part and their lifetime will
9892     * not be handled by the layout anymore. This is equivalent to
9893     * elm_layout_table_unpack() for all table children.
9894     *
9895     * @see elm_layout_table_pack()
9896     * @see elm_layout_table_unpack()
9897     *
9898     * @ingroup Layout
9899     */
9900    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9901    /**
9902     * Get the edje layout
9903     *
9904     * @param obj The layout object
9905     *
9906     * @return A Evas_Object with the edje layout settings loaded
9907     * with function elm_layout_file_set
9908     *
9909     * This returns the edje object. It is not expected to be used to then
9910     * swallow objects via edje_object_part_swallow() for example. Use
9911     * elm_layout_content_set() instead so child object handling and sizing is
9912     * done properly.
9913     *
9914     * @note This function should only be used if you really need to call some
9915     * low level Edje function on this edje object. All the common stuff (setting
9916     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9917     * with proper elementary functions.
9918     *
9919     * @see elm_object_signal_callback_add()
9920     * @see elm_object_signal_emit()
9921     * @see elm_object_text_part_set()
9922     * @see elm_layout_content_set()
9923     * @see elm_layout_box_append()
9924     * @see elm_layout_table_pack()
9925     * @see elm_layout_data_get()
9926     *
9927     * @ingroup Layout
9928     */
9929    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9930    /**
9931     * Get the edje data from the given layout
9932     *
9933     * @param obj The layout object
9934     * @param key The data key
9935     *
9936     * @return The edje data string
9937     *
9938     * This function fetches data specified inside the edje theme of this layout.
9939     * This function return NULL if data is not found.
9940     *
9941     * In EDC this comes from a data block within the group block that @p
9942     * obj was loaded from. E.g.
9943     *
9944     * @code
9945     * collections {
9946     *   group {
9947     *     name: "a_group";
9948     *     data {
9949     *       item: "key1" "value1";
9950     *       item: "key2" "value2";
9951     *     }
9952     *   }
9953     * }
9954     * @endcode
9955     *
9956     * @ingroup Layout
9957     */
9958    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9959    /**
9960     * Eval sizing
9961     *
9962     * @param obj The layout object
9963     *
9964     * Manually forces a sizing re-evaluation. This is useful when the minimum
9965     * size required by the edje theme of this layout has changed. The change on
9966     * the minimum size required by the edje theme is not immediately reported to
9967     * the elementary layout, so one needs to call this function in order to tell
9968     * the widget (layout) that it needs to reevaluate its own size.
9969     *
9970     * The minimum size of the theme is calculated based on minimum size of
9971     * parts, the size of elements inside containers like box and table, etc. All
9972     * of this can change due to state changes, and that's when this function
9973     * should be called.
9974     *
9975     * Also note that a standard signal of "size,eval" "elm" emitted from the
9976     * edje object will cause this to happen too.
9977     *
9978     * @ingroup Layout
9979     */
9980    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9981
9982    /**
9983     * Sets a specific cursor for an edje part.
9984     *
9985     * @param obj The layout object.
9986     * @param part_name a part from loaded edje group.
9987     * @param cursor cursor name to use, see Elementary_Cursor.h
9988     *
9989     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9990     *         part not exists or it has "mouse_events: 0".
9991     *
9992     * @ingroup Layout
9993     */
9994    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9995
9996    /**
9997     * Get the cursor to be shown when mouse is over an edje part
9998     *
9999     * @param obj The layout object.
10000     * @param part_name a part from loaded edje group.
10001     * @return the cursor name.
10002     *
10003     * @ingroup Layout
10004     */
10005    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10006
10007    /**
10008     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10009     *
10010     * @param obj The layout object.
10011     * @param part_name a part from loaded edje group, that had a cursor set
10012     *        with elm_layout_part_cursor_set().
10013     *
10014     * @ingroup Layout
10015     */
10016    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10017
10018    /**
10019     * Sets a specific cursor style for an edje part.
10020     *
10021     * @param obj The layout object.
10022     * @param part_name a part from loaded edje group.
10023     * @param style the theme style to use (default, transparent, ...)
10024     *
10025     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10026     *         part not exists or it did not had a cursor set.
10027     *
10028     * @ingroup Layout
10029     */
10030    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10031
10032    /**
10033     * Gets a specific cursor style for an edje part.
10034     *
10035     * @param obj The layout object.
10036     * @param part_name a part from loaded edje group.
10037     *
10038     * @return the theme style in use, defaults to "default". If the
10039     *         object does not have a cursor set, then NULL is returned.
10040     *
10041     * @ingroup Layout
10042     */
10043    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10044
10045    /**
10046     * Sets if the cursor set should be searched on the theme or should use
10047     * the provided by the engine, only.
10048     *
10049     * @note before you set if should look on theme you should define a
10050     * cursor with elm_layout_part_cursor_set(). By default it will only
10051     * look for cursors provided by the engine.
10052     *
10053     * @param obj The layout object.
10054     * @param part_name a part from loaded edje group.
10055     * @param engine_only if cursors should be just provided by the engine
10056     *        or should also search on widget's theme as well
10057     *
10058     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10059     *         part not exists or it did not had a cursor set.
10060     *
10061     * @ingroup Layout
10062     */
10063    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);
10064
10065    /**
10066     * Gets a specific cursor engine_only for an edje part.
10067     *
10068     * @param obj The layout object.
10069     * @param part_name a part from loaded edje group.
10070     *
10071     * @return whenever the cursor is just provided by engine or also from theme.
10072     *
10073     * @ingroup Layout
10074     */
10075    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10076
10077 /**
10078  * @def elm_layout_icon_set
10079  * Convienience macro to set the icon object in a layout that follows the
10080  * Elementary naming convention for its parts.
10081  *
10082  * @ingroup Layout
10083  */
10084 #define elm_layout_icon_set(_ly, _obj) \
10085   do { \
10086     const char *sig; \
10087     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10088     if ((_obj)) sig = "elm,state,icon,visible"; \
10089     else sig = "elm,state,icon,hidden"; \
10090     elm_object_signal_emit((_ly), sig, "elm"); \
10091   } while (0)
10092
10093 /**
10094  * @def elm_layout_icon_get
10095  * Convienience macro to get the icon object from a layout that follows the
10096  * Elementary naming convention for its parts.
10097  *
10098  * @ingroup Layout
10099  */
10100 #define elm_layout_icon_get(_ly) \
10101   elm_layout_content_get((_ly), "elm.swallow.icon")
10102
10103 /**
10104  * @def elm_layout_end_set
10105  * Convienience macro to set the end object in a layout that follows the
10106  * Elementary naming convention for its parts.
10107  *
10108  * @ingroup Layout
10109  */
10110 #define elm_layout_end_set(_ly, _obj) \
10111   do { \
10112     const char *sig; \
10113     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10114     if ((_obj)) sig = "elm,state,end,visible"; \
10115     else sig = "elm,state,end,hidden"; \
10116     elm_object_signal_emit((_ly), sig, "elm"); \
10117   } while (0)
10118
10119 /**
10120  * @def elm_layout_end_get
10121  * Convienience macro to get the end object in a layout that follows the
10122  * Elementary naming convention for its parts.
10123  *
10124  * @ingroup Layout
10125  */
10126 #define elm_layout_end_get(_ly) \
10127   elm_layout_content_get((_ly), "elm.swallow.end")
10128
10129 /**
10130  * @def elm_layout_label_set
10131  * Convienience macro to set the label in a layout that follows the
10132  * Elementary naming convention for its parts.
10133  *
10134  * @ingroup Layout
10135  * @deprecated use elm_object_text_* instead.
10136  */
10137 #define elm_layout_label_set(_ly, _txt) \
10138   elm_layout_text_set((_ly), "elm.text", (_txt))
10139
10140 /**
10141  * @def elm_layout_label_get
10142  * Convienience macro to get the label in a layout that follows the
10143  * Elementary naming convention for its parts.
10144  *
10145  * @ingroup Layout
10146  * @deprecated use elm_object_text_* instead.
10147  */
10148 #define elm_layout_label_get(_ly) \
10149   elm_layout_text_get((_ly), "elm.text")
10150
10151    /* smart callbacks called:
10152     * "theme,changed" - when elm theme is changed.
10153     */
10154
10155    /**
10156     * @defgroup Notify Notify
10157     *
10158     * @image html img/widget/notify/preview-00.png
10159     * @image latex img/widget/notify/preview-00.eps
10160     *
10161     * Display a container in a particular region of the parent(top, bottom,
10162     * etc.  A timeout can be set to automatically hide the notify. This is so
10163     * that, after an evas_object_show() on a notify object, if a timeout was set
10164     * on it, it will @b automatically get hidden after that time.
10165     *
10166     * Signals that you can add callbacks for are:
10167     * @li "timeout" - when timeout happens on notify and it's hidden
10168     * @li "block,clicked" - when a click outside of the notify happens
10169     *
10170     * @ref tutorial_notify show usage of the API.
10171     *
10172     * @{
10173     */
10174    /**
10175     * @brief Possible orient values for notify.
10176     *
10177     * This values should be used in conjunction to elm_notify_orient_set() to
10178     * set the position in which the notify should appear(relative to its parent)
10179     * and in conjunction with elm_notify_orient_get() to know where the notify
10180     * is appearing.
10181     */
10182    typedef enum _Elm_Notify_Orient
10183      {
10184         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10185         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10186         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10187         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10188         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10189         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10190         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10191         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10192         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10193         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10194      } Elm_Notify_Orient;
10195    /**
10196     * @brief Add a new notify to the parent
10197     *
10198     * @param parent The parent object
10199     * @return The new object or NULL if it cannot be created
10200     */
10201    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10202    /**
10203     * @brief Set the content of the notify widget
10204     *
10205     * @param obj The notify object
10206     * @param content The content will be filled in this notify object
10207     *
10208     * Once the content object is set, a previously set one will be deleted. If
10209     * you want to keep that old content object, use the
10210     * elm_notify_content_unset() function.
10211     */
10212    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10213    /**
10214     * @brief Unset the content of the notify widget
10215     *
10216     * @param obj The notify object
10217     * @return The content that was being used
10218     *
10219     * Unparent and return the content object which was set for this widget
10220     *
10221     * @see elm_notify_content_set()
10222     */
10223    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10224    /**
10225     * @brief Return the content of the notify widget
10226     *
10227     * @param obj The notify object
10228     * @return The content that is being used
10229     *
10230     * @see elm_notify_content_set()
10231     */
10232    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10233    /**
10234     * @brief Set the notify parent
10235     *
10236     * @param obj The notify object
10237     * @param content The new parent
10238     *
10239     * Once the parent object is set, a previously set one will be disconnected
10240     * and replaced.
10241     */
10242    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10243    /**
10244     * @brief Get the notify parent
10245     *
10246     * @param obj The notify object
10247     * @return The parent
10248     *
10249     * @see elm_notify_parent_set()
10250     */
10251    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10252    /**
10253     * @brief Set the orientation
10254     *
10255     * @param obj The notify object
10256     * @param orient The new orientation
10257     *
10258     * Sets the position in which the notify will appear in its parent.
10259     *
10260     * @see @ref Elm_Notify_Orient for possible values.
10261     */
10262    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10263    /**
10264     * @brief Return the orientation
10265     * @param obj The notify object
10266     * @return The orientation of the notification
10267     *
10268     * @see elm_notify_orient_set()
10269     * @see Elm_Notify_Orient
10270     */
10271    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10272    /**
10273     * @brief Set the time interval after which the notify window is going to be
10274     * hidden.
10275     *
10276     * @param obj The notify object
10277     * @param time The timeout in seconds
10278     *
10279     * This function sets a timeout and starts the timer controlling when the
10280     * notify is hidden. Since calling evas_object_show() on a notify restarts
10281     * the timer controlling when the notify is hidden, setting this before the
10282     * notify is shown will in effect mean starting the timer when the notify is
10283     * shown.
10284     *
10285     * @note Set a value <= 0.0 to disable a running timer.
10286     *
10287     * @note If the value > 0.0 and the notify is previously visible, the
10288     * timer will be started with this value, canceling any running timer.
10289     */
10290    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10291    /**
10292     * @brief Return the timeout value (in seconds)
10293     * @param obj the notify object
10294     *
10295     * @see elm_notify_timeout_set()
10296     */
10297    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10298    /**
10299     * @brief Sets whether events should be passed to by a click outside
10300     * its area.
10301     *
10302     * @param obj The notify object
10303     * @param repeats EINA_TRUE Events are repeats, else no
10304     *
10305     * When true if the user clicks outside the window the events will be caught
10306     * by the others widgets, else the events are blocked.
10307     *
10308     * @note The default value is EINA_TRUE.
10309     */
10310    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10311    /**
10312     * @brief Return true if events are repeat below the notify object
10313     * @param obj the notify object
10314     *
10315     * @see elm_notify_repeat_events_set()
10316     */
10317    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10318    /**
10319     * @}
10320     */
10321
10322    /**
10323     * @defgroup Hover Hover
10324     *
10325     * @image html img/widget/hover/preview-00.png
10326     * @image latex img/widget/hover/preview-00.eps
10327     *
10328     * A Hover object will hover over its @p parent object at the @p target
10329     * location. Anything in the background will be given a darker coloring to
10330     * indicate that the hover object is on top (at the default theme). When the
10331     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10332     * clicked that @b doesn't cause the hover to be dismissed.
10333     *
10334     * @note The hover object will take up the entire space of @p target
10335     * object.
10336     *
10337     * Elementary has the following styles for the hover widget:
10338     * @li default
10339     * @li popout
10340     * @li menu
10341     * @li hoversel_vertical
10342     *
10343     * The following are the available position for content:
10344     * @li left
10345     * @li top-left
10346     * @li top
10347     * @li top-right
10348     * @li right
10349     * @li bottom-right
10350     * @li bottom
10351     * @li bottom-left
10352     * @li middle
10353     * @li smart
10354     *
10355     * Signals that you can add callbacks for are:
10356     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10357     * @li "smart,changed" - a content object placed under the "smart"
10358     *                   policy was replaced to a new slot direction.
10359     *
10360     * See @ref tutorial_hover for more information.
10361     *
10362     * @{
10363     */
10364    typedef enum _Elm_Hover_Axis
10365      {
10366         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10367         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10368         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10369         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10370      } Elm_Hover_Axis;
10371    /**
10372     * @brief Adds a hover object to @p parent
10373     *
10374     * @param parent The parent object
10375     * @return The hover object or NULL if one could not be created
10376     */
10377    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10378    /**
10379     * @brief Sets the target object for the hover.
10380     *
10381     * @param obj The hover object
10382     * @param target The object to center the hover onto. The hover
10383     *
10384     * This function will cause the hover to be centered on the target object.
10385     */
10386    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10387    /**
10388     * @brief Gets the target object for the hover.
10389     *
10390     * @param obj The hover object
10391     * @param parent The object to locate the hover over.
10392     *
10393     * @see elm_hover_target_set()
10394     */
10395    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10396    /**
10397     * @brief Sets the parent object for the hover.
10398     *
10399     * @param obj The hover object
10400     * @param parent The object to locate the hover over.
10401     *
10402     * This function will cause the hover to take up the entire space that the
10403     * parent object fills.
10404     */
10405    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10406    /**
10407     * @brief Gets the parent object for the hover.
10408     *
10409     * @param obj The hover object
10410     * @return The parent object to locate the hover over.
10411     *
10412     * @see elm_hover_parent_set()
10413     */
10414    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10415    /**
10416     * @brief Sets the content of the hover object and the direction in which it
10417     * will pop out.
10418     *
10419     * @param obj The hover object
10420     * @param swallow The direction that the object will be displayed
10421     * at. Accepted values are "left", "top-left", "top", "top-right",
10422     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10423     * "smart".
10424     * @param content The content to place at @p swallow
10425     *
10426     * Once the content object is set for a given direction, a previously
10427     * set one (on the same direction) will be deleted. If you want to
10428     * keep that old content object, use the elm_hover_content_unset()
10429     * function.
10430     *
10431     * All directions may have contents at the same time, except for
10432     * "smart". This is a special placement hint and its use case
10433     * independs of the calculations coming from
10434     * elm_hover_best_content_location_get(). Its use is for cases when
10435     * one desires only one hover content, but with a dinamic special
10436     * placement within the hover area. The content's geometry, whenever
10437     * it changes, will be used to decide on a best location not
10438     * extrapolating the hover's parent object view to show it in (still
10439     * being the hover's target determinant of its medium part -- move and
10440     * resize it to simulate finger sizes, for example). If one of the
10441     * directions other than "smart" are used, a previously content set
10442     * using it will be deleted, and vice-versa.
10443     */
10444    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10445    /**
10446     * @brief Get the content of the hover object, in a given direction.
10447     *
10448     * Return the content object which was set for this widget in the
10449     * @p swallow direction.
10450     *
10451     * @param obj The hover object
10452     * @param swallow The direction that the object was display at.
10453     * @return The content that was being used
10454     *
10455     * @see elm_hover_content_set()
10456     */
10457    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10458    /**
10459     * @brief Unset the content of the hover object, in a given direction.
10460     *
10461     * Unparent and return the content object set at @p swallow direction.
10462     *
10463     * @param obj The hover object
10464     * @param swallow The direction that the object was display at.
10465     * @return The content that was being used.
10466     *
10467     * @see elm_hover_content_set()
10468     */
10469    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10470    /**
10471     * @brief Returns the best swallow location for content in the hover.
10472     *
10473     * @param obj The hover object
10474     * @param pref_axis The preferred orientation axis for the hover object to use
10475     * @return The edje location to place content into the hover or @c
10476     *         NULL, on errors.
10477     *
10478     * Best is defined here as the location at which there is the most available
10479     * space.
10480     *
10481     * @p pref_axis may be one of
10482     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10483     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10484     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10485     * - @c ELM_HOVER_AXIS_BOTH -- both
10486     *
10487     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10488     * nescessarily be along the horizontal axis("left" or "right"). If
10489     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10490     * be along the vertical axis("top" or "bottom"). Chossing
10491     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10492     * returned position may be in either axis.
10493     *
10494     * @see elm_hover_content_set()
10495     */
10496    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10497    /**
10498     * @}
10499     */
10500
10501    /* entry */
10502    /**
10503     * @defgroup Entry Entry
10504     *
10505     * @image html img/widget/entry/preview-00.png
10506     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10507     * @image html img/widget/entry/preview-01.png
10508     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10509     * @image html img/widget/entry/preview-02.png
10510     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10511     * @image html img/widget/entry/preview-03.png
10512     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10513     *
10514     * An entry is a convenience widget which shows a box that the user can
10515     * enter text into. Entries by default don't scroll, so they grow to
10516     * accomodate the entire text, resizing the parent window as needed. This
10517     * can be changed with the elm_entry_scrollable_set() function.
10518     *
10519     * They can also be single line or multi line (the default) and when set
10520     * to multi line mode they support text wrapping in any of the modes
10521     * indicated by #Elm_Wrap_Type.
10522     *
10523     * Other features include password mode, filtering of inserted text with
10524     * elm_entry_text_filter_append() and related functions, inline "items" and
10525     * formatted markup text.
10526     *
10527     * @section entry-markup Formatted text
10528     *
10529     * The markup tags supported by the Entry are defined by the theme, but
10530     * even when writing new themes or extensions it's a good idea to stick to
10531     * a sane default, to maintain coherency and avoid application breakages.
10532     * Currently defined by the default theme are the following tags:
10533     * @li \<br\>: Inserts a line break.
10534     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10535     * breaks.
10536     * @li \<tab\>: Inserts a tab.
10537     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10538     * enclosed text.
10539     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10540     * @li \<link\>...\</link\>: Underlines the enclosed text.
10541     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10542     *
10543     * @section entry-special Special markups
10544     *
10545     * Besides those used to format text, entries support two special markup
10546     * tags used to insert clickable portions of text or items inlined within
10547     * the text.
10548     *
10549     * @subsection entry-anchors Anchors
10550     *
10551     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10552     * \</a\> tags and an event will be generated when this text is clicked,
10553     * like this:
10554     *
10555     * @code
10556     * This text is outside <a href=anc-01>but this one is an anchor</a>
10557     * @endcode
10558     *
10559     * The @c href attribute in the opening tag gives the name that will be
10560     * used to identify the anchor and it can be any valid utf8 string.
10561     *
10562     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10563     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10564     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10565     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10566     * an anchor.
10567     *
10568     * @subsection entry-items Items
10569     *
10570     * Inlined in the text, any other @c Evas_Object can be inserted by using
10571     * \<item\> tags this way:
10572     *
10573     * @code
10574     * <item size=16x16 vsize=full href=emoticon/haha></item>
10575     * @endcode
10576     *
10577     * Just like with anchors, the @c href identifies each item, but these need,
10578     * in addition, to indicate their size, which is done using any one of
10579     * @c size, @c absize or @c relsize attributes. These attributes take their
10580     * value in the WxH format, where W is the width and H the height of the
10581     * item.
10582     *
10583     * @li absize: Absolute pixel size for the item. Whatever value is set will
10584     * be the item's size regardless of any scale value the object may have
10585     * been set to. The final line height will be adjusted to fit larger items.
10586     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10587     * for the object.
10588     * @li relsize: Size is adjusted for the item to fit within the current
10589     * line height.
10590     *
10591     * Besides their size, items are specificed a @c vsize value that affects
10592     * how their final size and position are calculated. The possible values
10593     * are:
10594     * @li ascent: Item will be placed within the line's baseline and its
10595     * ascent. That is, the height between the line where all characters are
10596     * positioned and the highest point in the line. For @c size and @c absize
10597     * items, the descent value will be added to the total line height to make
10598     * them fit. @c relsize items will be adjusted to fit within this space.
10599     * @li full: Items will be placed between the descent and ascent, or the
10600     * lowest point in the line and its highest.
10601     *
10602     * The next image shows different configurations of items and how they
10603     * are the previously mentioned options affect their sizes. In all cases,
10604     * the green line indicates the ascent, blue for the baseline and red for
10605     * the descent.
10606     *
10607     * @image html entry_item.png
10608     * @image latex entry_item.eps width=\textwidth
10609     *
10610     * And another one to show how size differs from absize. In the first one,
10611     * the scale value is set to 1.0, while the second one is using one of 2.0.
10612     *
10613     * @image html entry_item_scale.png
10614     * @image latex entry_item_scale.eps width=\textwidth
10615     *
10616     * After the size for an item is calculated, the entry will request an
10617     * object to place in its space. For this, the functions set with
10618     * elm_entry_item_provider_append() and related functions will be called
10619     * in order until one of them returns a @c non-NULL value. If no providers
10620     * are available, or all of them return @c NULL, then the entry falls back
10621     * to one of the internal defaults, provided the name matches with one of
10622     * them.
10623     *
10624     * All of the following are currently supported:
10625     *
10626     * - emoticon/angry
10627     * - emoticon/angry-shout
10628     * - emoticon/crazy-laugh
10629     * - emoticon/evil-laugh
10630     * - emoticon/evil
10631     * - emoticon/goggle-smile
10632     * - emoticon/grumpy
10633     * - emoticon/grumpy-smile
10634     * - emoticon/guilty
10635     * - emoticon/guilty-smile
10636     * - emoticon/haha
10637     * - emoticon/half-smile
10638     * - emoticon/happy-panting
10639     * - emoticon/happy
10640     * - emoticon/indifferent
10641     * - emoticon/kiss
10642     * - emoticon/knowing-grin
10643     * - emoticon/laugh
10644     * - emoticon/little-bit-sorry
10645     * - emoticon/love-lots
10646     * - emoticon/love
10647     * - emoticon/minimal-smile
10648     * - emoticon/not-happy
10649     * - emoticon/not-impressed
10650     * - emoticon/omg
10651     * - emoticon/opensmile
10652     * - emoticon/smile
10653     * - emoticon/sorry
10654     * - emoticon/squint-laugh
10655     * - emoticon/surprised
10656     * - emoticon/suspicious
10657     * - emoticon/tongue-dangling
10658     * - emoticon/tongue-poke
10659     * - emoticon/uh
10660     * - emoticon/unhappy
10661     * - emoticon/very-sorry
10662     * - emoticon/what
10663     * - emoticon/wink
10664     * - emoticon/worried
10665     * - emoticon/wtf
10666     *
10667     * Alternatively, an item may reference an image by its path, using
10668     * the URI form @c file:///path/to/an/image.png and the entry will then
10669     * use that image for the item.
10670     *
10671     * @section entry-files Loading and saving files
10672     *
10673     * Entries have convinience functions to load text from a file and save
10674     * changes back to it after a short delay. The automatic saving is enabled
10675     * by default, but can be disabled with elm_entry_autosave_set() and files
10676     * can be loaded directly as plain text or have any markup in them
10677     * recognized. See elm_entry_file_set() for more details.
10678     *
10679     * @section entry-signals Emitted signals
10680     *
10681     * This widget emits the following signals:
10682     *
10683     * @li "changed": The text within the entry was changed.
10684     * @li "changed,user": The text within the entry was changed because of user interaction.
10685     * @li "activated": The enter key was pressed on a single line entry.
10686     * @li "press": A mouse button has been pressed on the entry.
10687     * @li "longpressed": A mouse button has been pressed and held for a couple
10688     * seconds.
10689     * @li "clicked": The entry has been clicked (mouse press and release).
10690     * @li "clicked,double": The entry has been double clicked.
10691     * @li "clicked,triple": The entry has been triple clicked.
10692     * @li "focused": The entry has received focus.
10693     * @li "unfocused": The entry has lost focus.
10694     * @li "selection,paste": A paste of the clipboard contents was requested.
10695     * @li "selection,copy": A copy of the selected text into the clipboard was
10696     * requested.
10697     * @li "selection,cut": A cut of the selected text into the clipboard was
10698     * requested.
10699     * @li "selection,start": A selection has begun and no previous selection
10700     * existed.
10701     * @li "selection,changed": The current selection has changed.
10702     * @li "selection,cleared": The current selection has been cleared.
10703     * @li "cursor,changed": The cursor has changed position.
10704     * @li "anchor,clicked": An anchor has been clicked. The event_info
10705     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10706     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10707     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10708     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10709     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10710     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10711     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10712     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10713     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10714     * @li "preedit,changed": The preedit string has changed.
10715     *
10716     * @section entry-examples
10717     *
10718     * An overview of the Entry API can be seen in @ref entry_example_01
10719     *
10720     * @{
10721     */
10722    /**
10723     * @typedef Elm_Entry_Anchor_Info
10724     *
10725     * The info sent in the callback for the "anchor,clicked" signals emitted
10726     * by entries.
10727     */
10728    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10729    /**
10730     * @struct _Elm_Entry_Anchor_Info
10731     *
10732     * The info sent in the callback for the "anchor,clicked" signals emitted
10733     * by entries.
10734     */
10735    struct _Elm_Entry_Anchor_Info
10736      {
10737         const char *name; /**< The name of the anchor, as stated in its href */
10738         int         button; /**< The mouse button used to click on it */
10739         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10740                     y, /**< Anchor geometry, relative to canvas */
10741                     w, /**< Anchor geometry, relative to canvas */
10742                     h; /**< Anchor geometry, relative to canvas */
10743      };
10744    /**
10745     * @typedef Elm_Entry_Filter_Cb
10746     * This callback type is used by entry filters to modify text.
10747     * @param data The data specified as the last param when adding the filter
10748     * @param entry The entry object
10749     * @param text A pointer to the location of the text being filtered. This data can be modified,
10750     * but any additional allocations must be managed by the user.
10751     * @see elm_entry_text_filter_append
10752     * @see elm_entry_text_filter_prepend
10753     */
10754    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10755
10756    /**
10757     * This adds an entry to @p parent object.
10758     *
10759     * By default, entries are:
10760     * @li not scrolled
10761     * @li multi-line
10762     * @li word wrapped
10763     * @li autosave is enabled
10764     *
10765     * @param parent The parent object
10766     * @return The new object or NULL if it cannot be created
10767     */
10768    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10769    /**
10770     * Sets the entry to single line mode.
10771     *
10772     * In single line mode, entries don't ever wrap when the text reaches the
10773     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10774     * key will generate an @c "activate" event instead of adding a new line.
10775     *
10776     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10777     * and pressing enter will break the text into a different line
10778     * without generating any events.
10779     *
10780     * @param obj The entry object
10781     * @param single_line If true, the text in the entry
10782     * will be on a single line.
10783     */
10784    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10785    /**
10786     * Gets whether the entry is set to be single line.
10787     *
10788     * @param obj The entry object
10789     * @return single_line If true, the text in the entry is set to display
10790     * on a single line.
10791     *
10792     * @see elm_entry_single_line_set()
10793     */
10794    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10795    /**
10796     * Sets the entry to password mode.
10797     *
10798     * In password mode, entries are implicitly single line and the display of
10799     * any text in them is replaced with asterisks (*).
10800     *
10801     * @param obj The entry object
10802     * @param password If true, password mode is enabled.
10803     */
10804    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10805    /**
10806     * Gets whether the entry is set to password mode.
10807     *
10808     * @param obj The entry object
10809     * @return If true, the entry is set to display all characters
10810     * as asterisks (*).
10811     *
10812     * @see elm_entry_password_set()
10813     */
10814    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10815    /**
10816     * This sets the text displayed within the entry to @p entry.
10817     *
10818     * @param obj The entry object
10819     * @param entry The text to be displayed
10820     *
10821     * @deprecated Use elm_object_text_set() instead.
10822     */
10823    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10824    /**
10825     * This returns the text currently shown in object @p entry.
10826     * See also elm_entry_entry_set().
10827     *
10828     * @param obj The entry object
10829     * @return The currently displayed text or NULL on failure
10830     *
10831     * @deprecated Use elm_object_text_get() instead.
10832     */
10833    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10834    /**
10835     * Appends @p entry to the text of the entry.
10836     *
10837     * Adds the text in @p entry to the end of any text already present in the
10838     * widget.
10839     *
10840     * The appended text is subject to any filters set for the widget.
10841     *
10842     * @param obj The entry object
10843     * @param entry The text to be displayed
10844     *
10845     * @see elm_entry_text_filter_append()
10846     */
10847    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10848    /**
10849     * Gets whether the entry is empty.
10850     *
10851     * Empty means no text at all. If there are any markup tags, like an item
10852     * tag for which no provider finds anything, and no text is displayed, this
10853     * function still returns EINA_FALSE.
10854     *
10855     * @param obj The entry object
10856     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10857     */
10858    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10859    /**
10860     * Gets any selected text within the entry.
10861     *
10862     * If there's any selected text in the entry, this function returns it as
10863     * a string in markup format. NULL is returned if no selection exists or
10864     * if an error occurred.
10865     *
10866     * The returned value points to an internal string and should not be freed
10867     * or modified in any way. If the @p entry object is deleted or its
10868     * contents are changed, the returned pointer should be considered invalid.
10869     *
10870     * @param obj The entry object
10871     * @return The selected text within the entry or NULL on failure
10872     */
10873    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10874    /**
10875     * Inserts the given text into the entry at the current cursor position.
10876     *
10877     * This inserts text at the cursor position as if it was typed
10878     * by the user (note that this also allows markup which a user
10879     * can't just "type" as it would be converted to escaped text, so this
10880     * call can be used to insert things like emoticon items or bold push/pop
10881     * tags, other font and color change tags etc.)
10882     *
10883     * If any selection exists, it will be replaced by the inserted text.
10884     *
10885     * The inserted text is subject to any filters set for the widget.
10886     *
10887     * @param obj The entry object
10888     * @param entry The text to insert
10889     *
10890     * @see elm_entry_text_filter_append()
10891     */
10892    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10893    /**
10894     * Set the line wrap type to use on multi-line entries.
10895     *
10896     * Sets the wrap type used by the entry to any of the specified in
10897     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10898     * line (without inserting a line break or paragraph separator) when it
10899     * reaches the far edge of the widget.
10900     *
10901     * Note that this only makes sense for multi-line entries. A widget set
10902     * to be single line will never wrap.
10903     *
10904     * @param obj The entry object
10905     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10906     */
10907    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10908    /**
10909     * Gets the wrap mode the entry was set to use.
10910     *
10911     * @param obj The entry object
10912     * @return Wrap type
10913     *
10914     * @see also elm_entry_line_wrap_set()
10915     */
10916    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10917    /**
10918     * Sets if the entry is to be editable or not.
10919     *
10920     * By default, entries are editable and when focused, any text input by the
10921     * user will be inserted at the current cursor position. But calling this
10922     * function with @p editable as EINA_FALSE will prevent the user from
10923     * inputting text into the entry.
10924     *
10925     * The only way to change the text of a non-editable entry is to use
10926     * elm_object_text_set(), elm_entry_entry_insert() and other related
10927     * functions.
10928     *
10929     * @param obj The entry object
10930     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10931     * if not, the entry is read-only and no user input is allowed.
10932     */
10933    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10934    /**
10935     * Gets whether the entry is editable or not.
10936     *
10937     * @param obj The entry object
10938     * @return If true, the entry is editable by the user.
10939     * If false, it is not editable by the user
10940     *
10941     * @see elm_entry_editable_set()
10942     */
10943    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10944    /**
10945     * This drops any existing text selection within the entry.
10946     *
10947     * @param obj The entry object
10948     */
10949    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10950    /**
10951     * This selects all text within the entry.
10952     *
10953     * @param obj The entry object
10954     */
10955    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10956    /**
10957     * This moves the cursor one place to the right within the entry.
10958     *
10959     * @param obj The entry object
10960     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10961     */
10962    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10963    /**
10964     * This moves the cursor one place to the left within the entry.
10965     *
10966     * @param obj The entry object
10967     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10968     */
10969    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10970    /**
10971     * This moves the cursor one line up within the entry.
10972     *
10973     * @param obj The entry object
10974     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10975     */
10976    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10977    /**
10978     * This moves the cursor one line down within the entry.
10979     *
10980     * @param obj The entry object
10981     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10982     */
10983    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10984    /**
10985     * This moves the cursor to the beginning of the entry.
10986     *
10987     * @param obj The entry object
10988     */
10989    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10990    /**
10991     * This moves the cursor to the end of the entry.
10992     *
10993     * @param obj The entry object
10994     */
10995    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10996    /**
10997     * This moves the cursor to the beginning of the current line.
10998     *
10999     * @param obj The entry object
11000     */
11001    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11002    /**
11003     * This moves the cursor to the end of the current line.
11004     *
11005     * @param obj The entry object
11006     */
11007    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11008    /**
11009     * This begins a selection within the entry as though
11010     * the user were holding down the mouse button to make a selection.
11011     *
11012     * @param obj The entry object
11013     */
11014    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11015    /**
11016     * This ends a selection within the entry as though
11017     * the user had just released the mouse button while making a selection.
11018     *
11019     * @param obj The entry object
11020     */
11021    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11022    /**
11023     * Gets whether a format node exists at the current cursor position.
11024     *
11025     * A format node is anything that defines how the text is rendered. It can
11026     * be a visible format node, such as a line break or a paragraph separator,
11027     * or an invisible one, such as bold begin or end tag.
11028     * This function returns whether any format node exists at the current
11029     * cursor position.
11030     *
11031     * @param obj The entry object
11032     * @return EINA_TRUE if the current cursor position contains a format node,
11033     * EINA_FALSE otherwise.
11034     *
11035     * @see elm_entry_cursor_is_visible_format_get()
11036     */
11037    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11038    /**
11039     * Gets if the current cursor position holds a visible format node.
11040     *
11041     * @param obj The entry object
11042     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11043     * if it's an invisible one or no format exists.
11044     *
11045     * @see elm_entry_cursor_is_format_get()
11046     */
11047    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11048    /**
11049     * Gets the character pointed by the cursor at its current position.
11050     *
11051     * This function returns a string with the utf8 character stored at the
11052     * current cursor position.
11053     * Only the text is returned, any format that may exist will not be part
11054     * of the return value.
11055     *
11056     * @param obj The entry object
11057     * @return The text pointed by the cursors.
11058     */
11059    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11060    /**
11061     * This function returns the geometry of the cursor.
11062     *
11063     * It's useful if you want to draw something on the cursor (or where it is),
11064     * or for example in the case of scrolled entry where you want to show the
11065     * cursor.
11066     *
11067     * @param obj The entry object
11068     * @param x returned geometry
11069     * @param y returned geometry
11070     * @param w returned geometry
11071     * @param h returned geometry
11072     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11073     */
11074    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);
11075    /**
11076     * Sets the cursor position in the entry to the given value
11077     *
11078     * The value in @p pos is the index of the character position within the
11079     * contents of the string as returned by elm_entry_cursor_pos_get().
11080     *
11081     * @param obj The entry object
11082     * @param pos The position of the cursor
11083     */
11084    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11085    /**
11086     * Retrieves the current position of the cursor in the entry
11087     *
11088     * @param obj The entry object
11089     * @return The cursor position
11090     */
11091    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11092    /**
11093     * This executes a "cut" action on the selected text in the entry.
11094     *
11095     * @param obj The entry object
11096     */
11097    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11098    /**
11099     * This executes a "copy" action on the selected text in the entry.
11100     *
11101     * @param obj The entry object
11102     */
11103    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11104    /**
11105     * This executes a "paste" action in the entry.
11106     *
11107     * @param obj The entry object
11108     */
11109    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11110    /**
11111     * This clears and frees the items in a entry's contextual (longpress)
11112     * menu.
11113     *
11114     * @param obj The entry object
11115     *
11116     * @see elm_entry_context_menu_item_add()
11117     */
11118    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11119    /**
11120     * This adds an item to the entry's contextual menu.
11121     *
11122     * A longpress on an entry will make the contextual menu show up, if this
11123     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11124     * By default, this menu provides a few options like enabling selection mode,
11125     * which is useful on embedded devices that need to be explicit about it,
11126     * and when a selection exists it also shows the copy and cut actions.
11127     *
11128     * With this function, developers can add other options to this menu to
11129     * perform any action they deem necessary.
11130     *
11131     * @param obj The entry object
11132     * @param label The item's text label
11133     * @param icon_file The item's icon file
11134     * @param icon_type The item's icon type
11135     * @param func The callback to execute when the item is clicked
11136     * @param data The data to associate with the item for related functions
11137     */
11138    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);
11139    /**
11140     * This disables the entry's contextual (longpress) menu.
11141     *
11142     * @param obj The entry object
11143     * @param disabled If true, the menu is disabled
11144     */
11145    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11146    /**
11147     * This returns whether the entry's contextual (longpress) menu is
11148     * disabled.
11149     *
11150     * @param obj The entry object
11151     * @return If true, the menu is disabled
11152     */
11153    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11154    /**
11155     * This appends a custom item provider to the list for that entry
11156     *
11157     * This appends the given callback. The list is walked from beginning to end
11158     * with each function called given the item href string in the text. If the
11159     * function returns an object handle other than NULL (it should create an
11160     * object to do this), then this object is used to replace that item. If
11161     * not the next provider is called until one provides an item object, or the
11162     * default provider in entry does.
11163     *
11164     * @param obj The entry object
11165     * @param func The function called to provide the item object
11166     * @param data The data passed to @p func
11167     *
11168     * @see @ref entry-items
11169     */
11170    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);
11171    /**
11172     * This prepends a custom item provider to the list for that entry
11173     *
11174     * This prepends the given callback. See elm_entry_item_provider_append() for
11175     * more information
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    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);
11182    /**
11183     * This removes a custom item provider to the list for that entry
11184     *
11185     * This removes the given callback. See elm_entry_item_provider_append() for
11186     * more information
11187     *
11188     * @param obj The entry object
11189     * @param func The function called to provide the item object
11190     * @param data The data passed to @p func
11191     */
11192    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);
11193    /**
11194     * Append a filter function for text inserted in the entry
11195     *
11196     * Append the given callback to the list. This functions will be called
11197     * whenever any text is inserted into the entry, with the text to be inserted
11198     * as a parameter. The callback function is free to alter the text in any way
11199     * it wants, but it must remember to free the given pointer and update it.
11200     * If the new text is to be discarded, the function can free it and set its
11201     * text parameter to NULL. This will also prevent any following filters from
11202     * being called.
11203     *
11204     * @param obj The entry object
11205     * @param func The function to use as text filter
11206     * @param data User data to pass to @p func
11207     */
11208    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11209    /**
11210     * Prepend a filter function for text insdrted in the entry
11211     *
11212     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11213     * for more information
11214     *
11215     * @param obj The entry object
11216     * @param func The function to use as text filter
11217     * @param data User data to pass to @p func
11218     */
11219    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11220    /**
11221     * Remove a filter from the list
11222     *
11223     * Removes the given callback from the filter list. See
11224     * elm_entry_text_filter_append() for more information.
11225     *
11226     * @param obj The entry object
11227     * @param func The filter function to remove
11228     * @param data The user data passed when adding the function
11229     */
11230    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11231    /**
11232     * This converts a markup (HTML-like) string into UTF-8.
11233     *
11234     * The returned string is a malloc'ed buffer and it should be freed when
11235     * not needed anymore.
11236     *
11237     * @param s The string (in markup) to be converted
11238     * @return The converted string (in UTF-8). It should be freed.
11239     */
11240    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11241    /**
11242     * This converts a UTF-8 string into markup (HTML-like).
11243     *
11244     * The returned string is a malloc'ed buffer and it should be freed when
11245     * not needed anymore.
11246     *
11247     * @param s The string (in UTF-8) to be converted
11248     * @return The converted string (in markup). It should be freed.
11249     */
11250    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11251    /**
11252     * This sets the file (and implicitly loads it) for the text to display and
11253     * then edit. All changes are written back to the file after a short delay if
11254     * the entry object is set to autosave (which is the default).
11255     *
11256     * If the entry had any other file set previously, any changes made to it
11257     * will be saved if the autosave feature is enabled, otherwise, the file
11258     * will be silently discarded and any non-saved changes will be lost.
11259     *
11260     * @param obj The entry object
11261     * @param file The path to the file to load and save
11262     * @param format The file format
11263     */
11264    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11265    /**
11266     * Gets the file being edited by the entry.
11267     *
11268     * This function can be used to retrieve any file set on the entry for
11269     * edition, along with the format used to load and save it.
11270     *
11271     * @param obj The entry object
11272     * @param file The path to the file to load and save
11273     * @param format The file format
11274     */
11275    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11276    /**
11277     * This function writes any changes made to the file set with
11278     * elm_entry_file_set()
11279     *
11280     * @param obj The entry object
11281     */
11282    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11283    /**
11284     * This sets the entry object to 'autosave' the loaded text file or not.
11285     *
11286     * @param obj The entry object
11287     * @param autosave Autosave the loaded file or not
11288     *
11289     * @see elm_entry_file_set()
11290     */
11291    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11292    /**
11293     * This gets the entry object's 'autosave' status.
11294     *
11295     * @param obj The entry object
11296     * @return Autosave the loaded file or not
11297     *
11298     * @see elm_entry_file_set()
11299     */
11300    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11301    /**
11302     * Control pasting of text and images for the widget.
11303     *
11304     * Normally the entry allows both text and images to be pasted.  By setting
11305     * textonly to be true, this prevents images from being pasted.
11306     *
11307     * Note this only changes the behaviour of text.
11308     *
11309     * @param obj The entry object
11310     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11311     * text+image+other.
11312     */
11313    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11314    /**
11315     * Getting elm_entry text paste/drop mode.
11316     *
11317     * In textonly mode, only text may be pasted or dropped into the widget.
11318     *
11319     * @param obj The entry object
11320     * @return If the widget only accepts text from pastes.
11321     */
11322    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11323    /**
11324     * Enable or disable scrolling in entry
11325     *
11326     * Normally the entry is not scrollable unless you enable it with this call.
11327     *
11328     * @param obj The entry object
11329     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11330     */
11331    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11332    /**
11333     * Get the scrollable state of the entry
11334     *
11335     * Normally the entry is not scrollable. This gets the scrollable state
11336     * of the entry. See elm_entry_scrollable_set() for more information.
11337     *
11338     * @param obj The entry object
11339     * @return The scrollable state
11340     */
11341    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11342    /**
11343     * This sets a widget to be displayed to the left of a scrolled entry.
11344     *
11345     * @param obj The scrolled entry object
11346     * @param icon The widget to display on the left side of the scrolled
11347     * entry.
11348     *
11349     * @note A previously set widget will be destroyed.
11350     * @note If the object being set does not have minimum size hints set,
11351     * it won't get properly displayed.
11352     *
11353     * @see elm_entry_end_set()
11354     */
11355    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11356    /**
11357     * Gets the leftmost widget of the scrolled entry. This object is
11358     * owned by the scrolled entry and should not be modified.
11359     *
11360     * @param obj The scrolled entry object
11361     * @return the left widget inside the scroller
11362     */
11363    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11364    /**
11365     * Unset the leftmost widget of the scrolled entry, unparenting and
11366     * returning it.
11367     *
11368     * @param obj The scrolled entry object
11369     * @return the previously set icon sub-object of this entry, on
11370     * success.
11371     *
11372     * @see elm_entry_icon_set()
11373     */
11374    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11375    /**
11376     * Sets the visibility of the left-side widget of the scrolled entry,
11377     * set by elm_entry_icon_set().
11378     *
11379     * @param obj The scrolled entry object
11380     * @param setting EINA_TRUE if the object should be displayed,
11381     * EINA_FALSE if not.
11382     */
11383    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11384    /**
11385     * This sets a widget to be displayed to the end of a scrolled entry.
11386     *
11387     * @param obj The scrolled entry object
11388     * @param end The widget to display on the right side of the scrolled
11389     * entry.
11390     *
11391     * @note A previously set widget will be destroyed.
11392     * @note If the object being set does not have minimum size hints set,
11393     * it won't get properly displayed.
11394     *
11395     * @see elm_entry_icon_set
11396     */
11397    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11398    /**
11399     * Gets the endmost widget of the scrolled entry. This object is owned
11400     * by the scrolled entry and should not be modified.
11401     *
11402     * @param obj The scrolled entry object
11403     * @return the right widget inside the scroller
11404     */
11405    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11406    /**
11407     * Unset the endmost widget of the scrolled entry, unparenting and
11408     * returning it.
11409     *
11410     * @param obj The scrolled entry object
11411     * @return the previously set icon sub-object of this entry, on
11412     * success.
11413     *
11414     * @see elm_entry_icon_set()
11415     */
11416    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11417    /**
11418     * Sets the visibility of the end widget of the scrolled entry, set by
11419     * elm_entry_end_set().
11420     *
11421     * @param obj The scrolled entry object
11422     * @param setting EINA_TRUE if the object should be displayed,
11423     * EINA_FALSE if not.
11424     */
11425    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11426    /**
11427     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11428     * them).
11429     *
11430     * Setting an entry to single-line mode with elm_entry_single_line_set()
11431     * will automatically disable the display of scrollbars when the entry
11432     * moves inside its scroller.
11433     *
11434     * @param obj The scrolled entry object
11435     * @param h The horizontal scrollbar policy to apply
11436     * @param v The vertical scrollbar policy to apply
11437     */
11438    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11439    /**
11440     * This enables/disables bouncing within the entry.
11441     *
11442     * This function sets whether the entry will bounce when scrolling reaches
11443     * the end of the contained entry.
11444     *
11445     * @param obj The scrolled entry object
11446     * @param h The horizontal bounce state
11447     * @param v The vertical bounce state
11448     */
11449    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11450    /**
11451     * Get the bounce mode
11452     *
11453     * @param obj The Entry object
11454     * @param h_bounce Allow bounce horizontally
11455     * @param v_bounce Allow bounce vertically
11456     */
11457    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11458
11459    /* pre-made filters for entries */
11460    /**
11461     * @typedef Elm_Entry_Filter_Limit_Size
11462     *
11463     * Data for the elm_entry_filter_limit_size() entry filter.
11464     */
11465    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11466    /**
11467     * @struct _Elm_Entry_Filter_Limit_Size
11468     *
11469     * Data for the elm_entry_filter_limit_size() entry filter.
11470     */
11471    struct _Elm_Entry_Filter_Limit_Size
11472      {
11473         int max_char_count; /**< The maximum number of characters allowed. */
11474         int max_byte_count; /**< The maximum number of bytes allowed*/
11475      };
11476    /**
11477     * Filter inserted text based on user defined character and byte limits
11478     *
11479     * Add this filter to an entry to limit the characters that it will accept
11480     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11481     * The funtion works on the UTF-8 representation of the string, converting
11482     * it from the set markup, thus not accounting for any format in it.
11483     *
11484     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11485     * it as data when setting the filter. In it, it's possible to set limits
11486     * by character count or bytes (any of them is disabled if 0), and both can
11487     * be set at the same time. In that case, it first checks for characters,
11488     * then bytes.
11489     *
11490     * The function will cut the inserted text in order to allow only the first
11491     * number of characters that are still allowed. The cut is made in
11492     * characters, even when limiting by bytes, in order to always contain
11493     * valid ones and avoid half unicode characters making it in.
11494     *
11495     * This filter, like any others, does not apply when setting the entry text
11496     * directly with elm_object_text_set() (or the deprecated
11497     * elm_entry_entry_set()).
11498     */
11499    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11500    /**
11501     * @typedef Elm_Entry_Filter_Accept_Set
11502     *
11503     * Data for the elm_entry_filter_accept_set() entry filter.
11504     */
11505    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11506    /**
11507     * @struct _Elm_Entry_Filter_Accept_Set
11508     *
11509     * Data for the elm_entry_filter_accept_set() entry filter.
11510     */
11511    struct _Elm_Entry_Filter_Accept_Set
11512      {
11513         const char *accepted; /**< Set of characters accepted in the entry. */
11514         const char *rejected; /**< Set of characters rejected from the entry. */
11515      };
11516    /**
11517     * Filter inserted text based on accepted or rejected sets of characters
11518     *
11519     * Add this filter to an entry to restrict the set of accepted characters
11520     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11521     * This structure contains both accepted and rejected sets, but they are
11522     * mutually exclusive.
11523     *
11524     * The @c accepted set takes preference, so if it is set, the filter will
11525     * only work based on the accepted characters, ignoring anything in the
11526     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11527     *
11528     * In both cases, the function filters by matching utf8 characters to the
11529     * raw markup text, so it can be used to remove formatting tags.
11530     *
11531     * This filter, like any others, does not apply when setting the entry text
11532     * directly with elm_object_text_set() (or the deprecated
11533     * elm_entry_entry_set()).
11534     */
11535    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11536    /**
11537     * Set the input panel layout of the entry
11538     *
11539     * @param obj The entry object
11540     * @param layout layout type
11541     */
11542    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11543    /**
11544     * Get the input panel layout of the entry
11545     *
11546     * @param obj The entry object
11547     * @return layout type
11548     *
11549     * @see elm_entry_input_panel_layout_set
11550     */
11551    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11552    /**
11553     * @}
11554     */
11555
11556    /* composite widgets - these basically put together basic widgets above
11557     * in convenient packages that do more than basic stuff */
11558
11559    /* anchorview */
11560    /**
11561     * @defgroup Anchorview Anchorview
11562     *
11563     * @image html img/widget/anchorview/preview-00.png
11564     * @image latex img/widget/anchorview/preview-00.eps
11565     *
11566     * Anchorview is for displaying text that contains markup with anchors
11567     * like <c>\<a href=1234\>something\</\></c> in it.
11568     *
11569     * Besides being styled differently, the anchorview widget provides the
11570     * necessary functionality so that clicking on these anchors brings up a
11571     * popup with user defined content such as "call", "add to contacts" or
11572     * "open web page". This popup is provided using the @ref Hover widget.
11573     *
11574     * This widget is very similar to @ref Anchorblock, so refer to that
11575     * widget for an example. The only difference Anchorview has is that the
11576     * widget is already provided with scrolling functionality, so if the
11577     * text set to it is too large to fit in the given space, it will scroll,
11578     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11579     * text can be displayed.
11580     *
11581     * This widget emits the following signals:
11582     * @li "anchor,clicked": will be called when an anchor is clicked. The
11583     * @p event_info parameter on the callback will be a pointer of type
11584     * ::Elm_Entry_Anchorview_Info.
11585     *
11586     * See @ref Anchorblock for an example on how to use both of them.
11587     *
11588     * @see Anchorblock
11589     * @see Entry
11590     * @see Hover
11591     *
11592     * @{
11593     */
11594    /**
11595     * @typedef Elm_Entry_Anchorview_Info
11596     *
11597     * The info sent in the callback for "anchor,clicked" signals emitted by
11598     * the Anchorview widget.
11599     */
11600    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11601    /**
11602     * @struct _Elm_Entry_Anchorview_Info
11603     *
11604     * The info sent in the callback for "anchor,clicked" signals emitted by
11605     * the Anchorview widget.
11606     */
11607    struct _Elm_Entry_Anchorview_Info
11608      {
11609         const char     *name; /**< Name of the anchor, as indicated in its href
11610                                    attribute */
11611         int             button; /**< The mouse button used to click on it */
11612         Evas_Object    *hover; /**< The hover object to use for the popup */
11613         struct {
11614              Evas_Coord    x, y, w, h;
11615         } anchor, /**< Geometry selection of text used as anchor */
11616           hover_parent; /**< Geometry of the object used as parent by the
11617                              hover */
11618         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11619                                              for content on the left side of
11620                                              the hover. Before calling the
11621                                              callback, the widget will make the
11622                                              necessary calculations to check
11623                                              which sides are fit to be set with
11624                                              content, based on the position the
11625                                              hover is activated and its distance
11626                                              to the edges of its parent object
11627                                              */
11628         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11629                                               the right side of the hover.
11630                                               See @ref hover_left */
11631         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11632                                             of the hover. See @ref hover_left */
11633         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11634                                                below the hover. See @ref
11635                                                hover_left */
11636      };
11637    /**
11638     * Add a new Anchorview object
11639     *
11640     * @param parent The parent object
11641     * @return The new object or NULL if it cannot be created
11642     */
11643    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11644    /**
11645     * Set the text to show in the anchorview
11646     *
11647     * Sets the text of the anchorview to @p text. This text can include markup
11648     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11649     * text that will be specially styled and react to click events, ended with
11650     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11651     * "anchor,clicked" signal that you can attach a callback to with
11652     * evas_object_smart_callback_add(). The name of the anchor given in the
11653     * event info struct will be the one set in the href attribute, in this
11654     * case, anchorname.
11655     *
11656     * Other markup can be used to style the text in different ways, but it's
11657     * up to the style defined in the theme which tags do what.
11658     * @deprecated use elm_object_text_set() instead.
11659     */
11660    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11661    /**
11662     * Get the markup text set for the anchorview
11663     *
11664     * Retrieves the text set on the anchorview, with markup tags included.
11665     *
11666     * @param obj The anchorview object
11667     * @return The markup text set or @c NULL if nothing was set or an error
11668     * occurred
11669     * @deprecated use elm_object_text_set() instead.
11670     */
11671    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11672    /**
11673     * Set the parent of the hover popup
11674     *
11675     * Sets the parent object to use by the hover created by the anchorview
11676     * when an anchor is clicked. See @ref Hover for more details on this.
11677     * If no parent is set, the same anchorview object will be used.
11678     *
11679     * @param obj The anchorview object
11680     * @param parent The object to use as parent for the hover
11681     */
11682    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11683    /**
11684     * Get the parent of the hover popup
11685     *
11686     * Get the object used as parent for the hover created by the anchorview
11687     * widget. See @ref Hover for more details on this.
11688     *
11689     * @param obj The anchorview object
11690     * @return The object used as parent for the hover, NULL if none is set.
11691     */
11692    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11693    /**
11694     * Set the style that the hover should use
11695     *
11696     * When creating the popup hover, anchorview will request that it's
11697     * themed according to @p style.
11698     *
11699     * @param obj The anchorview object
11700     * @param style The style to use for the underlying hover
11701     *
11702     * @see elm_object_style_set()
11703     */
11704    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11705    /**
11706     * Get the style that the hover should use
11707     *
11708     * Get the style the hover created by anchorview will use.
11709     *
11710     * @param obj The anchorview object
11711     * @return The style to use by the hover. NULL means the default is used.
11712     *
11713     * @see elm_object_style_set()
11714     */
11715    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11716    /**
11717     * Ends the hover popup in the anchorview
11718     *
11719     * When an anchor is clicked, the anchorview widget will create a hover
11720     * object to use as a popup with user provided content. This function
11721     * terminates this popup, returning the anchorview to its normal state.
11722     *
11723     * @param obj The anchorview object
11724     */
11725    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11726    /**
11727     * Set bouncing behaviour when the scrolled content reaches an edge
11728     *
11729     * Tell the internal scroller object whether it should bounce or not
11730     * when it reaches the respective edges for each axis.
11731     *
11732     * @param obj The anchorview object
11733     * @param h_bounce Whether to bounce or not in the horizontal axis
11734     * @param v_bounce Whether to bounce or not in the vertical axis
11735     *
11736     * @see elm_scroller_bounce_set()
11737     */
11738    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11739    /**
11740     * Get the set bouncing behaviour of the internal scroller
11741     *
11742     * Get whether the internal scroller should bounce when the edge of each
11743     * axis is reached scrolling.
11744     *
11745     * @param obj The anchorview object
11746     * @param h_bounce Pointer where to store the bounce state of the horizontal
11747     *                 axis
11748     * @param v_bounce Pointer where to store the bounce state of the vertical
11749     *                 axis
11750     *
11751     * @see elm_scroller_bounce_get()
11752     */
11753    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11754    /**
11755     * Appends a custom item provider to the given anchorview
11756     *
11757     * Appends the given function to the list of items providers. This list is
11758     * called, one function at a time, with the given @p data pointer, the
11759     * anchorview object and, in the @p item parameter, the item name as
11760     * referenced in its href string. Following functions in the list will be
11761     * called in order until one of them returns something different to NULL,
11762     * which should be an Evas_Object which will be used in place of the item
11763     * element.
11764     *
11765     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11766     * href=item/name\>\</item\>
11767     *
11768     * @param obj The anchorview object
11769     * @param func The function to add to the list of providers
11770     * @param data User data that will be passed to the callback function
11771     *
11772     * @see elm_entry_item_provider_append()
11773     */
11774    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);
11775    /**
11776     * Prepend a custom item provider to the given anchorview
11777     *
11778     * Like elm_anchorview_item_provider_append(), but it adds the function
11779     * @p func to the beginning of the list, instead of the end.
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    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);
11786    /**
11787     * Remove a custom item provider from the list of the given anchorview
11788     *
11789     * Removes the function and data pairing that matches @p func and @p data.
11790     * That is, unless the same function and same user data are given, the
11791     * function will not be removed from the list. This allows us to add the
11792     * same callback several times, with different @p data pointers and be
11793     * able to remove them later without conflicts.
11794     *
11795     * @param obj The anchorview object
11796     * @param func The function to remove from the list
11797     * @param data The data matching the function to remove from the list
11798     */
11799    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);
11800    /**
11801     * @}
11802     */
11803
11804    /* anchorblock */
11805    /**
11806     * @defgroup Anchorblock Anchorblock
11807     *
11808     * @image html img/widget/anchorblock/preview-00.png
11809     * @image latex img/widget/anchorblock/preview-00.eps
11810     *
11811     * Anchorblock is for displaying text that contains markup with anchors
11812     * like <c>\<a href=1234\>something\</\></c> in it.
11813     *
11814     * Besides being styled differently, the anchorblock widget provides the
11815     * necessary functionality so that clicking on these anchors brings up a
11816     * popup with user defined content such as "call", "add to contacts" or
11817     * "open web page". This popup is provided using the @ref Hover widget.
11818     *
11819     * This widget emits the following signals:
11820     * @li "anchor,clicked": will be called when an anchor is clicked. The
11821     * @p event_info parameter on the callback will be a pointer of type
11822     * ::Elm_Entry_Anchorblock_Info.
11823     *
11824     * @see Anchorview
11825     * @see Entry
11826     * @see Hover
11827     *
11828     * Since examples are usually better than plain words, we might as well
11829     * try @ref tutorial_anchorblock_example "one".
11830     */
11831    /**
11832     * @addtogroup Anchorblock
11833     * @{
11834     */
11835    /**
11836     * @typedef Elm_Entry_Anchorblock_Info
11837     *
11838     * The info sent in the callback for "anchor,clicked" signals emitted by
11839     * the Anchorblock widget.
11840     */
11841    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11842    /**
11843     * @struct _Elm_Entry_Anchorblock_Info
11844     *
11845     * The info sent in the callback for "anchor,clicked" signals emitted by
11846     * the Anchorblock widget.
11847     */
11848    struct _Elm_Entry_Anchorblock_Info
11849      {
11850         const char     *name; /**< Name of the anchor, as indicated in its href
11851                                    attribute */
11852         int             button; /**< The mouse button used to click on it */
11853         Evas_Object    *hover; /**< The hover object to use for the popup */
11854         struct {
11855              Evas_Coord    x, y, w, h;
11856         } anchor, /**< Geometry selection of text used as anchor */
11857           hover_parent; /**< Geometry of the object used as parent by the
11858                              hover */
11859         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11860                                              for content on the left side of
11861                                              the hover. Before calling the
11862                                              callback, the widget will make the
11863                                              necessary calculations to check
11864                                              which sides are fit to be set with
11865                                              content, based on the position the
11866                                              hover is activated and its distance
11867                                              to the edges of its parent object
11868                                              */
11869         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11870                                               the right side of the hover.
11871                                               See @ref hover_left */
11872         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11873                                             of the hover. See @ref hover_left */
11874         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11875                                                below the hover. See @ref
11876                                                hover_left */
11877      };
11878    /**
11879     * Add a new Anchorblock object
11880     *
11881     * @param parent The parent object
11882     * @return The new object or NULL if it cannot be created
11883     */
11884    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11885    /**
11886     * Set the text to show in the anchorblock
11887     *
11888     * Sets the text of the anchorblock to @p text. This text can include markup
11889     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11890     * of text that will be specially styled and react to click events, ended
11891     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11892     * "anchor,clicked" signal that you can attach a callback to with
11893     * evas_object_smart_callback_add(). The name of the anchor given in the
11894     * event info struct will be the one set in the href attribute, in this
11895     * case, anchorname.
11896     *
11897     * Other markup can be used to style the text in different ways, but it's
11898     * up to the style defined in the theme which tags do what.
11899     * @deprecated use elm_object_text_set() instead.
11900     */
11901    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11902    /**
11903     * Get the markup text set for the anchorblock
11904     *
11905     * Retrieves the text set on the anchorblock, with markup tags included.
11906     *
11907     * @param obj The anchorblock object
11908     * @return The markup text set or @c NULL if nothing was set or an error
11909     * occurred
11910     * @deprecated use elm_object_text_set() instead.
11911     */
11912    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11913    /**
11914     * Set the parent of the hover popup
11915     *
11916     * Sets the parent object to use by the hover created by the anchorblock
11917     * when an anchor is clicked. See @ref Hover for more details on this.
11918     *
11919     * @param obj The anchorblock object
11920     * @param parent The object to use as parent for the hover
11921     */
11922    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11923    /**
11924     * Get the parent of the hover popup
11925     *
11926     * Get the object used as parent for the hover created by the anchorblock
11927     * widget. See @ref Hover for more details on this.
11928     * If no parent is set, the same anchorblock object will be used.
11929     *
11930     * @param obj The anchorblock object
11931     * @return The object used as parent for the hover, NULL if none is set.
11932     */
11933    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11934    /**
11935     * Set the style that the hover should use
11936     *
11937     * When creating the popup hover, anchorblock will request that it's
11938     * themed according to @p style.
11939     *
11940     * @param obj The anchorblock object
11941     * @param style The style to use for the underlying hover
11942     *
11943     * @see elm_object_style_set()
11944     */
11945    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11946    /**
11947     * Get the style that the hover should use
11948     *
11949     * Get the style the hover created by anchorblock will use.
11950     *
11951     * @param obj The anchorblock object
11952     * @return The style to use by the hover. NULL means the default is used.
11953     *
11954     * @see elm_object_style_set()
11955     */
11956    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11957    /**
11958     * Ends the hover popup in the anchorblock
11959     *
11960     * When an anchor is clicked, the anchorblock widget will create a hover
11961     * object to use as a popup with user provided content. This function
11962     * terminates this popup, returning the anchorblock to its normal state.
11963     *
11964     * @param obj The anchorblock object
11965     */
11966    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11967    /**
11968     * Appends a custom item provider to the given anchorblock
11969     *
11970     * Appends the given function to the list of items providers. This list is
11971     * called, one function at a time, with the given @p data pointer, the
11972     * anchorblock object and, in the @p item parameter, the item name as
11973     * referenced in its href string. Following functions in the list will be
11974     * called in order until one of them returns something different to NULL,
11975     * which should be an Evas_Object which will be used in place of the item
11976     * element.
11977     *
11978     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11979     * href=item/name\>\</item\>
11980     *
11981     * @param obj The anchorblock object
11982     * @param func The function to add to the list of providers
11983     * @param data User data that will be passed to the callback function
11984     *
11985     * @see elm_entry_item_provider_append()
11986     */
11987    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);
11988    /**
11989     * Prepend a custom item provider to the given anchorblock
11990     *
11991     * Like elm_anchorblock_item_provider_append(), but it adds the function
11992     * @p func to the beginning of the list, instead of the end.
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    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);
11999    /**
12000     * Remove a custom item provider from the list of the given anchorblock
12001     *
12002     * Removes the function and data pairing that matches @p func and @p data.
12003     * That is, unless the same function and same user data are given, the
12004     * function will not be removed from the list. This allows us to add the
12005     * same callback several times, with different @p data pointers and be
12006     * able to remove them later without conflicts.
12007     *
12008     * @param obj The anchorblock object
12009     * @param func The function to remove from the list
12010     * @param data The data matching the function to remove from the list
12011     */
12012    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);
12013    /**
12014     * @}
12015     */
12016
12017    /**
12018     * @defgroup Bubble Bubble
12019     *
12020     * @image html img/widget/bubble/preview-00.png
12021     * @image latex img/widget/bubble/preview-00.eps
12022     * @image html img/widget/bubble/preview-01.png
12023     * @image latex img/widget/bubble/preview-01.eps
12024     * @image html img/widget/bubble/preview-02.png
12025     * @image latex img/widget/bubble/preview-02.eps
12026     *
12027     * @brief The Bubble is a widget to show text similarly to how speech is
12028     * represented in comics.
12029     *
12030     * The bubble widget contains 5 important visual elements:
12031     * @li The frame is a rectangle with rounded rectangles and an "arrow".
12032     * @li The @p icon is an image to which the frame's arrow points to.
12033     * @li The @p label is a text which appears to the right of the icon if the
12034     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12035     * otherwise.
12036     * @li The @p info is a text which appears to the right of the label. Info's
12037     * font is of a ligther color than label.
12038     * @li The @p content is an evas object that is shown inside the frame.
12039     *
12040     * The position of the arrow, icon, label and info depends on which corner is
12041     * selected. The four available corners are:
12042     * @li "top_left" - Default
12043     * @li "top_right"
12044     * @li "bottom_left"
12045     * @li "bottom_right"
12046     *
12047     * Signals that you can add callbacks for are:
12048     * @li "clicked" - This is called when a user has clicked the bubble.
12049     *
12050     * For an example of using a buble see @ref bubble_01_example_page "this".
12051     *
12052     * @{
12053     */
12054    /**
12055     * Add a new bubble to the parent
12056     *
12057     * @param parent The parent object
12058     * @return The new object or NULL if it cannot be created
12059     *
12060     * This function adds a text bubble to the given parent evas object.
12061     */
12062    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12063    /**
12064     * Set the label of the bubble
12065     *
12066     * @param obj The bubble object
12067     * @param label The string to set in the label
12068     *
12069     * This function sets the title of the bubble. Where this appears depends on
12070     * the selected corner.
12071     * @deprecated use elm_object_text_set() instead.
12072     */
12073    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12074    /**
12075     * Get the label of the bubble
12076     *
12077     * @param obj The bubble object
12078     * @return The string of set in the label
12079     *
12080     * This function gets the title of the bubble.
12081     * @deprecated use elm_object_text_get() instead.
12082     */
12083    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12084    /**
12085     * Set the info of the bubble
12086     *
12087     * @param obj The bubble object
12088     * @param info The given info about the bubble
12089     *
12090     * This function sets the info of the bubble. Where this appears depends on
12091     * the selected corner.
12092     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12093     */
12094    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12095    /**
12096     * Get the info of the bubble
12097     *
12098     * @param obj The bubble object
12099     *
12100     * @return The "info" string of the bubble
12101     *
12102     * This function gets the info text.
12103     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12104     */
12105    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12106    /**
12107     * Set the content to be shown in the bubble
12108     *
12109     * Once the content object is set, a previously set one will be deleted.
12110     * If you want to keep the old content object, use the
12111     * elm_bubble_content_unset() function.
12112     *
12113     * @param obj The bubble object
12114     * @param content The given content of the bubble
12115     *
12116     * This function sets the content shown on the middle of the bubble.
12117     */
12118    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12119    /**
12120     * Get the content shown in the bubble
12121     *
12122     * Return the content object which is set for this widget.
12123     *
12124     * @param obj The bubble object
12125     * @return The content that is being used
12126     */
12127    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12128    /**
12129     * Unset the content shown in the bubble
12130     *
12131     * Unparent and return the content object which was set for this widget.
12132     *
12133     * @param obj The bubble object
12134     * @return The content that was being used
12135     */
12136    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12137    /**
12138     * Set the icon of the bubble
12139     *
12140     * Once the icon object is set, a previously set one will be deleted.
12141     * If you want to keep the old content object, use the
12142     * elm_icon_content_unset() function.
12143     *
12144     * @param obj The bubble object
12145     * @param icon The given icon for the bubble
12146     */
12147    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12148    /**
12149     * Get the icon of the bubble
12150     *
12151     * @param obj The bubble object
12152     * @return The icon for the bubble
12153     *
12154     * This function gets the icon shown on the top left of bubble.
12155     */
12156    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12157    /**
12158     * Unset the icon of the bubble
12159     *
12160     * Unparent and return the icon object which was set for this widget.
12161     *
12162     * @param obj The bubble object
12163     * @return The icon that was being used
12164     */
12165    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12166    /**
12167     * Set the corner of the bubble
12168     *
12169     * @param obj The bubble object.
12170     * @param corner The given corner for the bubble.
12171     *
12172     * This function sets the corner of the bubble. The corner will be used to
12173     * determine where the arrow in the frame points to and where label, icon and
12174     * info arre shown.
12175     *
12176     * Possible values for corner are:
12177     * @li "top_left" - Default
12178     * @li "top_right"
12179     * @li "bottom_left"
12180     * @li "bottom_right"
12181     */
12182    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12183    /**
12184     * Get the corner of the bubble
12185     *
12186     * @param obj The bubble object.
12187     * @return The given corner for the bubble.
12188     *
12189     * This function gets the selected corner of the bubble.
12190     */
12191    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12192    /**
12193     * @}
12194     */
12195
12196    /**
12197     * @defgroup Photo Photo
12198     *
12199     * For displaying the photo of a person (contact). Simple yet
12200     * with a very specific purpose.
12201     *
12202     * Signals that you can add callbacks for are:
12203     *
12204     * "clicked" - This is called when a user has clicked the photo
12205     * "drag,start" - Someone started dragging the image out of the object
12206     * "drag,end" - Dragged item was dropped (somewhere)
12207     *
12208     * @{
12209     */
12210
12211    /**
12212     * Add a new photo to the parent
12213     *
12214     * @param parent The parent object
12215     * @return The new object or NULL if it cannot be created
12216     *
12217     * @ingroup Photo
12218     */
12219    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12220
12221    /**
12222     * Set the file that will be used as photo
12223     *
12224     * @param obj The photo object
12225     * @param file The path to file that will be used as photo
12226     *
12227     * @return (1 = success, 0 = error)
12228     *
12229     * @ingroup Photo
12230     */
12231    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12232
12233     /**
12234     * Set the file that will be used as thumbnail in the photo.
12235     *
12236     * @param obj The photo object.
12237     * @param file The path to file that will be used as thumb.
12238     * @param group The key used in case of an EET file.
12239     *
12240     * @ingroup Photo
12241     */
12242    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12243
12244    /**
12245     * Set the size that will be used on the photo
12246     *
12247     * @param obj The photo object
12248     * @param size The size that the photo will be
12249     *
12250     * @ingroup Photo
12251     */
12252    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12253
12254    /**
12255     * Set if the photo should be completely visible or not.
12256     *
12257     * @param obj The photo object
12258     * @param fill if true the photo will be completely visible
12259     *
12260     * @ingroup Photo
12261     */
12262    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12263
12264    /**
12265     * Set editability of the photo.
12266     *
12267     * An editable photo can be dragged to or from, and can be cut or
12268     * pasted too.  Note that pasting an image or dropping an item on
12269     * the image will delete the existing content.
12270     *
12271     * @param obj The photo object.
12272     * @param set To set of clear editablity.
12273     */
12274    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12275
12276    /**
12277     * @}
12278     */
12279
12280    /* gesture layer */
12281    /**
12282     * @defgroup Elm_Gesture_Layer Gesture Layer
12283     * Gesture Layer Usage:
12284     *
12285     * Use Gesture Layer to detect gestures.
12286     * The advantage is that you don't have to implement
12287     * gesture detection, just set callbacks of gesture state.
12288     * By using gesture layer we make standard interface.
12289     *
12290     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12291     * with a parent object parameter.
12292     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12293     * call. Usually with same object as target (2nd parameter).
12294     *
12295     * Now you need to tell gesture layer what gestures you follow.
12296     * This is done with @ref elm_gesture_layer_cb_set call.
12297     * By setting the callback you actually saying to gesture layer:
12298     * I would like to know when the gesture @ref Elm_Gesture_Types
12299     * switches to state @ref Elm_Gesture_State.
12300     *
12301     * Next, you need to implement the actual action that follows the input
12302     * in your callback.
12303     *
12304     * Note that if you like to stop being reported about a gesture, just set
12305     * all callbacks referring this gesture to NULL.
12306     * (again with @ref elm_gesture_layer_cb_set)
12307     *
12308     * The information reported by gesture layer to your callback is depending
12309     * on @ref Elm_Gesture_Types:
12310     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12311     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12312     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12313     *
12314     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12315     * @ref ELM_GESTURE_MOMENTUM.
12316     *
12317     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12318     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12319     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12320     * Note that we consider a flick as a line-gesture that should be completed
12321     * in flick-time-limit as defined in @ref Config.
12322     *
12323     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12324     *
12325     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12326     *
12327     *
12328     * Gesture Layer Tweaks:
12329     *
12330     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12331     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12332     *
12333     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12334     * so gesture starts when user touches (a *DOWN event) touch-surface
12335     * and ends when no fingers touches surface (a *UP event).
12336     */
12337
12338    /**
12339     * @enum _Elm_Gesture_Types
12340     * Enum of supported gesture types.
12341     * @ingroup Elm_Gesture_Layer
12342     */
12343    enum _Elm_Gesture_Types
12344      {
12345         ELM_GESTURE_FIRST = 0,
12346
12347         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12348         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12349         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12350         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12351
12352         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12353
12354         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12355         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12356
12357         ELM_GESTURE_ZOOM, /**< Zoom */
12358         ELM_GESTURE_ROTATE, /**< Rotate */
12359
12360         ELM_GESTURE_LAST
12361      };
12362
12363    /**
12364     * @typedef Elm_Gesture_Types
12365     * gesture types enum
12366     * @ingroup Elm_Gesture_Layer
12367     */
12368    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12369
12370    /**
12371     * @enum _Elm_Gesture_State
12372     * Enum of gesture states.
12373     * @ingroup Elm_Gesture_Layer
12374     */
12375    enum _Elm_Gesture_State
12376      {
12377         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12378         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12379         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12380         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12381         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12382      };
12383
12384    /**
12385     * @typedef Elm_Gesture_State
12386     * gesture states enum
12387     * @ingroup Elm_Gesture_Layer
12388     */
12389    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12390
12391    /**
12392     * @struct _Elm_Gesture_Taps_Info
12393     * Struct holds taps info for user
12394     * @ingroup Elm_Gesture_Layer
12395     */
12396    struct _Elm_Gesture_Taps_Info
12397      {
12398         Evas_Coord x, y;         /**< Holds center point between fingers */
12399         unsigned int n;          /**< Number of fingers tapped           */
12400         unsigned int timestamp;  /**< event timestamp       */
12401      };
12402
12403    /**
12404     * @typedef Elm_Gesture_Taps_Info
12405     * holds taps info for user
12406     * @ingroup Elm_Gesture_Layer
12407     */
12408    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12409
12410    /**
12411     * @struct _Elm_Gesture_Momentum_Info
12412     * Struct holds momentum info for user
12413     * x1 and y1 are not necessarily in sync
12414     * x1 holds x value of x direction starting point
12415     * and same holds for y1.
12416     * This is noticeable when doing V-shape movement
12417     * @ingroup Elm_Gesture_Layer
12418     */
12419    struct _Elm_Gesture_Momentum_Info
12420      {  /* Report line ends, timestamps, and momentum computed        */
12421         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12422         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12423         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12424         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12425
12426         unsigned int tx; /**< Timestamp of start of final x-swipe */
12427         unsigned int ty; /**< Timestamp of start of final y-swipe */
12428
12429         Evas_Coord mx; /**< Momentum on X */
12430         Evas_Coord my; /**< Momentum on Y */
12431      };
12432
12433    /**
12434     * @typedef Elm_Gesture_Momentum_Info
12435     * holds momentum info for user
12436     * @ingroup Elm_Gesture_Layer
12437     */
12438     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12439
12440    /**
12441     * @struct _Elm_Gesture_Line_Info
12442     * Struct holds line info for user
12443     * @ingroup Elm_Gesture_Layer
12444     */
12445    struct _Elm_Gesture_Line_Info
12446      {  /* Report line ends, timestamps, and momentum computed      */
12447         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12448         unsigned int n;            /**< Number of fingers (lines)   */
12449         /* FIXME should be radians, bot degrees */
12450         double angle;              /**< Angle (direction) of lines  */
12451      };
12452
12453    /**
12454     * @typedef Elm_Gesture_Line_Info
12455     * Holds line info for user
12456     * @ingroup Elm_Gesture_Layer
12457     */
12458     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12459
12460    /**
12461     * @struct _Elm_Gesture_Zoom_Info
12462     * Struct holds zoom info for user
12463     * @ingroup Elm_Gesture_Layer
12464     */
12465    struct _Elm_Gesture_Zoom_Info
12466      {
12467         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12468         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12469         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12470         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12471      };
12472
12473    /**
12474     * @typedef Elm_Gesture_Zoom_Info
12475     * Holds zoom info for user
12476     * @ingroup Elm_Gesture_Layer
12477     */
12478    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12479
12480    /**
12481     * @struct _Elm_Gesture_Rotate_Info
12482     * Struct holds rotation info for user
12483     * @ingroup Elm_Gesture_Layer
12484     */
12485    struct _Elm_Gesture_Rotate_Info
12486      {
12487         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12488         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12489         double base_angle; /**< Holds start-angle */
12490         double angle;      /**< Rotation value: 0.0 means no rotation         */
12491         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12492      };
12493
12494    /**
12495     * @typedef Elm_Gesture_Rotate_Info
12496     * Holds rotation info for user
12497     * @ingroup Elm_Gesture_Layer
12498     */
12499    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12500
12501    /**
12502     * @typedef Elm_Gesture_Event_Cb
12503     * User callback used to stream gesture info from gesture layer
12504     * @param data user data
12505     * @param event_info gesture report info
12506     * Returns a flag field to be applied on the causing event.
12507     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12508     * upon the event, in an irreversible way.
12509     *
12510     * @ingroup Elm_Gesture_Layer
12511     */
12512    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12513
12514    /**
12515     * Use function to set callbacks to be notified about
12516     * change of state of gesture.
12517     * When a user registers a callback with this function
12518     * this means this gesture has to be tested.
12519     *
12520     * When ALL callbacks for a gesture are set to NULL
12521     * it means user isn't interested in gesture-state
12522     * and it will not be tested.
12523     *
12524     * @param obj Pointer to gesture-layer.
12525     * @param idx The gesture you would like to track its state.
12526     * @param cb callback function pointer.
12527     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12528     * @param data user info to be sent to callback (usually, Smart Data)
12529     *
12530     * @ingroup Elm_Gesture_Layer
12531     */
12532    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);
12533
12534    /**
12535     * Call this function to get repeat-events settings.
12536     *
12537     * @param obj Pointer to gesture-layer.
12538     *
12539     * @return repeat events settings.
12540     * @see elm_gesture_layer_hold_events_set()
12541     * @ingroup Elm_Gesture_Layer
12542     */
12543    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12544
12545    /**
12546     * This function called in order to make gesture-layer repeat events.
12547     * Set this of you like to get the raw events only if gestures were not detected.
12548     * Clear this if you like gesture layer to fwd events as testing gestures.
12549     *
12550     * @param obj Pointer to gesture-layer.
12551     * @param r Repeat: TRUE/FALSE
12552     *
12553     * @ingroup Elm_Gesture_Layer
12554     */
12555    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12556
12557    /**
12558     * This function sets step-value for zoom action.
12559     * Set step to any positive value.
12560     * Cancel step setting by setting to 0.0
12561     *
12562     * @param obj Pointer to gesture-layer.
12563     * @param s new zoom step value.
12564     *
12565     * @ingroup Elm_Gesture_Layer
12566     */
12567    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12568
12569    /**
12570     * This function sets step-value for rotate action.
12571     * Set step to any positive value.
12572     * Cancel step setting by setting to 0.0
12573     *
12574     * @param obj Pointer to gesture-layer.
12575     * @param s new roatate step value.
12576     *
12577     * @ingroup Elm_Gesture_Layer
12578     */
12579    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12580
12581    /**
12582     * This function called to attach gesture-layer to an Evas_Object.
12583     * @param obj Pointer to gesture-layer.
12584     * @param t Pointer to underlying object (AKA Target)
12585     *
12586     * @return TRUE, FALSE on success, failure.
12587     *
12588     * @ingroup Elm_Gesture_Layer
12589     */
12590    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12591
12592    /**
12593     * Call this function to construct a new gesture-layer object.
12594     * This does not activate the gesture layer. You have to
12595     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12596     *
12597     * @param parent the parent object.
12598     *
12599     * @return Pointer to new gesture-layer object.
12600     *
12601     * @ingroup Elm_Gesture_Layer
12602     */
12603    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12604
12605    /**
12606     * @defgroup Thumb Thumb
12607     *
12608     * @image html img/widget/thumb/preview-00.png
12609     * @image latex img/widget/thumb/preview-00.eps
12610     *
12611     * A thumb object is used for displaying the thumbnail of an image or video.
12612     * You must have compiled Elementary with Ethumb_Client support and the DBus
12613     * service must be present and auto-activated in order to have thumbnails to
12614     * be generated.
12615     *
12616     * Once the thumbnail object becomes visible, it will check if there is a
12617     * previously generated thumbnail image for the file set on it. If not, it
12618     * will start generating this thumbnail.
12619     *
12620     * Different config settings will cause different thumbnails to be generated
12621     * even on the same file.
12622     *
12623     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12624     * Ethumb documentation to change this path, and to see other configuration
12625     * options.
12626     *
12627     * Signals that you can add callbacks for are:
12628     *
12629     * - "clicked" - This is called when a user has clicked the thumb without dragging
12630     *             around.
12631     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12632     * - "press" - This is called when a user has pressed down the thumb.
12633     * - "generate,start" - The thumbnail generation started.
12634     * - "generate,stop" - The generation process stopped.
12635     * - "generate,error" - The generation failed.
12636     * - "load,error" - The thumbnail image loading failed.
12637     *
12638     * available styles:
12639     * - default
12640     * - noframe
12641     *
12642     * An example of use of thumbnail:
12643     *
12644     * - @ref thumb_example_01
12645     */
12646
12647    /**
12648     * @addtogroup Thumb
12649     * @{
12650     */
12651
12652    /**
12653     * @enum _Elm_Thumb_Animation_Setting
12654     * @typedef Elm_Thumb_Animation_Setting
12655     *
12656     * Used to set if a video thumbnail is animating or not.
12657     *
12658     * @ingroup Thumb
12659     */
12660    typedef enum _Elm_Thumb_Animation_Setting
12661      {
12662         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12663         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12664         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12665         ELM_THUMB_ANIMATION_LAST
12666      } Elm_Thumb_Animation_Setting;
12667
12668    /**
12669     * Add a new thumb object to the parent.
12670     *
12671     * @param parent The parent object.
12672     * @return The new object or NULL if it cannot be created.
12673     *
12674     * @see elm_thumb_file_set()
12675     * @see elm_thumb_ethumb_client_get()
12676     *
12677     * @ingroup Thumb
12678     */
12679    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12680    /**
12681     * Reload thumbnail if it was generated before.
12682     *
12683     * @param obj The thumb object to reload
12684     *
12685     * This is useful if the ethumb client configuration changed, like its
12686     * size, aspect or any other property one set in the handle returned
12687     * by elm_thumb_ethumb_client_get().
12688     *
12689     * If the options didn't change, the thumbnail won't be generated again, but
12690     * the old one will still be used.
12691     *
12692     * @see elm_thumb_file_set()
12693     *
12694     * @ingroup Thumb
12695     */
12696    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12697    /**
12698     * Set the file that will be used as thumbnail.
12699     *
12700     * @param obj The thumb object.
12701     * @param file The path to file that will be used as thumb.
12702     * @param key The key used in case of an EET file.
12703     *
12704     * The file can be an image or a video (in that case, acceptable extensions are:
12705     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12706     * function elm_thumb_animate().
12707     *
12708     * @see elm_thumb_file_get()
12709     * @see elm_thumb_reload()
12710     * @see elm_thumb_animate()
12711     *
12712     * @ingroup Thumb
12713     */
12714    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12715    /**
12716     * Get the image or video path and key used to generate the thumbnail.
12717     *
12718     * @param obj The thumb object.
12719     * @param file Pointer to filename.
12720     * @param key Pointer to key.
12721     *
12722     * @see elm_thumb_file_set()
12723     * @see elm_thumb_path_get()
12724     *
12725     * @ingroup Thumb
12726     */
12727    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12728    /**
12729     * Get the path and key to the image or video generated by ethumb.
12730     *
12731     * One just need to make sure that the thumbnail was generated before getting
12732     * its path; otherwise, the path will be NULL. One way to do that is by asking
12733     * for the path when/after the "generate,stop" smart callback is called.
12734     *
12735     * @param obj The thumb object.
12736     * @param file Pointer to thumb path.
12737     * @param key Pointer to thumb key.
12738     *
12739     * @see elm_thumb_file_get()
12740     *
12741     * @ingroup Thumb
12742     */
12743    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12744    /**
12745     * Set the animation state for the thumb object. If its content is an animated
12746     * video, you may start/stop the animation or tell it to play continuously and
12747     * looping.
12748     *
12749     * @param obj The thumb object.
12750     * @param setting The animation setting.
12751     *
12752     * @see elm_thumb_file_set()
12753     *
12754     * @ingroup Thumb
12755     */
12756    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12757    /**
12758     * Get the animation state for the thumb object.
12759     *
12760     * @param obj The thumb object.
12761     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12762     * on errors.
12763     *
12764     * @see elm_thumb_animate_set()
12765     *
12766     * @ingroup Thumb
12767     */
12768    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12769    /**
12770     * Get the ethumb_client handle so custom configuration can be made.
12771     *
12772     * @return Ethumb_Client instance or NULL.
12773     *
12774     * This must be called before the objects are created to be sure no object is
12775     * visible and no generation started.
12776     *
12777     * Example of usage:
12778     *
12779     * @code
12780     * #include <Elementary.h>
12781     * #ifndef ELM_LIB_QUICKLAUNCH
12782     * EAPI_MAIN int
12783     * elm_main(int argc, char **argv)
12784     * {
12785     *    Ethumb_Client *client;
12786     *
12787     *    elm_need_ethumb();
12788     *
12789     *    // ... your code
12790     *
12791     *    client = elm_thumb_ethumb_client_get();
12792     *    if (!client)
12793     *      {
12794     *         ERR("could not get ethumb_client");
12795     *         return 1;
12796     *      }
12797     *    ethumb_client_size_set(client, 100, 100);
12798     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12799     *    // ... your code
12800     *
12801     *    // Create elm_thumb objects here
12802     *
12803     *    elm_run();
12804     *    elm_shutdown();
12805     *    return 0;
12806     * }
12807     * #endif
12808     * ELM_MAIN()
12809     * @endcode
12810     *
12811     * @note There's only one client handle for Ethumb, so once a configuration
12812     * change is done to it, any other request for thumbnails (for any thumbnail
12813     * object) will use that configuration. Thus, this configuration is global.
12814     *
12815     * @ingroup Thumb
12816     */
12817    EAPI void                        *elm_thumb_ethumb_client_get(void);
12818    /**
12819     * Get the ethumb_client connection state.
12820     *
12821     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12822     * otherwise.
12823     */
12824    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12825    /**
12826     * Make the thumbnail 'editable'.
12827     *
12828     * @param obj Thumb object.
12829     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12830     *
12831     * This means the thumbnail is a valid drag target for drag and drop, and can be
12832     * cut or pasted too.
12833     *
12834     * @see elm_thumb_editable_get()
12835     *
12836     * @ingroup Thumb
12837     */
12838    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12839    /**
12840     * Make the thumbnail 'editable'.
12841     *
12842     * @param obj Thumb object.
12843     * @return Editability.
12844     *
12845     * This means the thumbnail is a valid drag target for drag and drop, and can be
12846     * cut or pasted too.
12847     *
12848     * @see elm_thumb_editable_set()
12849     *
12850     * @ingroup Thumb
12851     */
12852    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12853
12854    /**
12855     * @}
12856     */
12857
12858    /**
12859     * @defgroup Web Web
12860     *
12861     * @image html img/widget/web/preview-00.png
12862     * @image latex img/widget/web/preview-00.eps
12863     *
12864     * A web object is used for displaying web pages (HTML/CSS/JS)
12865     * using WebKit-EFL. You must have compiled Elementary with
12866     * ewebkit support.
12867     *
12868     * Signals that you can add callbacks for are:
12869     * @li "download,request": A file download has been requested. Event info is
12870     * a pointer to a Elm_Web_Download
12871     * @li "editorclient,contents,changed": Editor client's contents changed
12872     * @li "editorclient,selection,changed": Editor client's selection changed
12873     * @li "frame,created": A new frame was created. Event info is an
12874     * Evas_Object which can be handled with WebKit's ewk_frame API
12875     * @li "icon,received": An icon was received by the main frame
12876     * @li "inputmethod,changed": Input method changed. Event info is an
12877     * Eina_Bool indicating whether it's enabled or not
12878     * @li "js,windowobject,clear": JS window object has been cleared
12879     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12880     * is a char *link[2], where the first string contains the URL the link
12881     * points to, and the second one the title of the link
12882     * @li "link,hover,out": Mouse cursor left the link
12883     * @li "load,document,finished": Loading of a document finished. Event info
12884     * is the frame that finished loading
12885     * @li "load,error": Load failed. Event info is a pointer to
12886     * Elm_Web_Frame_Load_Error
12887     * @li "load,finished": Load finished. Event info is NULL on success, on
12888     * error it's a pointer to Elm_Web_Frame_Load_Error
12889     * @li "load,newwindow,show": A new window was created and is ready to be
12890     * shown
12891     * @li "load,progress": Overall load progress. Event info is a pointer to
12892     * a double containing a value between 0.0 and 1.0
12893     * @li "load,provisional": Started provisional load
12894     * @li "load,started": Loading of a document started
12895     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12896     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12897     * the menubar is visible, or EINA_FALSE in case it's not
12898     * @li "menubar,visible,set": Informs menubar visibility. Event info is
12899     * an Eina_Bool indicating the visibility
12900     * @li "popup,created": A dropdown widget was activated, requesting its
12901     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12902     * @li "popup,willdelete": The web object is ready to destroy the popup
12903     * object created. Event info is a pointer to Elm_Web_Menu
12904     * @li "ready": Page is fully loaded
12905     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12906     * info is a pointer to Eina_Bool where the visibility state should be set
12907     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12908     * is an Eina_Bool with the visibility state set
12909     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12910     * a string with the new text
12911     * @li "statusbar,visible,get": Queries visibility of the status bar.
12912     * Event info is a pointer to Eina_Bool where the visibility state should be
12913     * set.
12914     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12915     * an Eina_Bool with the visibility value
12916     * @li "title,changed": Title of the main frame changed. Event info is a
12917     * string with the new title
12918     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
12919     * is a pointer to Eina_Bool where the visibility state should be set
12920     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
12921     * info is an Eina_Bool with the visibility state
12922     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
12923     * a string with the text to show
12924     * @li "uri,changed": URI of the main frame changed. Event info is a string
12925     * with the new URI
12926     * @li "view,resized": The web object internal's view changed sized
12927     * @li "windows,close,request": A JavaScript request to close the current
12928     * window was requested
12929     * @li "zoom,animated,end": Animated zoom finished
12930     *
12931     * available styles:
12932     * - default
12933     *
12934     * An example of use of web:
12935     *
12936     * - @ref web_example_01 TBD
12937     */
12938
12939    /**
12940     * @addtogroup Web
12941     * @{
12942     */
12943
12944    /**
12945     * Structure used to report load errors.
12946     *
12947     * Load errors are reported as signal by elm_web. All the strings are
12948     * temporary references and should @b not be used after the signal
12949     * callback returns. If it's required, make copies with strdup() or
12950     * eina_stringshare_add() (they are not even guaranteed to be
12951     * stringshared, so must use eina_stringshare_add() and not
12952     * eina_stringshare_ref()).
12953     */
12954    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
12955    /**
12956     * Structure used to report load errors.
12957     *
12958     * Load errors are reported as signal by elm_web. All the strings are
12959     * temporary references and should @b not be used after the signal
12960     * callback returns. If it's required, make copies with strdup() or
12961     * eina_stringshare_add() (they are not even guaranteed to be
12962     * stringshared, so must use eina_stringshare_add() and not
12963     * eina_stringshare_ref()).
12964     */
12965    struct _Elm_Web_Frame_Load_Error
12966      {
12967         int code; /**< Numeric error code */
12968         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
12969         const char *domain; /**< Error domain name */
12970         const char *description; /**< Error description (already localized) */
12971         const char *failing_url; /**< The URL that failed to load */
12972         Evas_Object *frame; /**< Frame object that produced the error */
12973      };
12974
12975    /**
12976     * The possibles types that the items in a menu can be
12977     */
12978    typedef enum _Elm_Web_Menu_Item_Type Elm_Web_Menu_Item_Type;
12979    /**
12980     * The possibles types that the items in a menu can be
12981     */
12982    enum _Elm_Web_Menu_Item_Type
12983      {
12984         ELM_WEB_MENU_SEPARATOR,
12985         ELM_WEB_MENU_GROUP,
12986         ELM_WEB_MENU_OPTION
12987      };
12988
12989    /**
12990     * Structure describing the items in a menu
12991     */
12992    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
12993    /**
12994     * Structure describing the items in a menu
12995     */
12996    struct _Elm_Web_Menu_Item
12997      {
12998         const char *text; /**< The text for the item */
12999         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13000      };
13001
13002    /**
13003     * Structure describing the menu of a popup
13004     *
13005     * This structure will be passed as the @c event_info for the "popup,create"
13006     * signal, which is emitted when a dropdown menu is opened. Users wanting
13007     * to handle these popups by themselves should listen to this signal and
13008     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13009     * property as @c EINA_FALSE means that the user will not handle the popup
13010     * and the default implementation will be used.
13011     *
13012     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13013     * will be emitted to notify the user that it can destroy any objects and
13014     * free all data related to it.
13015     *
13016     * @see elm_web_popup_selected_set()
13017     * @see elm_web_popup_destroy()
13018     */
13019    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13020    /**
13021     * Structure describing the menu of a popup
13022     *
13023     * This structure will be passed as the @c event_info for the "popup,create"
13024     * signal, which is emitted when a dropdown menu is opened. Users wanting
13025     * to handle these popups by themselves should listen to this signal and
13026     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13027     * property as @c EINA_FALSE means that the user will not handle the popup
13028     * and the default implementation will be used.
13029     *
13030     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13031     * will be emitted to notify the user that it can destroy any objects and
13032     * free all data related to it.
13033     *
13034     * @see elm_web_popup_selected_set()
13035     * @see elm_web_popup_destroy()
13036     */
13037    struct _Elm_Web_Menu
13038      {
13039         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13040         int x; /**< The X position of the popup, relative to the elm_web object */
13041         int y; /**< The Y position of the popup, relative to the elm_web object */
13042         int width; /**< Width of the popup menu */
13043         int height; /**< Height of the popup menu */
13044
13045         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. */
13046      };
13047
13048    typedef struct _Elm_Web_Download Elm_Web_Download;
13049    struct _Elm_Web_Download
13050      {
13051         const char *url;
13052      };
13053
13054    /**
13055     * Opaque handler containing the features (such as statusbar, menubar, etc)
13056     * that are to be set on a newly requested window.
13057     */
13058    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13059    /**
13060     * Callback type for the create_window hook.
13061     *
13062     * The function parameters are:
13063     * @li @p data User data pointer set when setting the hook function
13064     * @li @p obj The elm_web object requesting the new window
13065     * @li @p js Set to @c EINA_TRUE if the request was originated from
13066     * JavaScript. @c EINA_FALSE otherwise.
13067     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13068     * the features requested for the new window.
13069     *
13070     * The returned value of the function should be the @c elm_web widget where
13071     * the request will be loaded. That is, if a new window or tab is created,
13072     * the elm_web widget in it should be returned, and @b NOT the window
13073     * object.
13074     * Returning @c NULL should cancel the request.
13075     *
13076     * @see elm_web_window_create_hook_set()
13077     */
13078    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13079    /**
13080     * Callback type for the JS alert hook.
13081     *
13082     * The function parameters are:
13083     * @li @p data User data pointer set when setting the hook function
13084     * @li @p obj The elm_web object requesting the new window
13085     * @li @p message The message to show in the alert dialog
13086     *
13087     * The function should return the object representing the alert dialog.
13088     * Elm_Web will run a second main loop to handle the dialog and normal
13089     * flow of the application will be restored when the object is deleted, so
13090     * the user should handle the popup properly in order to delete the object
13091     * when the action is finished.
13092     * If the function returns @c NULL the popup will be ignored.
13093     *
13094     * @see elm_web_dialog_alert_hook_set()
13095     */
13096    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13097    /**
13098     * Callback type for the JS confirm hook.
13099     *
13100     * The function parameters are:
13101     * @li @p data User data pointer set when setting the hook function
13102     * @li @p obj The elm_web object requesting the new window
13103     * @li @p message The message to show in the confirm dialog
13104     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13105     * the user selected @c Ok, @c EINA_FALSE otherwise.
13106     *
13107     * The function should return the object representing the confirm dialog.
13108     * Elm_Web will run a second main loop to handle the dialog and normal
13109     * flow of the application will be restored when the object is deleted, so
13110     * the user should handle the popup properly in order to delete the object
13111     * when the action is finished.
13112     * If the function returns @c NULL the popup will be ignored.
13113     *
13114     * @see elm_web_dialog_confirm_hook_set()
13115     */
13116    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13117    /**
13118     * Callback type for the JS prompt hook.
13119     *
13120     * The function parameters are:
13121     * @li @p data User data pointer set when setting the hook function
13122     * @li @p obj The elm_web object requesting the new window
13123     * @li @p message The message to show in the prompt dialog
13124     * @li @p def_value The default value to present the user in the entry
13125     * @li @p value Pointer where to store the value given by the user. Must
13126     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13127     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13128     * the user selected @c Ok, @c EINA_FALSE otherwise.
13129     *
13130     * The function should return the object representing the prompt dialog.
13131     * Elm_Web will run a second main loop to handle the dialog and normal
13132     * flow of the application will be restored when the object is deleted, so
13133     * the user should handle the popup properly in order to delete the object
13134     * when the action is finished.
13135     * If the function returns @c NULL the popup will be ignored.
13136     *
13137     * @see elm_web_dialog_prompt_hook_set()
13138     */
13139    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13140    /**
13141     * Callback type for the JS file selector hook.
13142     *
13143     * The function parameters are:
13144     * @li @p data User data pointer set when setting the hook function
13145     * @li @p obj The elm_web object requesting the new window
13146     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13147     * @li @p accept_types Mime types accepted
13148     * @li @p selected Pointer where to store the list of malloc'ed strings
13149     * containing the path to each file selected. Must be @c NULL if the file
13150     * dialog is cancelled
13151     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13152     * the user selected @c Ok, @c EINA_FALSE otherwise.
13153     *
13154     * The function should return the object representing the file selector
13155     * dialog.
13156     * Elm_Web will run a second main loop to handle the dialog and normal
13157     * flow of the application will be restored when the object is deleted, so
13158     * the user should handle the popup properly in order to delete the object
13159     * when the action is finished.
13160     * If the function returns @c NULL the popup will be ignored.
13161     *
13162     * @see elm_web_dialog_file selector_hook_set()
13163     */
13164    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);
13165    /**
13166     * Callback type for the JS console message hook.
13167     *
13168     * When a console message is added from JavaScript, any set function to the
13169     * console message hook will be called for the user to handle. There is no
13170     * default implementation of this hook.
13171     *
13172     * The function parameters are:
13173     * @li @p data User data pointer set when setting the hook function
13174     * @li @p obj The elm_web object that originated the message
13175     * @li @p message The message sent
13176     * @li @p line_number The line number
13177     * @li @p source_id Source id
13178     *
13179     * @see elm_web_console_message_hook_set()
13180     */
13181    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13182    /**
13183     * Add a new web object to the parent.
13184     *
13185     * @param parent The parent object.
13186     * @return The new object or NULL if it cannot be created.
13187     *
13188     * @see elm_web_uri_set()
13189     * @see elm_web_webkit_view_get()
13190     */
13191    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13192
13193    /**
13194     * Get internal ewk_view object from web object.
13195     *
13196     * Elementary may not provide some low level features of EWebKit,
13197     * instead of cluttering the API with proxy methods we opted to
13198     * return the internal reference. Be careful using it as it may
13199     * interfere with elm_web behavior.
13200     *
13201     * @param obj The web object.
13202     * @return The internal ewk_view object or NULL if it does not
13203     *         exist. (Failure to create or Elementary compiled without
13204     *         ewebkit)
13205     *
13206     * @see elm_web_add()
13207     */
13208    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13209
13210    /**
13211     * Sets the function to call when a new window is requested
13212     *
13213     * This hook will be called when a request to create a new window is
13214     * issued from the web page loaded.
13215     * There is no default implementation for this feature, so leaving this
13216     * unset or passing @c NULL in @p func will prevent new windows from
13217     * opening.
13218     *
13219     * @param obj The web object where to set the hook function
13220     * @param func The hook function to be called when a window is requested
13221     * @param data User data
13222     */
13223    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13224    /**
13225     * Sets the function to call when an alert dialog
13226     *
13227     * This hook will be called when a JavaScript alert dialog is requested.
13228     * If no function is set or @c NULL is passed in @p func, the default
13229     * implementation will take place.
13230     *
13231     * @param obj The web object where to set the hook function
13232     * @param func The callback function to be used
13233     * @param data User data
13234     *
13235     * @see elm_web_inwin_mode_set()
13236     */
13237    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13238    /**
13239     * Sets the function to call when an confirm dialog
13240     *
13241     * This hook will be called when a JavaScript confirm dialog is requested.
13242     * If no function is set or @c NULL is passed in @p func, the default
13243     * implementation will take place.
13244     *
13245     * @param obj The web object where to set the hook function
13246     * @param func The callback function to be used
13247     * @param data User data
13248     *
13249     * @see elm_web_inwin_mode_set()
13250     */
13251    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13252    /**
13253     * Sets the function to call when an prompt dialog
13254     *
13255     * This hook will be called when a JavaScript prompt dialog is requested.
13256     * If no function is set or @c NULL is passed in @p func, the default
13257     * implementation will take place.
13258     *
13259     * @param obj The web object where to set the hook function
13260     * @param func The callback function to be used
13261     * @param data User data
13262     *
13263     * @see elm_web_inwin_mode_set()
13264     */
13265    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13266    /**
13267     * Sets the function to call when an file selector dialog
13268     *
13269     * This hook will be called when a JavaScript file selector dialog is
13270     * requested.
13271     * If no function is set or @c NULL is passed in @p func, the default
13272     * implementation will take place.
13273     *
13274     * @param obj The web object where to set the hook function
13275     * @param func The callback function to be used
13276     * @param data User data
13277     *
13278     * @see elm_web_inwin_mode_set()
13279     */
13280    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13281    /**
13282     * Sets the function to call when a console message is emitted from JS
13283     *
13284     * This hook will be called when a console message is emitted from
13285     * JavaScript. There is no default implementation for this feature.
13286     *
13287     * @param obj The web object where to set the hook function
13288     * @param func The callback function to be used
13289     * @param data User data
13290     */
13291    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13292    /**
13293     * Gets the status of the tab propagation
13294     *
13295     * @param obj The web object to query
13296     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13297     *
13298     * @see elm_web_tab_propagate_set()
13299     */
13300    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13301    /**
13302     * Sets whether to use tab propagation
13303     *
13304     * If tab propagation is enabled, whenever the user presses the Tab key,
13305     * Elementary will handle it and switch focus to the next widget.
13306     * The default value is disabled, where WebKit will handle the Tab key to
13307     * cycle focus though its internal objects, jumping to the next widget
13308     * only when that cycle ends.
13309     *
13310     * @param obj The web object
13311     * @param propagate Whether to propagate Tab keys to Elementary or not
13312     */
13313    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13314    /**
13315     * Sets the URI for the web object
13316     *
13317     * It must be a full URI, with resource included, in the form
13318     * http://www.enlightenment.org or file:///tmp/something.html
13319     *
13320     * @param obj The web object
13321     * @param uri The URI to set
13322     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13323     */
13324    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13325    /**
13326     * Gets the current URI for the object
13327     *
13328     * The returned string must not be freed and is guaranteed to be
13329     * stringshared.
13330     *
13331     * @param obj The web object
13332     * @return A stringshared internal string with the current URI, or NULL on
13333     * failure
13334     */
13335    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13336    /**
13337     * Gets the current title
13338     *
13339     * The returned string must not be freed and is guaranteed to be
13340     * stringshared.
13341     *
13342     * @param obj The web object
13343     * @return A stringshared internal string with the current title, or NULL on
13344     * failure
13345     */
13346    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13347    /**
13348     * Sets the background color to be used by the web object
13349     *
13350     * This is the color that will be used by default when the loaded page
13351     * does not set it's own. Color values are pre-multiplied.
13352     *
13353     * @param obj The web object
13354     * @param r Red component
13355     * @param g Green component
13356     * @param b Blue component
13357     * @param a Alpha component
13358     */
13359    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13360    /**
13361     * Gets the background color to be used by the web object
13362     *
13363     * This is the color that will be used by default when the loaded page
13364     * does not set it's own. Color values are pre-multiplied.
13365     *
13366     * @param obj The web object
13367     * @param r Red component
13368     * @param g Green component
13369     * @param b Blue component
13370     * @param a Alpha component
13371     */
13372    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13373    /**
13374     * Gets a copy of the currently selected text
13375     *
13376     * The string returned must be freed by the user when it's done with it.
13377     *
13378     * @param obj The web object
13379     * @return A newly allocated string, or NULL if nothing is selected or an
13380     * error occurred
13381     */
13382    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13383    /**
13384     * Tells the web object which index in the currently open popup was selected
13385     *
13386     * When the user handles the popup creation from the "popup,created" signal,
13387     * it needs to tell the web object which item was selected by calling this
13388     * function with the index corresponding to the item.
13389     *
13390     * @param obj The web object
13391     * @param index The index selected
13392     *
13393     * @see elm_web_popup_destroy()
13394     */
13395    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13396    /**
13397     * Dismisses an open dropdown popup
13398     *
13399     * When the popup from a dropdown widget is to be dismissed, either after
13400     * selecting an option or to cancel it, this function must be called, which
13401     * will later emit an "popup,willdelete" signal to notify the user that
13402     * any memory and objects related to this popup can be freed.
13403     *
13404     * @param obj The web object
13405     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13406     * if there was no menu to destroy
13407     */
13408    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13409    /**
13410     * Searches the given string in a document.
13411     *
13412     * @param obj The web object where to search the text
13413     * @param string String to search
13414     * @param case_sensitive If search should be case sensitive or not
13415     * @param forward If search is from cursor and on or backwards
13416     * @param wrap If search should wrap at the end
13417     *
13418     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13419     * or failure
13420     */
13421    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13422    /**
13423     * Marks matches of the given string in a document.
13424     *
13425     * @param obj The web object where to search text
13426     * @param string String to match
13427     * @param case_sensitive If match should be case sensitive or not
13428     * @param highlight If matches should be highlighted
13429     * @param limit Maximum amount of matches, or zero to unlimited
13430     *
13431     * @return number of matched @a string
13432     */
13433    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13434    /**
13435     * Clears all marked matches in the document
13436     *
13437     * @param obj The web object
13438     *
13439     * @return EINA_TRUE on success, EINA_FALSE otherwise
13440     */
13441    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13442    /**
13443     * Sets whether to highlight the matched marks
13444     *
13445     * If enabled, marks set with elm_web_text_matches_mark() will be
13446     * highlighted.
13447     *
13448     * @param obj The web object
13449     * @param highlight Whether to highlight the marks or not
13450     *
13451     * @return EINA_TRUE on success, EINA_FALSE otherwise
13452     */
13453    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13454    /**
13455     * Gets whether highlighting marks is enabled
13456     *
13457     * @param The web object
13458     *
13459     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13460     * otherwise
13461     */
13462    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13463    /**
13464     * Gets the overall loading progress of the page
13465     *
13466     * Returns the estimated loading progress of the page, with a value between
13467     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13468     * included in the page.
13469     *
13470     * @param The web object
13471     *
13472     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13473     * failure
13474     */
13475    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13476    /**
13477     * Stops loading the current page
13478     *
13479     * Cancels the loading of the current page in the web object. This will
13480     * cause a "load,error" signal to be emitted, with the is_cancellation
13481     * flag set to EINA_TRUE.
13482     *
13483     * @param obj The web object
13484     *
13485     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13486     */
13487    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13488    /**
13489     * Requests a reload of the current document in the object
13490     *
13491     * @param obj The web object
13492     *
13493     * @return EINA_TRUE on success, EINA_FALSE otherwise
13494     */
13495    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13496    /**
13497     * Requests a reload of the current document, avoiding any existing caches
13498     *
13499     * @param obj The web object
13500     *
13501     * @return EINA_TRUE on success, EINA_FALSE otherwise
13502     */
13503    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13504    /**
13505     * Goes back one step in the browsing history
13506     *
13507     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13508     *
13509     * @param obj The web object
13510     *
13511     * @return EINA_TRUE on success, EINA_FALSE otherwise
13512     *
13513     * @see elm_web_history_enable_set()
13514     * @see elm_web_back_possible()
13515     * @see elm_web_forward()
13516     * @see elm_web_navigate()
13517     */
13518    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13519    /**
13520     * Goes forward one step in the browsing history
13521     *
13522     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13523     *
13524     * @param obj The web object
13525     *
13526     * @return EINA_TRUE on success, EINA_FALSE otherwise
13527     *
13528     * @see elm_web_history_enable_set()
13529     * @see elm_web_forward_possible()
13530     * @see elm_web_back()
13531     * @see elm_web_navigate()
13532     */
13533    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13534    /**
13535     * Jumps the given number of steps in the browsing history
13536     *
13537     * The @p steps value can be a negative integer to back in history, or a
13538     * positive to move forward.
13539     *
13540     * @param obj The web object
13541     * @param steps The number of steps to jump
13542     *
13543     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13544     * history exists to jump the given number of steps
13545     *
13546     * @see elm_web_history_enable_set()
13547     * @see elm_web_navigate_possible()
13548     * @see elm_web_back()
13549     * @see elm_web_forward()
13550     */
13551    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13552    /**
13553     * Queries whether it's possible to go back in history
13554     *
13555     * @param obj The web object
13556     *
13557     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13558     * otherwise
13559     */
13560    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13561    /**
13562     * Queries whether it's possible to go forward in history
13563     *
13564     * @param obj The web object
13565     *
13566     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13567     * otherwise
13568     */
13569    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13570    /**
13571     * Queries whether it's possible to jump the given number of steps
13572     *
13573     * The @p steps value can be a negative integer to back in history, or a
13574     * positive to move forward.
13575     *
13576     * @param obj The web object
13577     * @param steps The number of steps to check for
13578     *
13579     * @return EINA_TRUE if enough history exists to perform the given jump,
13580     * EINA_FALSE otherwise
13581     */
13582    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13583    /**
13584     * Gets whether browsing history is enabled for the given object
13585     *
13586     * @param obj The web object
13587     *
13588     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13589     */
13590    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13591    /**
13592     * Enables or disables the browsing history
13593     *
13594     * @param obj The web object
13595     * @param enable Whether to enable or disable the browsing history
13596     */
13597    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13598    /**
13599     * Gets whether text-only zoom is set
13600     *
13601     * @param obj The web object
13602     *
13603     * @return EINA_TRUE if zoom is set to affect only text, EINA_FALSE
13604     * otherwise
13605     *
13606     * @see elm_web_zoom_text_only_set()
13607     */
13608    EAPI Eina_Bool                    elm_web_zoom_text_only_get(const Evas_Object *obj);
13609    /**
13610     * Enables or disables zoom to affect only text
13611     *
13612     * If set, then the zoom level set to the page will only be applied on text,
13613     * leaving other objects, such as images, at their original size.
13614     *
13615     * @param obj The web object
13616     * @param setting EINA_TRUE to use text-only zoom, EINA_FALSE to have zoom
13617     * affect the entire page
13618     */
13619    EAPI void                         elm_web_zoom_text_only_set(Evas_Object *obj, Eina_Bool setting);
13620    /**
13621     * Sets the default dialogs to use an Inwin instead of a normal window
13622     *
13623     * If set, then the default implementation for the JavaScript dialogs and
13624     * file selector will be opened in an Inwin. Otherwise they will use a
13625     * normal separated window.
13626     *
13627     * @param obj The web object
13628     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13629     */
13630    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13631    /**
13632     * Gets whether Inwin mode is set for the current object
13633     *
13634     * @param obj The web object
13635     *
13636     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13637     */
13638    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13639
13640    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13641    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13642    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);
13643    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13644
13645    /**
13646     * @}
13647     */
13648
13649    /**
13650     * @defgroup Hoversel Hoversel
13651     *
13652     * @image html img/widget/hoversel/preview-00.png
13653     * @image latex img/widget/hoversel/preview-00.eps
13654     *
13655     * A hoversel is a button that pops up a list of items (automatically
13656     * choosing the direction to display) that have a label and, optionally, an
13657     * icon to select from. It is a convenience widget to avoid the need to do
13658     * all the piecing together yourself. It is intended for a small number of
13659     * items in the hoversel menu (no more than 8), though is capable of many
13660     * more.
13661     *
13662     * Signals that you can add callbacks for are:
13663     * "clicked" - the user clicked the hoversel button and popped up the sel
13664     * "selected" - an item in the hoversel list is selected. event_info is the item
13665     * "dismissed" - the hover is dismissed
13666     *
13667     * See @ref tutorial_hoversel for an example.
13668     * @{
13669     */
13670    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13671    /**
13672     * @brief Add a new Hoversel object
13673     *
13674     * @param parent The parent object
13675     * @return The new object or NULL if it cannot be created
13676     */
13677    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13678    /**
13679     * @brief This sets the hoversel to expand horizontally.
13680     *
13681     * @param obj The hoversel object
13682     * @param horizontal If true, the hover will expand horizontally to the
13683     * right.
13684     *
13685     * @note The initial button will display horizontally regardless of this
13686     * setting.
13687     */
13688    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13689    /**
13690     * @brief This returns whether the hoversel is set to expand horizontally.
13691     *
13692     * @param obj The hoversel object
13693     * @return If true, the hover will expand horizontally to the right.
13694     *
13695     * @see elm_hoversel_horizontal_set()
13696     */
13697    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13698    /**
13699     * @brief Set the Hover parent
13700     *
13701     * @param obj The hoversel object
13702     * @param parent The parent to use
13703     *
13704     * Sets the hover parent object, the area that will be darkened when the
13705     * hoversel is clicked. Should probably be the window that the hoversel is
13706     * in. See @ref Hover objects for more information.
13707     */
13708    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13709    /**
13710     * @brief Get the Hover parent
13711     *
13712     * @param obj The hoversel object
13713     * @return The used parent
13714     *
13715     * Gets the hover parent object.
13716     *
13717     * @see elm_hoversel_hover_parent_set()
13718     */
13719    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13720    /**
13721     * @brief Set the hoversel button label
13722     *
13723     * @param obj The hoversel object
13724     * @param label The label text.
13725     *
13726     * This sets the label of the button that is always visible (before it is
13727     * clicked and expanded).
13728     *
13729     * @deprecated elm_object_text_set()
13730     */
13731    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13732    /**
13733     * @brief Get the hoversel button label
13734     *
13735     * @param obj The hoversel object
13736     * @return The label text.
13737     *
13738     * @deprecated elm_object_text_get()
13739     */
13740    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13741    /**
13742     * @brief Set the icon of the hoversel button
13743     *
13744     * @param obj The hoversel object
13745     * @param icon The icon object
13746     *
13747     * Sets the icon of the button that is always visible (before it is clicked
13748     * and expanded).  Once the icon object is set, a previously set one will be
13749     * deleted, if you want to keep that old content object, use the
13750     * elm_hoversel_icon_unset() function.
13751     *
13752     * @see elm_button_icon_set()
13753     */
13754    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13755    /**
13756     * @brief Get the icon of the hoversel button
13757     *
13758     * @param obj The hoversel object
13759     * @return The icon object
13760     *
13761     * Get the icon of the button that is always visible (before it is clicked
13762     * and expanded). Also see elm_button_icon_get().
13763     *
13764     * @see elm_hoversel_icon_set()
13765     */
13766    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13767    /**
13768     * @brief Get and unparent the icon of the hoversel button
13769     *
13770     * @param obj The hoversel object
13771     * @return The icon object that was being used
13772     *
13773     * Unparent and return the icon of the button that is always visible
13774     * (before it is clicked and expanded).
13775     *
13776     * @see elm_hoversel_icon_set()
13777     * @see elm_button_icon_unset()
13778     */
13779    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13780    /**
13781     * @brief This triggers the hoversel popup from code, the same as if the user
13782     * had clicked the button.
13783     *
13784     * @param obj The hoversel object
13785     */
13786    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13787    /**
13788     * @brief This dismisses the hoversel popup as if the user had clicked
13789     * outside the hover.
13790     *
13791     * @param obj The hoversel object
13792     */
13793    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13794    /**
13795     * @brief Returns whether the hoversel is expanded.
13796     *
13797     * @param obj The hoversel object
13798     * @return  This will return EINA_TRUE if the hoversel is expanded or
13799     * EINA_FALSE if it is not expanded.
13800     */
13801    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13802    /**
13803     * @brief This will remove all the children items from the hoversel.
13804     *
13805     * @param obj The hoversel object
13806     *
13807     * @warning Should @b not be called while the hoversel is active; use
13808     * elm_hoversel_expanded_get() to check first.
13809     *
13810     * @see elm_hoversel_item_del_cb_set()
13811     * @see elm_hoversel_item_del()
13812     */
13813    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13814    /**
13815     * @brief Get the list of items within the given hoversel.
13816     *
13817     * @param obj The hoversel object
13818     * @return Returns a list of Elm_Hoversel_Item*
13819     *
13820     * @see elm_hoversel_item_add()
13821     */
13822    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13823    /**
13824     * @brief Add an item to the hoversel button
13825     *
13826     * @param obj The hoversel object
13827     * @param label The text label to use for the item (NULL if not desired)
13828     * @param icon_file An image file path on disk to use for the icon or standard
13829     * icon name (NULL if not desired)
13830     * @param icon_type The icon type if relevant
13831     * @param func Convenience function to call when this item is selected
13832     * @param data Data to pass to item-related functions
13833     * @return A handle to the item added.
13834     *
13835     * This adds an item to the hoversel to show when it is clicked. Note: if you
13836     * need to use an icon from an edje file then use
13837     * elm_hoversel_item_icon_set() right after the this function, and set
13838     * icon_file to NULL here.
13839     *
13840     * For more information on what @p icon_file and @p icon_type are see the
13841     * @ref Icon "icon documentation".
13842     */
13843    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);
13844    /**
13845     * @brief Delete an item from the hoversel
13846     *
13847     * @param item The item to delete
13848     *
13849     * This deletes the item from the hoversel (should not be called while the
13850     * hoversel is active; use elm_hoversel_expanded_get() to check first).
13851     *
13852     * @see elm_hoversel_item_add()
13853     * @see elm_hoversel_item_del_cb_set()
13854     */
13855    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13856    /**
13857     * @brief Set the function to be called when an item from the hoversel is
13858     * freed.
13859     *
13860     * @param item The item to set the callback on
13861     * @param func The function called
13862     *
13863     * That function will receive these parameters:
13864     * @li void *item_data
13865     * @li Evas_Object *the_item_object
13866     * @li Elm_Hoversel_Item *the_object_struct
13867     *
13868     * @see elm_hoversel_item_add()
13869     */
13870    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13871    /**
13872     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13873     * that will be passed to associated function callbacks.
13874     *
13875     * @param item The item to get the data from
13876     * @return The data pointer set with elm_hoversel_item_add()
13877     *
13878     * @see elm_hoversel_item_add()
13879     */
13880    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13881    /**
13882     * @brief This returns the label text of the given hoversel item.
13883     *
13884     * @param item The item to get the label
13885     * @return The label text of the hoversel item
13886     *
13887     * @see elm_hoversel_item_add()
13888     */
13889    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13890    /**
13891     * @brief This sets the icon for the given hoversel item.
13892     *
13893     * @param item The item to set the icon
13894     * @param icon_file An image file path on disk to use for the icon or standard
13895     * icon name
13896     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13897     * to NULL if the icon is not an edje file
13898     * @param icon_type The icon type
13899     *
13900     * The icon can be loaded from the standard set, from an image file, or from
13901     * an edje file.
13902     *
13903     * @see elm_hoversel_item_add()
13904     */
13905    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);
13906    /**
13907     * @brief Get the icon object of the hoversel item
13908     *
13909     * @param item The item to get the icon from
13910     * @param icon_file The image file path on disk used for the icon or standard
13911     * icon name
13912     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13913     * if the icon is not an edje file
13914     * @param icon_type The icon type
13915     *
13916     * @see elm_hoversel_item_icon_set()
13917     * @see elm_hoversel_item_add()
13918     */
13919    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);
13920    /**
13921     * @}
13922     */
13923
13924    /**
13925     * @defgroup Toolbar Toolbar
13926     * @ingroup Elementary
13927     *
13928     * @image html img/widget/toolbar/preview-00.png
13929     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13930     *
13931     * @image html img/toolbar.png
13932     * @image latex img/toolbar.eps width=\textwidth
13933     *
13934     * A toolbar is a widget that displays a list of items inside
13935     * a box. It can be scrollable, show a menu with items that don't fit
13936     * to toolbar size or even crop them.
13937     *
13938     * Only one item can be selected at a time.
13939     *
13940     * Items can have multiple states, or show menus when selected by the user.
13941     *
13942     * Smart callbacks one can listen to:
13943     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13944     *
13945     * Available styles for it:
13946     * - @c "default"
13947     * - @c "transparent" - no background or shadow, just show the content
13948     *
13949     * List of examples:
13950     * @li @ref toolbar_example_01
13951     * @li @ref toolbar_example_02
13952     * @li @ref toolbar_example_03
13953     */
13954
13955    /**
13956     * @addtogroup Toolbar
13957     * @{
13958     */
13959
13960    /**
13961     * @enum _Elm_Toolbar_Shrink_Mode
13962     * @typedef Elm_Toolbar_Shrink_Mode
13963     *
13964     * Set toolbar's items display behavior, it can be scrollabel,
13965     * show a menu with exceeding items, or simply hide them.
13966     *
13967     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13968     * from elm config.
13969     *
13970     * Values <b> don't </b> work as bitmask, only one can be choosen.
13971     *
13972     * @see elm_toolbar_mode_shrink_set()
13973     * @see elm_toolbar_mode_shrink_get()
13974     *
13975     * @ingroup Toolbar
13976     */
13977    typedef enum _Elm_Toolbar_Shrink_Mode
13978      {
13979         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
13980         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
13981         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13982         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
13983      } Elm_Toolbar_Shrink_Mode;
13984
13985    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(). */
13986
13987    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(). */
13988
13989    /**
13990     * Add a new toolbar widget to the given parent Elementary
13991     * (container) object.
13992     *
13993     * @param parent The parent object.
13994     * @return a new toolbar widget handle or @c NULL, on errors.
13995     *
13996     * This function inserts a new toolbar widget on the canvas.
13997     *
13998     * @ingroup Toolbar
13999     */
14000    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14001
14002    /**
14003     * Set the icon size, in pixels, to be used by toolbar items.
14004     *
14005     * @param obj The toolbar object
14006     * @param icon_size The icon size in pixels
14007     *
14008     * @note Default value is @c 32. It reads value from elm config.
14009     *
14010     * @see elm_toolbar_icon_size_get()
14011     *
14012     * @ingroup Toolbar
14013     */
14014    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14015
14016    /**
14017     * Get the icon size, in pixels, to be used by toolbar items.
14018     *
14019     * @param obj The toolbar object.
14020     * @return The icon size in pixels.
14021     *
14022     * @see elm_toolbar_icon_size_set() for details.
14023     *
14024     * @ingroup Toolbar
14025     */
14026    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14027
14028    /**
14029     * Sets icon lookup order, for toolbar items' icons.
14030     *
14031     * @param obj The toolbar object.
14032     * @param order The icon lookup order.
14033     *
14034     * Icons added before calling this function will not be affected.
14035     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14036     *
14037     * @see elm_toolbar_icon_order_lookup_get()
14038     *
14039     * @ingroup Toolbar
14040     */
14041    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14042
14043    /**
14044     * Gets the icon lookup order.
14045     *
14046     * @param obj The toolbar object.
14047     * @return The icon lookup order.
14048     *
14049     * @see elm_toolbar_icon_order_lookup_set() for details.
14050     *
14051     * @ingroup Toolbar
14052     */
14053    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14054
14055    /**
14056     * Set whether the toolbar should always have an item selected.
14057     *
14058     * @param obj The toolbar object.
14059     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14060     * disable it.
14061     *
14062     * This will cause the toolbar to always have an item selected, and clicking
14063     * the selected item will not cause a selected event to be emitted. Enabling this mode
14064     * will immediately select the first toolbar item.
14065     *
14066     * Always-selected is disabled by default.
14067     *
14068     * @see elm_toolbar_always_select_mode_get().
14069     *
14070     * @ingroup Toolbar
14071     */
14072    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14073
14074    /**
14075     * Get whether the toolbar should always have an item selected.
14076     *
14077     * @param obj The toolbar object.
14078     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14079     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14080     *
14081     * @see elm_toolbar_always_select_mode_set() for details.
14082     *
14083     * @ingroup Toolbar
14084     */
14085    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14086
14087    /**
14088     * Set whether the toolbar items' should be selected by the user or not.
14089     *
14090     * @param obj The toolbar object.
14091     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14092     * enable it.
14093     *
14094     * This will turn off the ability to select items entirely and they will
14095     * neither appear selected nor emit selected signals. The clicked
14096     * callback function will still be called.
14097     *
14098     * Selection is enabled by default.
14099     *
14100     * @see elm_toolbar_no_select_mode_get().
14101     *
14102     * @ingroup Toolbar
14103     */
14104    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14105
14106    /**
14107     * Set whether the toolbar items' should be selected by the user or not.
14108     *
14109     * @param obj The toolbar object.
14110     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14111     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14112     *
14113     * @see elm_toolbar_no_select_mode_set() for details.
14114     *
14115     * @ingroup Toolbar
14116     */
14117    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14118
14119    /**
14120     * Append item to the toolbar.
14121     *
14122     * @param obj The toolbar object.
14123     * @param icon A string with icon name or the absolute path of an image file.
14124     * @param label The label of the item.
14125     * @param func The function to call when the item is clicked.
14126     * @param data The data to associate with the item for related callbacks.
14127     * @return The created item or @c NULL upon failure.
14128     *
14129     * A new item will be created and appended to the toolbar, i.e., will
14130     * be set as @b last item.
14131     *
14132     * Items created with this method can be deleted with
14133     * elm_toolbar_item_del().
14134     *
14135     * Associated @p data can be properly freed when item is deleted if a
14136     * callback function is set with elm_toolbar_item_del_cb_set().
14137     *
14138     * If a function is passed as argument, it will be called everytime this item
14139     * is selected, i.e., the user clicks over an unselected item.
14140     * If such function isn't needed, just passing
14141     * @c NULL as @p func is enough. The same should be done for @p data.
14142     *
14143     * Toolbar will load icon image from fdo or current theme.
14144     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14145     * If an absolute path is provided it will load it direct from a file.
14146     *
14147     * @see elm_toolbar_item_icon_set()
14148     * @see elm_toolbar_item_del()
14149     * @see elm_toolbar_item_del_cb_set()
14150     *
14151     * @ingroup Toolbar
14152     */
14153    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);
14154
14155    /**
14156     * Prepend item to the toolbar.
14157     *
14158     * @param obj The toolbar object.
14159     * @param icon A string with icon name or the absolute path of an image file.
14160     * @param label The label of the item.
14161     * @param func The function to call when the item is clicked.
14162     * @param data The data to associate with the item for related callbacks.
14163     * @return The created item or @c NULL upon failure.
14164     *
14165     * A new item will be created and prepended to the toolbar, i.e., will
14166     * be set as @b first item.
14167     *
14168     * Items created with this method can be deleted with
14169     * elm_toolbar_item_del().
14170     *
14171     * Associated @p data can be properly freed when item is deleted if a
14172     * callback function is set with elm_toolbar_item_del_cb_set().
14173     *
14174     * If a function is passed as argument, it will be called everytime this item
14175     * is selected, i.e., the user clicks over an unselected item.
14176     * If such function isn't needed, just passing
14177     * @c NULL as @p func is enough. The same should be done for @p data.
14178     *
14179     * Toolbar will load icon image from fdo or current theme.
14180     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14181     * If an absolute path is provided it will load it direct from a file.
14182     *
14183     * @see elm_toolbar_item_icon_set()
14184     * @see elm_toolbar_item_del()
14185     * @see elm_toolbar_item_del_cb_set()
14186     *
14187     * @ingroup Toolbar
14188     */
14189    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);
14190
14191    /**
14192     * Insert a new item into the toolbar object before item @p before.
14193     *
14194     * @param obj The toolbar object.
14195     * @param before The toolbar item to insert before.
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 added to the toolbar. Its position in
14203     * this toolbar will be just before item @p before.
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_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);
14227
14228    /**
14229     * Insert a new item into the toolbar object after item @p after.
14230     *
14231     * @param obj The toolbar object.
14232     * @param before The toolbar item to insert before.
14233     * @param icon A string with icon name or the absolute path of an image file.
14234     * @param label The label of the item.
14235     * @param func The function to call when the item is clicked.
14236     * @param data The data to associate with the item for related callbacks.
14237     * @return The created item or @c NULL upon failure.
14238     *
14239     * A new item will be created and added to the toolbar. Its position in
14240     * this toolbar will be just after item @p after.
14241     *
14242     * Items created with this method can be deleted with
14243     * elm_toolbar_item_del().
14244     *
14245     * Associated @p data can be properly freed when item is deleted if a
14246     * callback function is set with elm_toolbar_item_del_cb_set().
14247     *
14248     * If a function is passed as argument, it will be called everytime this item
14249     * is selected, i.e., the user clicks over an unselected item.
14250     * If such function isn't needed, just passing
14251     * @c NULL as @p func is enough. The same should be done for @p data.
14252     *
14253     * Toolbar will load icon image from fdo or current theme.
14254     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14255     * If an absolute path is provided it will load it direct from a file.
14256     *
14257     * @see elm_toolbar_item_icon_set()
14258     * @see elm_toolbar_item_del()
14259     * @see elm_toolbar_item_del_cb_set()
14260     *
14261     * @ingroup Toolbar
14262     */
14263    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);
14264
14265    /**
14266     * Get the first item in the given toolbar widget's list of
14267     * items.
14268     *
14269     * @param obj The toolbar object
14270     * @return The first item or @c NULL, if it has no items (and on
14271     * errors)
14272     *
14273     * @see elm_toolbar_item_append()
14274     * @see elm_toolbar_last_item_get()
14275     *
14276     * @ingroup Toolbar
14277     */
14278    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14279
14280    /**
14281     * Get the last item in the given toolbar widget's list of
14282     * items.
14283     *
14284     * @param obj The toolbar object
14285     * @return The last item or @c NULL, if it has no items (and on
14286     * errors)
14287     *
14288     * @see elm_toolbar_item_prepend()
14289     * @see elm_toolbar_first_item_get()
14290     *
14291     * @ingroup Toolbar
14292     */
14293    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14294
14295    /**
14296     * Get the item after @p item in toolbar.
14297     *
14298     * @param item The toolbar item.
14299     * @return The item after @p item, or @c NULL if none or on failure.
14300     *
14301     * @note If it is the last item, @c NULL will be returned.
14302     *
14303     * @see elm_toolbar_item_append()
14304     *
14305     * @ingroup Toolbar
14306     */
14307    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14308
14309    /**
14310     * Get the item before @p item in toolbar.
14311     *
14312     * @param item The toolbar item.
14313     * @return The item before @p item, or @c NULL if none or on failure.
14314     *
14315     * @note If it is the first item, @c NULL will be returned.
14316     *
14317     * @see elm_toolbar_item_prepend()
14318     *
14319     * @ingroup Toolbar
14320     */
14321    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14322
14323    /**
14324     * Get the toolbar object from an item.
14325     *
14326     * @param item The item.
14327     * @return The toolbar object.
14328     *
14329     * This returns the toolbar object itself that an item belongs to.
14330     *
14331     * @ingroup Toolbar
14332     */
14333    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14334
14335    /**
14336     * Set the priority of a toolbar item.
14337     *
14338     * @param item The toolbar item.
14339     * @param priority The item priority. The default is zero.
14340     *
14341     * This is used only when the toolbar shrink mode is set to
14342     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14343     * When space is less than required, items with low priority
14344     * will be removed from the toolbar and added to a dynamically-created menu,
14345     * while items with higher priority will remain on the toolbar,
14346     * with the same order they were added.
14347     *
14348     * @see elm_toolbar_item_priority_get()
14349     *
14350     * @ingroup Toolbar
14351     */
14352    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14353
14354    /**
14355     * Get the priority of a toolbar item.
14356     *
14357     * @param item The toolbar item.
14358     * @return The @p item priority, or @c 0 on failure.
14359     *
14360     * @see elm_toolbar_item_priority_set() for details.
14361     *
14362     * @ingroup Toolbar
14363     */
14364    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14365
14366    /**
14367     * Get the label of item.
14368     *
14369     * @param item The item of toolbar.
14370     * @return The label of item.
14371     *
14372     * The return value is a pointer to the label associated to @p item when
14373     * it was created, with function elm_toolbar_item_append() or similar,
14374     * or later,
14375     * with function elm_toolbar_item_label_set. If no label
14376     * was passed as argument, it will return @c NULL.
14377     *
14378     * @see elm_toolbar_item_label_set() for more details.
14379     * @see elm_toolbar_item_append()
14380     *
14381     * @ingroup Toolbar
14382     */
14383    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14384
14385    /**
14386     * Set the label of item.
14387     *
14388     * @param item The item of toolbar.
14389     * @param text The label of item.
14390     *
14391     * The label to be displayed by the item.
14392     * Label will be placed at icons bottom (if set).
14393     *
14394     * If a label was passed as argument on item creation, with function
14395     * elm_toolbar_item_append() or similar, it will be already
14396     * displayed by the item.
14397     *
14398     * @see elm_toolbar_item_label_get()
14399     * @see elm_toolbar_item_append()
14400     *
14401     * @ingroup Toolbar
14402     */
14403    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14404
14405    /**
14406     * Return the data associated with a given toolbar widget item.
14407     *
14408     * @param item The toolbar widget item handle.
14409     * @return The data associated with @p item.
14410     *
14411     * @see elm_toolbar_item_data_set()
14412     *
14413     * @ingroup Toolbar
14414     */
14415    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14416
14417    /**
14418     * Set the data associated with a given toolbar widget item.
14419     *
14420     * @param item The toolbar widget item handle.
14421     * @param data The new data pointer to set to @p item.
14422     *
14423     * This sets new item data on @p item.
14424     *
14425     * @warning The old data pointer won't be touched by this function, so
14426     * the user had better to free that old data himself/herself.
14427     *
14428     * @ingroup Toolbar
14429     */
14430    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14431
14432    /**
14433     * Returns a pointer to a toolbar item by its label.
14434     *
14435     * @param obj The toolbar object.
14436     * @param label The label of the item to find.
14437     *
14438     * @return The pointer to the toolbar item matching @p label or @c NULL
14439     * on failure.
14440     *
14441     * @ingroup Toolbar
14442     */
14443    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14444
14445    /*
14446     * Get whether the @p item is selected or not.
14447     *
14448     * @param item The toolbar item.
14449     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14450     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14451     *
14452     * @see elm_toolbar_selected_item_set() for details.
14453     * @see elm_toolbar_item_selected_get()
14454     *
14455     * @ingroup Toolbar
14456     */
14457    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14458
14459    /**
14460     * Set the selected state of an item.
14461     *
14462     * @param item The toolbar item
14463     * @param selected The selected state
14464     *
14465     * This sets the selected state of the given item @p it.
14466     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14467     *
14468     * If a new item is selected the previosly selected will be unselected.
14469     * Previoulsy selected item can be get with function
14470     * elm_toolbar_selected_item_get().
14471     *
14472     * Selected items will be highlighted.
14473     *
14474     * @see elm_toolbar_item_selected_get()
14475     * @see elm_toolbar_selected_item_get()
14476     *
14477     * @ingroup Toolbar
14478     */
14479    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14480
14481    /**
14482     * Get the selected item.
14483     *
14484     * @param obj The toolbar object.
14485     * @return The selected toolbar item.
14486     *
14487     * The selected item can be unselected with function
14488     * elm_toolbar_item_selected_set().
14489     *
14490     * The selected item always will be highlighted on toolbar.
14491     *
14492     * @see elm_toolbar_selected_items_get()
14493     *
14494     * @ingroup Toolbar
14495     */
14496    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14497
14498    /**
14499     * Set the icon associated with @p item.
14500     *
14501     * @param obj The parent of this item.
14502     * @param item The toolbar item.
14503     * @param icon A string with icon name or the absolute path of an image file.
14504     *
14505     * Toolbar will load icon image from fdo or current theme.
14506     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14507     * If an absolute path is provided it will load it direct from a file.
14508     *
14509     * @see elm_toolbar_icon_order_lookup_set()
14510     * @see elm_toolbar_icon_order_lookup_get()
14511     *
14512     * @ingroup Toolbar
14513     */
14514    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14515
14516    /**
14517     * Get the string used to set the icon of @p item.
14518     *
14519     * @param item The toolbar item.
14520     * @return The string associated with the icon object.
14521     *
14522     * @see elm_toolbar_item_icon_set() for details.
14523     *
14524     * @ingroup Toolbar
14525     */
14526    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14527
14528    /**
14529     * Get the object of @p item.
14530     *
14531     * @param item The toolbar item.
14532     * @return The object
14533     *
14534     * @ingroup Toolbar
14535     */
14536    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14537
14538    /**
14539     * Get the icon object of @p item.
14540     *
14541     * @param item The toolbar item.
14542     * @return The icon object
14543     *
14544     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14545     *
14546     * @ingroup Toolbar
14547     */
14548    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14549
14550    /**
14551     * Set the icon associated with @p item to an image in a binary buffer.
14552     *
14553     * @param item The toolbar item.
14554     * @param img The binary data that will be used as an image
14555     * @param size The size of binary data @p img
14556     * @param format Optional format of @p img to pass to the image loader
14557     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14558     *
14559     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14560     *
14561     * @note The icon image set by this function can be changed by
14562     * elm_toolbar_item_icon_set().
14563     * 
14564     * @ingroup Toolbar
14565     */
14566    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);
14567
14568    /**
14569     * Delete them item from the toolbar.
14570     *
14571     * @param item The item of toolbar to be deleted.
14572     *
14573     * @see elm_toolbar_item_append()
14574     * @see elm_toolbar_item_del_cb_set()
14575     *
14576     * @ingroup Toolbar
14577     */
14578    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14579
14580    /**
14581     * Set the function called when a toolbar item is freed.
14582     *
14583     * @param item The item to set the callback on.
14584     * @param func The function called.
14585     *
14586     * If there is a @p func, then it will be called prior item's memory release.
14587     * That will be called with the following arguments:
14588     * @li item's data;
14589     * @li item's Evas object;
14590     * @li item itself;
14591     *
14592     * This way, a data associated to a toolbar item could be properly freed.
14593     *
14594     * @ingroup Toolbar
14595     */
14596    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14597
14598    /**
14599     * Get a value whether toolbar item is disabled or not.
14600     *
14601     * @param item The item.
14602     * @return The disabled state.
14603     *
14604     * @see elm_toolbar_item_disabled_set() for more details.
14605     *
14606     * @ingroup Toolbar
14607     */
14608    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14609
14610    /**
14611     * Sets the disabled/enabled state of a toolbar item.
14612     *
14613     * @param item The item.
14614     * @param disabled The disabled state.
14615     *
14616     * A disabled item cannot be selected or unselected. It will also
14617     * change its appearance (generally greyed out). This sets the
14618     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14619     * enabled).
14620     *
14621     * @ingroup Toolbar
14622     */
14623    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14624
14625    /**
14626     * Set or unset item as a separator.
14627     *
14628     * @param item The toolbar item.
14629     * @param setting @c EINA_TRUE to set item @p item as separator or
14630     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14631     *
14632     * Items aren't set as separator by default.
14633     *
14634     * If set as separator it will display separator theme, so won't display
14635     * icons or label.
14636     *
14637     * @see elm_toolbar_item_separator_get()
14638     *
14639     * @ingroup Toolbar
14640     */
14641    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14642
14643    /**
14644     * Get a value whether item is a separator or not.
14645     *
14646     * @param item The toolbar item.
14647     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14648     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14649     *
14650     * @see elm_toolbar_item_separator_set() for details.
14651     *
14652     * @ingroup Toolbar
14653     */
14654    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14655
14656    /**
14657     * Set the shrink state of toolbar @p obj.
14658     *
14659     * @param obj The toolbar object.
14660     * @param shrink_mode Toolbar's items display behavior.
14661     *
14662     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14663     * but will enforce a minimun size so all the items will fit, won't scroll
14664     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14665     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14666     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14667     *
14668     * @ingroup Toolbar
14669     */
14670    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14671
14672    /**
14673     * Get the shrink mode of toolbar @p obj.
14674     *
14675     * @param obj The toolbar object.
14676     * @return Toolbar's items display behavior.
14677     *
14678     * @see elm_toolbar_mode_shrink_set() for details.
14679     *
14680     * @ingroup Toolbar
14681     */
14682    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14683
14684    /**
14685     * Enable/disable homogenous mode.
14686     *
14687     * @param obj The toolbar object
14688     * @param homogeneous Assume the items within the toolbar are of the
14689     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14690     *
14691     * This will enable the homogeneous mode where items are of the same size.
14692     * @see elm_toolbar_homogeneous_get()
14693     *
14694     * @ingroup Toolbar
14695     */
14696    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14697
14698    /**
14699     * Get whether the homogenous mode is enabled.
14700     *
14701     * @param obj The toolbar object.
14702     * @return Assume the items within the toolbar are of the same height
14703     * and width (EINA_TRUE = on, EINA_FALSE = off).
14704     *
14705     * @see elm_toolbar_homogeneous_set()
14706     *
14707     * @ingroup Toolbar
14708     */
14709    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14710
14711    /**
14712     * Enable/disable homogenous mode.
14713     *
14714     * @param obj The toolbar object
14715     * @param homogeneous Assume the items within the toolbar are of the
14716     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14717     *
14718     * This will enable the homogeneous mode where items are of the same size.
14719     * @see elm_toolbar_homogeneous_get()
14720     *
14721     * @deprecated use elm_toolbar_homogeneous_set() instead.
14722     *
14723     * @ingroup Toolbar
14724     */
14725    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14726
14727    /**
14728     * Get whether the homogenous mode is enabled.
14729     *
14730     * @param obj The toolbar object.
14731     * @return Assume the items within the toolbar are of the same height
14732     * and width (EINA_TRUE = on, EINA_FALSE = off).
14733     *
14734     * @see elm_toolbar_homogeneous_set()
14735     * @deprecated use elm_toolbar_homogeneous_get() instead.
14736     *
14737     * @ingroup Toolbar
14738     */
14739    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14740
14741    /**
14742     * Set the parent object of the toolbar items' menus.
14743     *
14744     * @param obj The toolbar object.
14745     * @param parent The parent of the menu objects.
14746     *
14747     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14748     *
14749     * For more details about setting the parent for toolbar menus, see
14750     * elm_menu_parent_set().
14751     *
14752     * @see elm_menu_parent_set() for details.
14753     * @see elm_toolbar_item_menu_set() for details.
14754     *
14755     * @ingroup Toolbar
14756     */
14757    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14758
14759    /**
14760     * Get the parent object of the toolbar items' menus.
14761     *
14762     * @param obj The toolbar object.
14763     * @return The parent of the menu objects.
14764     *
14765     * @see elm_toolbar_menu_parent_set() for details.
14766     *
14767     * @ingroup Toolbar
14768     */
14769    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14770
14771    /**
14772     * Set the alignment of the items.
14773     *
14774     * @param obj The toolbar object.
14775     * @param align The new alignment, a float between <tt> 0.0 </tt>
14776     * and <tt> 1.0 </tt>.
14777     *
14778     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14779     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14780     * items.
14781     *
14782     * Centered items by default.
14783     *
14784     * @see elm_toolbar_align_get()
14785     *
14786     * @ingroup Toolbar
14787     */
14788    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14789
14790    /**
14791     * Get the alignment of the items.
14792     *
14793     * @param obj The toolbar object.
14794     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14795     * <tt> 1.0 </tt>.
14796     *
14797     * @see elm_toolbar_align_set() for details.
14798     *
14799     * @ingroup Toolbar
14800     */
14801    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14802
14803    /**
14804     * Set whether the toolbar item opens a menu.
14805     *
14806     * @param item The toolbar item.
14807     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14808     *
14809     * A toolbar item can be set to be a menu, using this function.
14810     *
14811     * Once it is set to be a menu, it can be manipulated through the
14812     * menu-like function elm_toolbar_menu_parent_set() and the other
14813     * elm_menu functions, using the Evas_Object @c menu returned by
14814     * elm_toolbar_item_menu_get().
14815     *
14816     * So, items to be displayed in this item's menu should be added with
14817     * elm_menu_item_add().
14818     *
14819     * The following code exemplifies the most basic usage:
14820     * @code
14821     * tb = elm_toolbar_add(win)
14822     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14823     * elm_toolbar_item_menu_set(item, EINA_TRUE);
14824     * elm_toolbar_menu_parent_set(tb, win);
14825     * menu = elm_toolbar_item_menu_get(item);
14826     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14827     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14828     * NULL);
14829     * @endcode
14830     *
14831     * @see elm_toolbar_item_menu_get()
14832     *
14833     * @ingroup Toolbar
14834     */
14835    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14836
14837    /**
14838     * Get toolbar item's menu.
14839     *
14840     * @param item The toolbar item.
14841     * @return Item's menu object or @c NULL on failure.
14842     *
14843     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14844     * this function will set it.
14845     *
14846     * @see elm_toolbar_item_menu_set() for details.
14847     *
14848     * @ingroup Toolbar
14849     */
14850    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14851
14852    /**
14853     * Add a new state to @p item.
14854     *
14855     * @param item The item.
14856     * @param icon A string with icon name or the absolute path of an image file.
14857     * @param label The label of the new state.
14858     * @param func The function to call when the item is clicked when this
14859     * state is selected.
14860     * @param data The data to associate with the state.
14861     * @return The toolbar item state, or @c NULL upon failure.
14862     *
14863     * Toolbar will load icon image from fdo or current theme.
14864     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14865     * If an absolute path is provided it will load it direct from a file.
14866     *
14867     * States created with this function can be removed with
14868     * elm_toolbar_item_state_del().
14869     *
14870     * @see elm_toolbar_item_state_del()
14871     * @see elm_toolbar_item_state_sel()
14872     * @see elm_toolbar_item_state_get()
14873     *
14874     * @ingroup Toolbar
14875     */
14876    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);
14877
14878    /**
14879     * Delete a previoulsy added state to @p item.
14880     *
14881     * @param item The toolbar item.
14882     * @param state The state to be deleted.
14883     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14884     *
14885     * @see elm_toolbar_item_state_add()
14886     */
14887    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14888
14889    /**
14890     * Set @p state as the current state of @p it.
14891     *
14892     * @param it The item.
14893     * @param state The state to use.
14894     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14895     *
14896     * If @p state is @c NULL, it won't select any state and the default item's
14897     * icon and label will be used. It's the same behaviour than
14898     * elm_toolbar_item_state_unser().
14899     *
14900     * @see elm_toolbar_item_state_unset()
14901     *
14902     * @ingroup Toolbar
14903     */
14904    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14905
14906    /**
14907     * Unset the state of @p it.
14908     *
14909     * @param it The item.
14910     *
14911     * The default icon and label from this item will be displayed.
14912     *
14913     * @see elm_toolbar_item_state_set() for more details.
14914     *
14915     * @ingroup Toolbar
14916     */
14917    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14918
14919    /**
14920     * Get the current state of @p it.
14921     *
14922     * @param item The item.
14923     * @return The selected state or @c NULL if none is selected or on failure.
14924     *
14925     * @see elm_toolbar_item_state_set() for details.
14926     * @see elm_toolbar_item_state_unset()
14927     * @see elm_toolbar_item_state_add()
14928     *
14929     * @ingroup Toolbar
14930     */
14931    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14932
14933    /**
14934     * Get the state after selected state in toolbar's @p item.
14935     *
14936     * @param it The toolbar item to change state.
14937     * @return The state after current state, or @c NULL on failure.
14938     *
14939     * If last state is selected, this function will return first state.
14940     *
14941     * @see elm_toolbar_item_state_set()
14942     * @see elm_toolbar_item_state_add()
14943     *
14944     * @ingroup Toolbar
14945     */
14946    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14947
14948    /**
14949     * Get the state before selected state in toolbar's @p item.
14950     *
14951     * @param it The toolbar item to change state.
14952     * @return The state before current state, or @c NULL on failure.
14953     *
14954     * If first state is selected, this function will return last state.
14955     *
14956     * @see elm_toolbar_item_state_set()
14957     * @see elm_toolbar_item_state_add()
14958     *
14959     * @ingroup Toolbar
14960     */
14961    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14962
14963    /**
14964     * Set the text to be shown in a given toolbar item's tooltips.
14965     *
14966     * @param item Target item.
14967     * @param text The text to set in the content.
14968     *
14969     * Setup the text as tooltip to object. The item can have only one tooltip,
14970     * so any previous tooltip data - set with this function or
14971     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14972     *
14973     * @see elm_object_tooltip_text_set() for more details.
14974     *
14975     * @ingroup Toolbar
14976     */
14977    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14978
14979    /**
14980     * Set the content to be shown in the tooltip item.
14981     *
14982     * Setup the tooltip to item. The item can have only one tooltip,
14983     * so any previous tooltip data is removed. @p func(with @p data) will
14984     * be called every time that need show the tooltip and it should
14985     * return a valid Evas_Object. This object is then managed fully by
14986     * tooltip system and is deleted when the tooltip is gone.
14987     *
14988     * @param item the toolbar item being attached a tooltip.
14989     * @param func the function used to create the tooltip contents.
14990     * @param data what to provide to @a func as callback data/context.
14991     * @param del_cb called when data is not needed anymore, either when
14992     *        another callback replaces @a func, the tooltip is unset with
14993     *        elm_toolbar_item_tooltip_unset() or the owner @a item
14994     *        dies. This callback receives as the first parameter the
14995     *        given @a data, and @c event_info is the item.
14996     *
14997     * @see elm_object_tooltip_content_cb_set() for more details.
14998     *
14999     * @ingroup Toolbar
15000     */
15001    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);
15002
15003    /**
15004     * Unset tooltip from item.
15005     *
15006     * @param item toolbar item to remove previously set tooltip.
15007     *
15008     * Remove tooltip from item. The callback provided as del_cb to
15009     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15010     * it is not used anymore.
15011     *
15012     * @see elm_object_tooltip_unset() for more details.
15013     * @see elm_toolbar_item_tooltip_content_cb_set()
15014     *
15015     * @ingroup Toolbar
15016     */
15017    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15018
15019    /**
15020     * Sets a different style for this item tooltip.
15021     *
15022     * @note before you set a style you should define a tooltip with
15023     *       elm_toolbar_item_tooltip_content_cb_set() or
15024     *       elm_toolbar_item_tooltip_text_set()
15025     *
15026     * @param item toolbar item with tooltip already set.
15027     * @param style the theme style to use (default, transparent, ...)
15028     *
15029     * @see elm_object_tooltip_style_set() for more details.
15030     *
15031     * @ingroup Toolbar
15032     */
15033    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15034
15035    /**
15036     * Get the style for this item tooltip.
15037     *
15038     * @param item toolbar item with tooltip already set.
15039     * @return style the theme style in use, defaults to "default". If the
15040     *         object does not have a tooltip set, then NULL is returned.
15041     *
15042     * @see elm_object_tooltip_style_get() for more details.
15043     * @see elm_toolbar_item_tooltip_style_set()
15044     *
15045     * @ingroup Toolbar
15046     */
15047    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15048
15049    /**
15050     * Set the type of mouse pointer/cursor decoration to be shown,
15051     * when the mouse pointer is over the given toolbar widget item
15052     *
15053     * @param item toolbar item to customize cursor on
15054     * @param cursor the cursor type's name
15055     *
15056     * This function works analogously as elm_object_cursor_set(), but
15057     * here the cursor's changing area is restricted to the item's
15058     * area, and not the whole widget's. Note that that item cursors
15059     * have precedence over widget cursors, so that a mouse over an
15060     * item with custom cursor set will always show @b that cursor.
15061     *
15062     * If this function is called twice for an object, a previously set
15063     * cursor will be unset on the second call.
15064     *
15065     * @see elm_object_cursor_set()
15066     * @see elm_toolbar_item_cursor_get()
15067     * @see elm_toolbar_item_cursor_unset()
15068     *
15069     * @ingroup Toolbar
15070     */
15071    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15072
15073    /*
15074     * Get the type of mouse pointer/cursor decoration set to be shown,
15075     * when the mouse pointer is over the given toolbar widget item
15076     *
15077     * @param item toolbar item with custom cursor set
15078     * @return the cursor type's name or @c NULL, if no custom cursors
15079     * were set to @p item (and on errors)
15080     *
15081     * @see elm_object_cursor_get()
15082     * @see elm_toolbar_item_cursor_set()
15083     * @see elm_toolbar_item_cursor_unset()
15084     *
15085     * @ingroup Toolbar
15086     */
15087    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15088
15089    /**
15090     * Unset any custom mouse pointer/cursor decoration set to be
15091     * shown, when the mouse pointer is over the given toolbar widget
15092     * item, thus making it show the @b default cursor again.
15093     *
15094     * @param item a toolbar item
15095     *
15096     * Use this call to undo any custom settings on this item's cursor
15097     * decoration, bringing it back to defaults (no custom style set).
15098     *
15099     * @see elm_object_cursor_unset()
15100     * @see elm_toolbar_item_cursor_set()
15101     *
15102     * @ingroup Toolbar
15103     */
15104    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15105
15106    /**
15107     * Set a different @b style for a given custom cursor set for a
15108     * toolbar item.
15109     *
15110     * @param item toolbar item with custom cursor set
15111     * @param style the <b>theme style</b> to use (e.g. @c "default",
15112     * @c "transparent", etc)
15113     *
15114     * This function only makes sense when one is using custom mouse
15115     * cursor decorations <b>defined in a theme file</b>, which can have,
15116     * given a cursor name/type, <b>alternate styles</b> on it. It
15117     * works analogously as elm_object_cursor_style_set(), but here
15118     * applyed only to toolbar item objects.
15119     *
15120     * @warning Before you set a cursor style you should have definen a
15121     *       custom cursor previously on the item, with
15122     *       elm_toolbar_item_cursor_set()
15123     *
15124     * @see elm_toolbar_item_cursor_engine_only_set()
15125     * @see elm_toolbar_item_cursor_style_get()
15126     *
15127     * @ingroup Toolbar
15128     */
15129    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15130
15131    /**
15132     * Get the current @b style set for a given toolbar item's custom
15133     * cursor
15134     *
15135     * @param item toolbar item with custom cursor set.
15136     * @return style the cursor style in use. If the object does not
15137     *         have a cursor set, then @c NULL is returned.
15138     *
15139     * @see elm_toolbar_item_cursor_style_set() for more details
15140     *
15141     * @ingroup Toolbar
15142     */
15143    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15144
15145    /**
15146     * Set if the (custom)cursor for a given toolbar item should be
15147     * searched in its theme, also, or should only rely on the
15148     * rendering engine.
15149     *
15150     * @param item item with custom (custom) cursor already set on
15151     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15152     * only on those provided by the rendering engine, @c EINA_FALSE to
15153     * have them searched on the widget's theme, as well.
15154     *
15155     * @note This call is of use only if you've set a custom cursor
15156     * for toolbar items, with elm_toolbar_item_cursor_set().
15157     *
15158     * @note By default, cursors will only be looked for between those
15159     * provided by the rendering engine.
15160     *
15161     * @ingroup Toolbar
15162     */
15163    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15164
15165    /**
15166     * Get if the (custom) cursor for a given toolbar item is being
15167     * searched in its theme, also, or is only relying on the rendering
15168     * engine.
15169     *
15170     * @param item a toolbar item
15171     * @return @c EINA_TRUE, if cursors are being looked for only on
15172     * those provided by the rendering engine, @c EINA_FALSE if they
15173     * are being searched on the widget's theme, as well.
15174     *
15175     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15176     *
15177     * @ingroup Toolbar
15178     */
15179    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15180
15181    /**
15182     * Change a toolbar's orientation
15183     * @param obj The toolbar object
15184     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15185     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15186     * @ingroup Toolbar
15187     */
15188    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15189
15190    /**
15191     * Get a toolbar's orientation
15192     * @param obj The toolbar object
15193     * @return If @c EINA_TRUE, the toolbar is vertical
15194     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15195     * @ingroup Toolbar
15196     */
15197    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15198
15199    /**
15200     * @}
15201     */
15202
15203    /**
15204     * @defgroup Tooltips Tooltips
15205     *
15206     * The Tooltip is an (internal, for now) smart object used to show a
15207     * content in a frame on mouse hover of objects(or widgets), with
15208     * tips/information about them.
15209     *
15210     * @{
15211     */
15212
15213    EAPI double       elm_tooltip_delay_get(void);
15214    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15215    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15216    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15217    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15218    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);
15219    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15220    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15221    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15222    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15223    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15224
15225    /**
15226     * @}
15227     */
15228
15229    /**
15230     * @defgroup Cursors Cursors
15231     *
15232     * The Elementary cursor is an internal smart object used to
15233     * customize the mouse cursor displayed over objects (or
15234     * widgets). In the most common scenario, the cursor decoration
15235     * comes from the graphical @b engine Elementary is running
15236     * on. Those engines may provide different decorations for cursors,
15237     * and Elementary provides functions to choose them (think of X11
15238     * cursors, as an example).
15239     *
15240     * There's also the possibility of, besides using engine provided
15241     * cursors, also use ones coming from Edje theming files. Both
15242     * globally and per widget, Elementary makes it possible for one to
15243     * make the cursors lookup to be held on engines only or on
15244     * Elementary's theme file, too.
15245     *
15246     * @{
15247     */
15248
15249    /**
15250     * Set the cursor to be shown when mouse is over the object
15251     *
15252     * Set the cursor that will be displayed when mouse is over the
15253     * object. The object can have only one cursor set to it, so if
15254     * this function is called twice for an object, the previous set
15255     * will be unset.
15256     * If using X cursors, a definition of all the valid cursor names
15257     * is listed on Elementary_Cursors.h. If an invalid name is set
15258     * the default cursor will be used.
15259     *
15260     * @param obj the object being set a cursor.
15261     * @param cursor the cursor name to be used.
15262     *
15263     * @ingroup Cursors
15264     */
15265    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15266
15267    /**
15268     * Get the cursor to be shown when mouse is over the object
15269     *
15270     * @param obj an object with cursor already set.
15271     * @return the cursor name.
15272     *
15273     * @ingroup Cursors
15274     */
15275    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15276
15277    /**
15278     * Unset cursor for object
15279     *
15280     * Unset cursor for object, and set the cursor to default if the mouse
15281     * was over this object.
15282     *
15283     * @param obj Target object
15284     * @see elm_object_cursor_set()
15285     *
15286     * @ingroup Cursors
15287     */
15288    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15289
15290    /**
15291     * Sets a different style for this object cursor.
15292     *
15293     * @note before you set a style you should define a cursor with
15294     *       elm_object_cursor_set()
15295     *
15296     * @param obj an object with cursor already set.
15297     * @param style the theme style to use (default, transparent, ...)
15298     *
15299     * @ingroup Cursors
15300     */
15301    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15302
15303    /**
15304     * Get the style for this object cursor.
15305     *
15306     * @param obj an object with cursor already set.
15307     * @return style the theme style in use, defaults to "default". If the
15308     *         object does not have a cursor set, then NULL is returned.
15309     *
15310     * @ingroup Cursors
15311     */
15312    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15313
15314    /**
15315     * Set if the cursor set should be searched on the theme or should use
15316     * the provided by the engine, only.
15317     *
15318     * @note before you set if should look on theme you should define a cursor
15319     * with elm_object_cursor_set(). By default it will only look for cursors
15320     * provided by the engine.
15321     *
15322     * @param obj an object with cursor already set.
15323     * @param engine_only boolean to define it cursors should be looked only
15324     * between the provided by the engine or searched on widget's theme as well.
15325     *
15326     * @ingroup Cursors
15327     */
15328    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15329
15330    /**
15331     * Get the cursor engine only usage for this object cursor.
15332     *
15333     * @param obj an object with cursor already set.
15334     * @return engine_only boolean to define it cursors should be
15335     * looked only between the provided by the engine or searched on
15336     * widget's theme as well. If the object does not have a cursor
15337     * set, then EINA_FALSE is returned.
15338     *
15339     * @ingroup Cursors
15340     */
15341    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15342
15343    /**
15344     * Get the configured cursor engine only usage
15345     *
15346     * This gets the globally configured exclusive usage of engine cursors.
15347     *
15348     * @return 1 if only engine cursors should be used
15349     * @ingroup Cursors
15350     */
15351    EAPI int          elm_cursor_engine_only_get(void);
15352
15353    /**
15354     * Set the configured cursor engine only usage
15355     *
15356     * This sets the globally configured exclusive usage of engine cursors.
15357     * It won't affect cursors set before changing this value.
15358     *
15359     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15360     * look for them on theme before.
15361     * @return EINA_TRUE if value is valid and setted (0 or 1)
15362     * @ingroup Cursors
15363     */
15364    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15365
15366    /**
15367     * @}
15368     */
15369
15370    /**
15371     * @defgroup Menu Menu
15372     *
15373     * @image html img/widget/menu/preview-00.png
15374     * @image latex img/widget/menu/preview-00.eps
15375     *
15376     * A menu is a list of items displayed above its parent. When the menu is
15377     * showing its parent is darkened. Each item can have a sub-menu. The menu
15378     * object can be used to display a menu on a right click event, in a toolbar,
15379     * anywhere.
15380     *
15381     * Signals that you can add callbacks for are:
15382     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15383     *             event_info is NULL.
15384     *
15385     * @see @ref tutorial_menu
15386     * @{
15387     */
15388    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15389    /**
15390     * @brief Add a new menu to the parent
15391     *
15392     * @param parent The parent object.
15393     * @return The new object or NULL if it cannot be created.
15394     */
15395    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15396    /**
15397     * @brief Set the parent for the given menu widget
15398     *
15399     * @param obj The menu object.
15400     * @param parent The new parent.
15401     */
15402    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15403    /**
15404     * @brief Get the parent for the given menu widget
15405     *
15406     * @param obj The menu object.
15407     * @return The parent.
15408     *
15409     * @see elm_menu_parent_set()
15410     */
15411    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15412    /**
15413     * @brief Move the menu to a new position
15414     *
15415     * @param obj The menu object.
15416     * @param x The new position.
15417     * @param y The new position.
15418     *
15419     * Sets the top-left position of the menu to (@p x,@p y).
15420     *
15421     * @note @p x and @p y coordinates are relative to parent.
15422     */
15423    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15424    /**
15425     * @brief Close a opened menu
15426     *
15427     * @param obj the menu object
15428     * @return void
15429     *
15430     * Hides the menu and all it's sub-menus.
15431     */
15432    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15433    /**
15434     * @brief Returns a list of @p item's items.
15435     *
15436     * @param obj The menu object
15437     * @return An Eina_List* of @p item's items
15438     */
15439    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15440    /**
15441     * @brief Get the Evas_Object of an Elm_Menu_Item
15442     *
15443     * @param item The menu item object.
15444     * @return The edje object containing the swallowed content
15445     *
15446     * @warning Don't manipulate this object!
15447     */
15448    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15449    /**
15450     * @brief Add an item at the end of the given menu widget
15451     *
15452     * @param obj The menu object.
15453     * @param parent The parent menu item (optional)
15454     * @param icon A icon display on the item. The icon will be destryed by the menu.
15455     * @param label The label of the item.
15456     * @param func Function called when the user select the item.
15457     * @param data Data sent by the callback.
15458     * @return Returns the new item.
15459     */
15460    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);
15461    /**
15462     * @brief Add an object swallowed in an item at the end of the given menu
15463     * widget
15464     *
15465     * @param obj The menu object.
15466     * @param parent The parent menu item (optional)
15467     * @param subobj The object to swallow
15468     * @param func Function called when the user select the item.
15469     * @param data Data sent by the callback.
15470     * @return Returns the new item.
15471     *
15472     * Add an evas object as an item to the menu.
15473     */
15474    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);
15475    /**
15476     * @brief Set the label of a menu item
15477     *
15478     * @param item The menu item object.
15479     * @param label The label to set for @p item
15480     *
15481     * @warning Don't use this funcion on items created with
15482     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15483     */
15484    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15485    /**
15486     * @brief Get the label of a menu item
15487     *
15488     * @param item The menu item object.
15489     * @return The label of @p item
15490     */
15491    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15492    /**
15493     * @brief Set the icon of a menu item to the standard icon with name @p icon
15494     *
15495     * @param item The menu item object.
15496     * @param icon The icon object to set for the content of @p item
15497     *
15498     * Once this icon is set, any previously set icon will be deleted.
15499     */
15500    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15501    /**
15502     * @brief Get the string representation from the icon of a menu item
15503     *
15504     * @param item The menu item object.
15505     * @return The string representation of @p item's icon or NULL
15506     *
15507     * @see elm_menu_item_object_icon_name_set()
15508     */
15509    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15510    /**
15511     * @brief Set the content object of a menu item
15512     *
15513     * @param item The menu item object
15514     * @param The content object or NULL
15515     * @return EINA_TRUE on success, else EINA_FALSE
15516     *
15517     * Use this function to change the object swallowed by a menu item, deleting
15518     * any previously swallowed object.
15519     */
15520    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15521    /**
15522     * @brief Get the content object of a menu item
15523     *
15524     * @param item The menu item object
15525     * @return The content object or NULL
15526     * @note If @p item was added with elm_menu_item_add_object, this
15527     * function will return the object passed, else it will return the
15528     * icon object.
15529     *
15530     * @see elm_menu_item_object_content_set()
15531     */
15532    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15533    /**
15534     * @brief Set the selected state of @p item.
15535     *
15536     * @param item The menu item object.
15537     * @param selected The selected/unselected state of the item
15538     */
15539    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15540    /**
15541     * @brief Get the selected state of @p item.
15542     *
15543     * @param item The menu item object.
15544     * @return The selected/unselected state of the item
15545     *
15546     * @see elm_menu_item_selected_set()
15547     */
15548    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15549    /**
15550     * @brief Set the disabled state of @p item.
15551     *
15552     * @param item The menu item object.
15553     * @param disabled The enabled/disabled state of the item
15554     */
15555    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15556    /**
15557     * @brief Get the disabled state of @p item.
15558     *
15559     * @param item The menu item object.
15560     * @return The enabled/disabled state of the item
15561     *
15562     * @see elm_menu_item_disabled_set()
15563     */
15564    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15565    /**
15566     * @brief Add a separator item to menu @p obj under @p parent.
15567     *
15568     * @param obj The menu object
15569     * @param parent The item to add the separator under
15570     * @return The created item or NULL on failure
15571     *
15572     * This is item is a @ref Separator.
15573     */
15574    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15575    /**
15576     * @brief Returns whether @p item is a separator.
15577     *
15578     * @param item The item to check
15579     * @return If true, @p item is a separator
15580     *
15581     * @see elm_menu_item_separator_add()
15582     */
15583    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15584    /**
15585     * @brief Deletes an item from the menu.
15586     *
15587     * @param item The item to delete.
15588     *
15589     * @see elm_menu_item_add()
15590     */
15591    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15592    /**
15593     * @brief Set the function called when a menu item is deleted.
15594     *
15595     * @param item The item to set the callback on
15596     * @param func The function called
15597     *
15598     * @see elm_menu_item_add()
15599     * @see elm_menu_item_del()
15600     */
15601    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15602    /**
15603     * @brief Returns the data associated with menu item @p item.
15604     *
15605     * @param item The item
15606     * @return The data associated with @p item or NULL if none was set.
15607     *
15608     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15609     */
15610    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15611    /**
15612     * @brief Sets the data to be associated with menu item @p item.
15613     *
15614     * @param item The item
15615     * @param data The data to be associated with @p item
15616     */
15617    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15618    /**
15619     * @brief Returns a list of @p item's subitems.
15620     *
15621     * @param item The item
15622     * @return An Eina_List* of @p item's subitems
15623     *
15624     * @see elm_menu_add()
15625     */
15626    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15627    /**
15628     * @brief Get the position of a menu item
15629     *
15630     * @param item The menu item
15631     * @return The item's index
15632     *
15633     * This function returns the index position of a menu item in a menu.
15634     * For a sub-menu, this number is relative to the first item in the sub-menu.
15635     *
15636     * @note Index values begin with 0
15637     */
15638    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15639    /**
15640     * @brief @brief Return a menu item's owner menu
15641     *
15642     * @param item The menu item
15643     * @return The menu object owning @p item, or NULL on failure
15644     *
15645     * Use this function to get the menu object owning an item.
15646     */
15647    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15648    /**
15649     * @brief Get the selected item in the menu
15650     *
15651     * @param obj The menu object
15652     * @return The selected item, or NULL if none
15653     *
15654     * @see elm_menu_item_selected_get()
15655     * @see elm_menu_item_selected_set()
15656     */
15657    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15658    /**
15659     * @brief Get the last item in the menu
15660     *
15661     * @param obj The menu object
15662     * @return The last item, or NULL if none
15663     */
15664    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15665    /**
15666     * @brief Get the first item in the menu
15667     *
15668     * @param obj The menu object
15669     * @return The first item, or NULL if none
15670     */
15671    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15672    /**
15673     * @brief Get the next item in the menu.
15674     *
15675     * @param item The menu item object.
15676     * @return The item after it, or NULL if none
15677     */
15678    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15679    /**
15680     * @brief Get the previous item in the menu.
15681     *
15682     * @param item The menu item object.
15683     * @return The item before it, or NULL if none
15684     */
15685    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15686    /**
15687     * @}
15688     */
15689
15690    /**
15691     * @defgroup List List
15692     * @ingroup Elementary
15693     *
15694     * @image html img/widget/list/preview-00.png
15695     * @image latex img/widget/list/preview-00.eps width=\textwidth
15696     *
15697     * @image html img/list.png
15698     * @image latex img/list.eps width=\textwidth
15699     *
15700     * A list widget is a container whose children are displayed vertically or
15701     * horizontally, in order, and can be selected.
15702     * The list can accept only one or multiple items selection. Also has many
15703     * modes of items displaying.
15704     *
15705     * A list is a very simple type of list widget.  For more robust
15706     * lists, @ref Genlist should probably be used.
15707     *
15708     * Smart callbacks one can listen to:
15709     * - @c "activated" - The user has double-clicked or pressed
15710     *   (enter|return|spacebar) on an item. The @c event_info parameter
15711     *   is the item that was activated.
15712     * - @c "clicked,double" - The user has double-clicked an item.
15713     *   The @c event_info parameter is the item that was double-clicked.
15714     * - "selected" - when the user selected an item
15715     * - "unselected" - when the user unselected an item
15716     * - "longpressed" - an item in the list is long-pressed
15717     * - "scroll,edge,top" - the list is scrolled until the top edge
15718     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
15719     * - "scroll,edge,left" - the list is scrolled until the left edge
15720     * - "scroll,edge,right" - the list is scrolled until the right edge
15721     *
15722     * Available styles for it:
15723     * - @c "default"
15724     *
15725     * List of examples:
15726     * @li @ref list_example_01
15727     * @li @ref list_example_02
15728     * @li @ref list_example_03
15729     */
15730
15731    /**
15732     * @addtogroup List
15733     * @{
15734     */
15735
15736    /**
15737     * @enum _Elm_List_Mode
15738     * @typedef Elm_List_Mode
15739     *
15740     * Set list's resize behavior, transverse axis scroll and
15741     * items cropping. See each mode's description for more details.
15742     *
15743     * @note Default value is #ELM_LIST_SCROLL.
15744     *
15745     * Values <b> don't </b> work as bitmask, only one can be choosen.
15746     *
15747     * @see elm_list_mode_set()
15748     * @see elm_list_mode_get()
15749     *
15750     * @ingroup List
15751     */
15752    typedef enum _Elm_List_Mode
15753      {
15754         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. */
15755         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). */
15756         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. */
15757         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. */
15758         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15759      } Elm_List_Mode;
15760
15761    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().  */
15762
15763    /**
15764     * Add a new list widget to the given parent Elementary
15765     * (container) object.
15766     *
15767     * @param parent The parent object.
15768     * @return a new list widget handle or @c NULL, on errors.
15769     *
15770     * This function inserts a new list widget on the canvas.
15771     *
15772     * @ingroup List
15773     */
15774    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15775
15776    /**
15777     * Starts the list.
15778     *
15779     * @param obj The list object
15780     *
15781     * @note Call before running show() on the list object.
15782     * @warning If not called, it won't display the list properly.
15783     *
15784     * @code
15785     * li = elm_list_add(win);
15786     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15787     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15788     * elm_list_go(li);
15789     * evas_object_show(li);
15790     * @endcode
15791     *
15792     * @ingroup List
15793     */
15794    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15795
15796    /**
15797     * Enable or disable multiple items selection on the list object.
15798     *
15799     * @param obj The list object
15800     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15801     * disable it.
15802     *
15803     * Disabled by default. If disabled, the user can select a single item of
15804     * the list each time. Selected items are highlighted on list.
15805     * If enabled, many items can be selected.
15806     *
15807     * If a selected item is selected again, it will be unselected.
15808     *
15809     * @see elm_list_multi_select_get()
15810     *
15811     * @ingroup List
15812     */
15813    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15814
15815    /**
15816     * Get a value whether multiple items selection is enabled or not.
15817     *
15818     * @see elm_list_multi_select_set() for details.
15819     *
15820     * @param obj The list object.
15821     * @return @c EINA_TRUE means multiple items selection is enabled.
15822     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15823     * @c EINA_FALSE is returned.
15824     *
15825     * @ingroup List
15826     */
15827    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15828
15829    /**
15830     * Set which mode to use for the list object.
15831     *
15832     * @param obj The list object
15833     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15834     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15835     *
15836     * Set list's resize behavior, transverse axis scroll and
15837     * items cropping. See each mode's description for more details.
15838     *
15839     * @note Default value is #ELM_LIST_SCROLL.
15840     *
15841     * Only one can be set, if a previous one was set, it will be changed
15842     * by the new mode set. Bitmask won't work as well.
15843     *
15844     * @see elm_list_mode_get()
15845     *
15846     * @ingroup List
15847     */
15848    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15849
15850    /**
15851     * Get the mode the list is at.
15852     *
15853     * @param obj The list object
15854     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15855     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15856     *
15857     * @note see elm_list_mode_set() for more information.
15858     *
15859     * @ingroup List
15860     */
15861    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15862
15863    /**
15864     * Enable or disable horizontal mode on the list object.
15865     *
15866     * @param obj The list object.
15867     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15868     * disable it, i.e., to enable vertical mode.
15869     *
15870     * @note Vertical mode is set by default.
15871     *
15872     * On horizontal mode items are displayed on list from left to right,
15873     * instead of from top to bottom. Also, the list will scroll horizontally.
15874     * Each item will presents left icon on top and right icon, or end, at
15875     * the bottom.
15876     *
15877     * @see elm_list_horizontal_get()
15878     *
15879     * @ingroup List
15880     */
15881    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15882
15883    /**
15884     * Get a value whether horizontal mode is enabled or not.
15885     *
15886     * @param obj The list object.
15887     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15888     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15889     * @c EINA_FALSE is returned.
15890     *
15891     * @see elm_list_horizontal_set() for details.
15892     *
15893     * @ingroup List
15894     */
15895    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15896
15897    /**
15898     * Enable or disable always select mode on the list object.
15899     *
15900     * @param obj The list object
15901     * @param always_select @c EINA_TRUE to enable always select mode or
15902     * @c EINA_FALSE to disable it.
15903     *
15904     * @note Always select mode is disabled by default.
15905     *
15906     * Default behavior of list items is to only call its callback function
15907     * the first time it's pressed, i.e., when it is selected. If a selected
15908     * item is pressed again, and multi-select is disabled, it won't call
15909     * this function (if multi-select is enabled it will unselect the item).
15910     *
15911     * If always select is enabled, it will call the callback function
15912     * everytime a item is pressed, so it will call when the item is selected,
15913     * and again when a selected item is pressed.
15914     *
15915     * @see elm_list_always_select_mode_get()
15916     * @see elm_list_multi_select_set()
15917     *
15918     * @ingroup List
15919     */
15920    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15921
15922    /**
15923     * Get a value whether always select mode is enabled or not, meaning that
15924     * an item will always call its callback function, even if already selected.
15925     *
15926     * @param obj The list object
15927     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15928     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15929     * @c EINA_FALSE is returned.
15930     *
15931     * @see elm_list_always_select_mode_set() for details.
15932     *
15933     * @ingroup List
15934     */
15935    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15936
15937    /**
15938     * Set bouncing behaviour when the scrolled content reaches an edge.
15939     *
15940     * Tell the internal scroller object whether it should bounce or not
15941     * when it reaches the respective edges for each axis.
15942     *
15943     * @param obj The list object
15944     * @param h_bounce Whether to bounce or not in the horizontal axis.
15945     * @param v_bounce Whether to bounce or not in the vertical axis.
15946     *
15947     * @see elm_scroller_bounce_set()
15948     *
15949     * @ingroup List
15950     */
15951    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15952
15953    /**
15954     * Get the bouncing behaviour of the internal scroller.
15955     *
15956     * Get whether the internal scroller should bounce when the edge of each
15957     * axis is reached scrolling.
15958     *
15959     * @param obj The list object.
15960     * @param h_bounce Pointer where to store the bounce state of the horizontal
15961     * axis.
15962     * @param v_bounce Pointer where to store the bounce state of the vertical
15963     * axis.
15964     *
15965     * @see elm_scroller_bounce_get()
15966     * @see elm_list_bounce_set()
15967     *
15968     * @ingroup List
15969     */
15970    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15971
15972    /**
15973     * Set the scrollbar policy.
15974     *
15975     * @param obj The list object
15976     * @param policy_h Horizontal scrollbar policy.
15977     * @param policy_v Vertical scrollbar policy.
15978     *
15979     * This sets the scrollbar visibility policy for the given scroller.
15980     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15981     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15982     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15983     * This applies respectively for the horizontal and vertical scrollbars.
15984     *
15985     * The both are disabled by default, i.e., are set to
15986     * #ELM_SCROLLER_POLICY_OFF.
15987     *
15988     * @ingroup List
15989     */
15990    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15991
15992    /**
15993     * Get the scrollbar policy.
15994     *
15995     * @see elm_list_scroller_policy_get() for details.
15996     *
15997     * @param obj The list object.
15998     * @param policy_h Pointer where to store horizontal scrollbar policy.
15999     * @param policy_v Pointer where to store vertical scrollbar policy.
16000     *
16001     * @ingroup List
16002     */
16003    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);
16004
16005    /**
16006     * Append a new item to the list object.
16007     *
16008     * @param obj The list object.
16009     * @param label The label of the list item.
16010     * @param icon The icon object to use for the left side of the item. An
16011     * icon can be any Evas object, but usually it is an icon created
16012     * with elm_icon_add().
16013     * @param end The icon object to use for the right side of the item. An
16014     * icon can be any Evas object.
16015     * @param func The function to call when the item is clicked.
16016     * @param data The data to associate with the item for related callbacks.
16017     *
16018     * @return The created item or @c NULL upon failure.
16019     *
16020     * A new item will be created and appended to the list, i.e., will
16021     * be set as @b last item.
16022     *
16023     * Items created with this method can be deleted with
16024     * elm_list_item_del().
16025     *
16026     * Associated @p data can be properly freed when item is deleted if a
16027     * callback function is set with elm_list_item_del_cb_set().
16028     *
16029     * If a function is passed as argument, it will be called everytime this item
16030     * is selected, i.e., the user clicks over an unselected item.
16031     * If always select is enabled it will call this function every time
16032     * user clicks over an item (already selected or not).
16033     * If such function isn't needed, just passing
16034     * @c NULL as @p func is enough. The same should be done for @p data.
16035     *
16036     * Simple example (with no function callback or data associated):
16037     * @code
16038     * li = elm_list_add(win);
16039     * ic = elm_icon_add(win);
16040     * elm_icon_file_set(ic, "path/to/image", NULL);
16041     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16042     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16043     * elm_list_go(li);
16044     * evas_object_show(li);
16045     * @endcode
16046     *
16047     * @see elm_list_always_select_mode_set()
16048     * @see elm_list_item_del()
16049     * @see elm_list_item_del_cb_set()
16050     * @see elm_list_clear()
16051     * @see elm_icon_add()
16052     *
16053     * @ingroup List
16054     */
16055    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);
16056
16057    /**
16058     * Prepend a new item to the list object.
16059     *
16060     * @param obj The list object.
16061     * @param label The label of the list item.
16062     * @param icon The icon object to use for the left side of the item. An
16063     * icon can be any Evas object, but usually it is an icon created
16064     * with elm_icon_add().
16065     * @param end The icon object to use for the right side of the item. An
16066     * icon can be any Evas object.
16067     * @param func The function to call when the item is clicked.
16068     * @param data The data to associate with the item for related callbacks.
16069     *
16070     * @return The created item or @c NULL upon failure.
16071     *
16072     * A new item will be created and prepended to the list, i.e., will
16073     * be set as @b first item.
16074     *
16075     * Items created with this method can be deleted with
16076     * elm_list_item_del().
16077     *
16078     * Associated @p data can be properly freed when item is deleted if a
16079     * callback function is set with elm_list_item_del_cb_set().
16080     *
16081     * If a function is passed as argument, it will be called everytime this item
16082     * is selected, i.e., the user clicks over an unselected item.
16083     * If always select is enabled it will call this function every time
16084     * user clicks over an item (already selected or not).
16085     * If such function isn't needed, just passing
16086     * @c NULL as @p func is enough. The same should be done for @p data.
16087     *
16088     * @see elm_list_item_append() for a simple code example.
16089     * @see elm_list_always_select_mode_set()
16090     * @see elm_list_item_del()
16091     * @see elm_list_item_del_cb_set()
16092     * @see elm_list_clear()
16093     * @see elm_icon_add()
16094     *
16095     * @ingroup List
16096     */
16097    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);
16098
16099    /**
16100     * Insert a new item into the list object before item @p before.
16101     *
16102     * @param obj The list object.
16103     * @param before The list item to insert before.
16104     * @param label The label of the list item.
16105     * @param icon The icon object to use for the left side of the item. An
16106     * icon can be any Evas object, but usually it is an icon created
16107     * with elm_icon_add().
16108     * @param end The icon object to use for the right side of the item. An
16109     * icon can be any Evas object.
16110     * @param func The function to call when the item is clicked.
16111     * @param data The data to associate with the item for related callbacks.
16112     *
16113     * @return The created item or @c NULL upon failure.
16114     *
16115     * A new item will be created and added to the list. Its position in
16116     * this list will be just before item @p before.
16117     *
16118     * Items created with this method can be deleted with
16119     * elm_list_item_del().
16120     *
16121     * Associated @p data can be properly freed when item is deleted if a
16122     * callback function is set with elm_list_item_del_cb_set().
16123     *
16124     * If a function is passed as argument, it will be called everytime this item
16125     * is selected, i.e., the user clicks over an unselected item.
16126     * If always select is enabled it will call this function every time
16127     * user clicks over an item (already selected or not).
16128     * If such function isn't needed, just passing
16129     * @c NULL as @p func is enough. The same should be done for @p data.
16130     *
16131     * @see elm_list_item_append() for a simple code example.
16132     * @see elm_list_always_select_mode_set()
16133     * @see elm_list_item_del()
16134     * @see elm_list_item_del_cb_set()
16135     * @see elm_list_clear()
16136     * @see elm_icon_add()
16137     *
16138     * @ingroup List
16139     */
16140    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);
16141
16142    /**
16143     * Insert a new item into the list object after item @p after.
16144     *
16145     * @param obj The list object.
16146     * @param after The list item to insert after.
16147     * @param label The label of the list item.
16148     * @param icon The icon object to use for the left side of the item. An
16149     * icon can be any Evas object, but usually it is an icon created
16150     * with elm_icon_add().
16151     * @param end The icon object to use for the right side of the item. An
16152     * icon can be any Evas object.
16153     * @param func The function to call when the item is clicked.
16154     * @param data The data to associate with the item for related callbacks.
16155     *
16156     * @return The created item or @c NULL upon failure.
16157     *
16158     * A new item will be created and added to the list. Its position in
16159     * this list will be just after item @p after.
16160     *
16161     * Items created with this method can be deleted with
16162     * elm_list_item_del().
16163     *
16164     * Associated @p data can be properly freed when item is deleted if a
16165     * callback function is set with elm_list_item_del_cb_set().
16166     *
16167     * If a function is passed as argument, it will be called everytime this item
16168     * is selected, i.e., the user clicks over an unselected item.
16169     * If always select is enabled it will call this function every time
16170     * user clicks over an item (already selected or not).
16171     * If such function isn't needed, just passing
16172     * @c NULL as @p func is enough. The same should be done for @p data.
16173     *
16174     * @see elm_list_item_append() for a simple code example.
16175     * @see elm_list_always_select_mode_set()
16176     * @see elm_list_item_del()
16177     * @see elm_list_item_del_cb_set()
16178     * @see elm_list_clear()
16179     * @see elm_icon_add()
16180     *
16181     * @ingroup List
16182     */
16183    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);
16184
16185    /**
16186     * Insert a new item into the sorted list object.
16187     *
16188     * @param obj The list object.
16189     * @param label The label of the list item.
16190     * @param icon The icon object to use for the left side of the item. An
16191     * icon can be any Evas object, but usually it is an icon created
16192     * with elm_icon_add().
16193     * @param end The icon object to use for the right side of the item. An
16194     * icon can be any Evas object.
16195     * @param func The function to call when the item is clicked.
16196     * @param data The data to associate with the item for related callbacks.
16197     * @param cmp_func The comparing function to be used to sort list
16198     * items <b>by #Elm_List_Item item handles</b>. This function will
16199     * receive two items and compare them, returning a non-negative integer
16200     * if the second item should be place after the first, or negative value
16201     * if should be placed before.
16202     *
16203     * @return The created item or @c NULL upon failure.
16204     *
16205     * @note This function inserts values into a list object assuming it was
16206     * sorted and the result will be sorted.
16207     *
16208     * A new item will be created and added to the list. Its position in
16209     * this list will be found comparing the new item with previously inserted
16210     * items using function @p cmp_func.
16211     *
16212     * Items created with this method can be deleted with
16213     * elm_list_item_del().
16214     *
16215     * Associated @p data can be properly freed when item is deleted if a
16216     * callback function is set with elm_list_item_del_cb_set().
16217     *
16218     * If a function is passed as argument, it will be called everytime this item
16219     * is selected, i.e., the user clicks over an unselected item.
16220     * If always select is enabled it will call this function every time
16221     * user clicks over an item (already selected or not).
16222     * If such function isn't needed, just passing
16223     * @c NULL as @p func is enough. The same should be done for @p data.
16224     *
16225     * @see elm_list_item_append() for a simple code example.
16226     * @see elm_list_always_select_mode_set()
16227     * @see elm_list_item_del()
16228     * @see elm_list_item_del_cb_set()
16229     * @see elm_list_clear()
16230     * @see elm_icon_add()
16231     *
16232     * @ingroup List
16233     */
16234    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);
16235
16236    /**
16237     * Remove all list's items.
16238     *
16239     * @param obj The list object
16240     *
16241     * @see elm_list_item_del()
16242     * @see elm_list_item_append()
16243     *
16244     * @ingroup List
16245     */
16246    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16247
16248    /**
16249     * Get a list of all the list items.
16250     *
16251     * @param obj The list object
16252     * @return An @c Eina_List of list items, #Elm_List_Item,
16253     * or @c NULL on failure.
16254     *
16255     * @see elm_list_item_append()
16256     * @see elm_list_item_del()
16257     * @see elm_list_clear()
16258     *
16259     * @ingroup List
16260     */
16261    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16262
16263    /**
16264     * Get the selected item.
16265     *
16266     * @param obj The list object.
16267     * @return The selected list item.
16268     *
16269     * The selected item can be unselected with function
16270     * elm_list_item_selected_set().
16271     *
16272     * The selected item always will be highlighted on list.
16273     *
16274     * @see elm_list_selected_items_get()
16275     *
16276     * @ingroup List
16277     */
16278    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16279
16280    /**
16281     * Return a list of the currently selected list items.
16282     *
16283     * @param obj The list object.
16284     * @return An @c Eina_List of list items, #Elm_List_Item,
16285     * or @c NULL on failure.
16286     *
16287     * Multiple items can be selected if multi select is enabled. It can be
16288     * done with elm_list_multi_select_set().
16289     *
16290     * @see elm_list_selected_item_get()
16291     * @see elm_list_multi_select_set()
16292     *
16293     * @ingroup List
16294     */
16295    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16296
16297    /**
16298     * Set the selected state of an item.
16299     *
16300     * @param item The list item
16301     * @param selected The selected state
16302     *
16303     * This sets the selected state of the given item @p it.
16304     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16305     *
16306     * If a new item is selected the previosly selected will be unselected,
16307     * unless multiple selection is enabled with elm_list_multi_select_set().
16308     * Previoulsy selected item can be get with function
16309     * elm_list_selected_item_get().
16310     *
16311     * Selected items will be highlighted.
16312     *
16313     * @see elm_list_item_selected_get()
16314     * @see elm_list_selected_item_get()
16315     * @see elm_list_multi_select_set()
16316     *
16317     * @ingroup List
16318     */
16319    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16320
16321    /*
16322     * Get whether the @p item is selected or not.
16323     *
16324     * @param item The list item.
16325     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16326     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16327     *
16328     * @see elm_list_selected_item_set() for details.
16329     * @see elm_list_item_selected_get()
16330     *
16331     * @ingroup List
16332     */
16333    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16334
16335    /**
16336     * Set or unset item as a separator.
16337     *
16338     * @param it The list item.
16339     * @param setting @c EINA_TRUE to set item @p it as separator or
16340     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16341     *
16342     * Items aren't set as separator by default.
16343     *
16344     * If set as separator it will display separator theme, so won't display
16345     * icons or label.
16346     *
16347     * @see elm_list_item_separator_get()
16348     *
16349     * @ingroup List
16350     */
16351    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16352
16353    /**
16354     * Get a value whether item is a separator or not.
16355     *
16356     * @see elm_list_item_separator_set() for details.
16357     *
16358     * @param it The list item.
16359     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16360     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16361     *
16362     * @ingroup List
16363     */
16364    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16365
16366    /**
16367     * Show @p item in the list view.
16368     *
16369     * @param item The list item to be shown.
16370     *
16371     * It won't animate list until item is visible. If such behavior is wanted,
16372     * use elm_list_bring_in() intead.
16373     *
16374     * @ingroup List
16375     */
16376    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16377
16378    /**
16379     * Bring in the given item to list view.
16380     *
16381     * @param item The item.
16382     *
16383     * This causes list to jump to the given item @p item and show it
16384     * (by scrolling), if it is not fully visible.
16385     *
16386     * This may use animation to do so and take a period of time.
16387     *
16388     * If animation isn't wanted, elm_list_item_show() can be used.
16389     *
16390     * @ingroup List
16391     */
16392    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16393
16394    /**
16395     * Delete them item from the list.
16396     *
16397     * @param item The item of list to be deleted.
16398     *
16399     * If deleting all list items is required, elm_list_clear()
16400     * should be used instead of getting items list and deleting each one.
16401     *
16402     * @see elm_list_clear()
16403     * @see elm_list_item_append()
16404     * @see elm_list_item_del_cb_set()
16405     *
16406     * @ingroup List
16407     */
16408    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16409
16410    /**
16411     * Set the function called when a list item is freed.
16412     *
16413     * @param item The item to set the callback on
16414     * @param func The function called
16415     *
16416     * If there is a @p func, then it will be called prior item's memory release.
16417     * That will be called with the following arguments:
16418     * @li item's data;
16419     * @li item's Evas object;
16420     * @li item itself;
16421     *
16422     * This way, a data associated to a list item could be properly freed.
16423     *
16424     * @ingroup List
16425     */
16426    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16427
16428    /**
16429     * Get the data associated to the item.
16430     *
16431     * @param item The list item
16432     * @return The data associated to @p item
16433     *
16434     * The return value is a pointer to data associated to @p item when it was
16435     * created, with function elm_list_item_append() or similar. If no data
16436     * was passed as argument, it will return @c NULL.
16437     *
16438     * @see elm_list_item_append()
16439     *
16440     * @ingroup List
16441     */
16442    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16443
16444    /**
16445     * Get the left side icon associated to the item.
16446     *
16447     * @param item The list item
16448     * @return The left side icon associated to @p item
16449     *
16450     * The return value is a pointer to the icon associated to @p item when
16451     * it was
16452     * created, with function elm_list_item_append() or similar, or later
16453     * with function elm_list_item_icon_set(). If no icon
16454     * was passed as argument, it will return @c NULL.
16455     *
16456     * @see elm_list_item_append()
16457     * @see elm_list_item_icon_set()
16458     *
16459     * @ingroup List
16460     */
16461    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16462
16463    /**
16464     * Set the left side icon associated to the item.
16465     *
16466     * @param item The list item
16467     * @param icon The left side icon object to associate with @p item
16468     *
16469     * The icon object to use at left side of the item. An
16470     * icon can be any Evas object, but usually it is an icon created
16471     * with elm_icon_add().
16472     *
16473     * Once the icon object is set, a previously set one will be deleted.
16474     * @warning Setting the same icon for two items will cause the icon to
16475     * dissapear from the first item.
16476     *
16477     * If an icon was passed as argument on item creation, with function
16478     * elm_list_item_append() or similar, it will be already
16479     * associated to the item.
16480     *
16481     * @see elm_list_item_append()
16482     * @see elm_list_item_icon_get()
16483     *
16484     * @ingroup List
16485     */
16486    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16487
16488    /**
16489     * Get the right side icon associated to the item.
16490     *
16491     * @param item The list item
16492     * @return The right side icon associated to @p item
16493     *
16494     * The return value is a pointer to the icon associated to @p item when
16495     * it was
16496     * created, with function elm_list_item_append() or similar, or later
16497     * with function elm_list_item_icon_set(). If no icon
16498     * was passed as argument, it will return @c NULL.
16499     *
16500     * @see elm_list_item_append()
16501     * @see elm_list_item_icon_set()
16502     *
16503     * @ingroup List
16504     */
16505    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16506
16507    /**
16508     * Set the right side icon associated to the item.
16509     *
16510     * @param item The list item
16511     * @param end The right side icon object to associate with @p item
16512     *
16513     * The icon object to use at right side of the item. An
16514     * icon can be any Evas object, but usually it is an icon created
16515     * with elm_icon_add().
16516     *
16517     * Once the icon object is set, a previously set one will be deleted.
16518     * @warning Setting the same icon for two items will cause the icon to
16519     * dissapear from the first item.
16520     *
16521     * If an icon was passed as argument on item creation, with function
16522     * elm_list_item_append() or similar, it will be already
16523     * associated to the item.
16524     *
16525     * @see elm_list_item_append()
16526     * @see elm_list_item_end_get()
16527     *
16528     * @ingroup List
16529     */
16530    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16531
16532    /**
16533     * Gets the base object of the item.
16534     *
16535     * @param item The list item
16536     * @return The base object associated with @p item
16537     *
16538     * Base object is the @c Evas_Object that represents that item.
16539     *
16540     * @ingroup List
16541     */
16542    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16543    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16544
16545    /**
16546     * Get the label of item.
16547     *
16548     * @param item The item of list.
16549     * @return The label of item.
16550     *
16551     * The return value is a pointer to the label associated to @p item when
16552     * it was created, with function elm_list_item_append(), or later
16553     * with function elm_list_item_label_set. If no label
16554     * was passed as argument, it will return @c NULL.
16555     *
16556     * @see elm_list_item_label_set() for more details.
16557     * @see elm_list_item_append()
16558     *
16559     * @ingroup List
16560     */
16561    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16562
16563    /**
16564     * Set the label of item.
16565     *
16566     * @param item The item of list.
16567     * @param text The label of item.
16568     *
16569     * The label to be displayed by the item.
16570     * Label will be placed between left and right side icons (if set).
16571     *
16572     * If a label was passed as argument on item creation, with function
16573     * elm_list_item_append() or similar, it will be already
16574     * displayed by the item.
16575     *
16576     * @see elm_list_item_label_get()
16577     * @see elm_list_item_append()
16578     *
16579     * @ingroup List
16580     */
16581    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16582
16583
16584    /**
16585     * Get the item before @p it in list.
16586     *
16587     * @param it The list item.
16588     * @return The item before @p it, or @c NULL if none or on failure.
16589     *
16590     * @note If it is the first item, @c NULL will be returned.
16591     *
16592     * @see elm_list_item_append()
16593     * @see elm_list_items_get()
16594     *
16595     * @ingroup List
16596     */
16597    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16598
16599    /**
16600     * Get the item after @p it in list.
16601     *
16602     * @param it The list item.
16603     * @return The item after @p it, or @c NULL if none or on failure.
16604     *
16605     * @note If it is the last item, @c NULL will be returned.
16606     *
16607     * @see elm_list_item_append()
16608     * @see elm_list_items_get()
16609     *
16610     * @ingroup List
16611     */
16612    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16613
16614    /**
16615     * Sets the disabled/enabled state of a list item.
16616     *
16617     * @param it The item.
16618     * @param disabled The disabled state.
16619     *
16620     * A disabled item cannot be selected or unselected. It will also
16621     * change its appearance (generally greyed out). This sets the
16622     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16623     * enabled).
16624     *
16625     * @ingroup List
16626     */
16627    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16628
16629    /**
16630     * Get a value whether list item is disabled or not.
16631     *
16632     * @param it The item.
16633     * @return The disabled state.
16634     *
16635     * @see elm_list_item_disabled_set() for more details.
16636     *
16637     * @ingroup List
16638     */
16639    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16640
16641    /**
16642     * Set the text to be shown in a given list item's tooltips.
16643     *
16644     * @param item Target item.
16645     * @param text The text to set in the content.
16646     *
16647     * Setup the text as tooltip to object. The item can have only one tooltip,
16648     * so any previous tooltip data - set with this function or
16649     * elm_list_item_tooltip_content_cb_set() - is removed.
16650     *
16651     * @see elm_object_tooltip_text_set() for more details.
16652     *
16653     * @ingroup List
16654     */
16655    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16656
16657
16658    /**
16659     * @brief Disable size restrictions on an object's tooltip
16660     * @param item The tooltip's anchor object
16661     * @param disable If EINA_TRUE, size restrictions are disabled
16662     * @return EINA_FALSE on failure, EINA_TRUE on success
16663     *
16664     * This function allows a tooltip to expand beyond its parant window's canvas.
16665     * It will instead be limited only by the size of the display.
16666     */
16667    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16668    /**
16669     * @brief Retrieve size restriction state of an object's tooltip
16670     * @param obj The tooltip's anchor object
16671     * @return If EINA_TRUE, size restrictions are disabled
16672     *
16673     * This function returns whether a tooltip is allowed to expand beyond
16674     * its parant window's canvas.
16675     * It will instead be limited only by the size of the display.
16676     */
16677    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16678
16679    /**
16680     * Set the content to be shown in the tooltip item.
16681     *
16682     * Setup the tooltip to item. The item can have only one tooltip,
16683     * so any previous tooltip data is removed. @p func(with @p data) will
16684     * be called every time that need show the tooltip and it should
16685     * return a valid Evas_Object. This object is then managed fully by
16686     * tooltip system and is deleted when the tooltip is gone.
16687     *
16688     * @param item the list item being attached a tooltip.
16689     * @param func the function used to create the tooltip contents.
16690     * @param data what to provide to @a func as callback data/context.
16691     * @param del_cb called when data is not needed anymore, either when
16692     *        another callback replaces @a func, the tooltip is unset with
16693     *        elm_list_item_tooltip_unset() or the owner @a item
16694     *        dies. This callback receives as the first parameter the
16695     *        given @a data, and @c event_info is the item.
16696     *
16697     * @see elm_object_tooltip_content_cb_set() for more details.
16698     *
16699     * @ingroup List
16700     */
16701    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);
16702
16703    /**
16704     * Unset tooltip from item.
16705     *
16706     * @param item list item to remove previously set tooltip.
16707     *
16708     * Remove tooltip from item. The callback provided as del_cb to
16709     * elm_list_item_tooltip_content_cb_set() will be called to notify
16710     * it is not used anymore.
16711     *
16712     * @see elm_object_tooltip_unset() for more details.
16713     * @see elm_list_item_tooltip_content_cb_set()
16714     *
16715     * @ingroup List
16716     */
16717    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16718
16719    /**
16720     * Sets a different style for this item tooltip.
16721     *
16722     * @note before you set a style you should define a tooltip with
16723     *       elm_list_item_tooltip_content_cb_set() or
16724     *       elm_list_item_tooltip_text_set()
16725     *
16726     * @param item list item with tooltip already set.
16727     * @param style the theme style to use (default, transparent, ...)
16728     *
16729     * @see elm_object_tooltip_style_set() for more details.
16730     *
16731     * @ingroup List
16732     */
16733    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16734
16735    /**
16736     * Get the style for this item tooltip.
16737     *
16738     * @param item list item with tooltip already set.
16739     * @return style the theme style in use, defaults to "default". If the
16740     *         object does not have a tooltip set, then NULL is returned.
16741     *
16742     * @see elm_object_tooltip_style_get() for more details.
16743     * @see elm_list_item_tooltip_style_set()
16744     *
16745     * @ingroup List
16746     */
16747    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16748
16749    /**
16750     * Set the type of mouse pointer/cursor decoration to be shown,
16751     * when the mouse pointer is over the given list widget item
16752     *
16753     * @param item list item to customize cursor on
16754     * @param cursor the cursor type's name
16755     *
16756     * This function works analogously as elm_object_cursor_set(), but
16757     * here the cursor's changing area is restricted to the item's
16758     * area, and not the whole widget's. Note that that item cursors
16759     * have precedence over widget cursors, so that a mouse over an
16760     * item with custom cursor set will always show @b that cursor.
16761     *
16762     * If this function is called twice for an object, a previously set
16763     * cursor will be unset on the second call.
16764     *
16765     * @see elm_object_cursor_set()
16766     * @see elm_list_item_cursor_get()
16767     * @see elm_list_item_cursor_unset()
16768     *
16769     * @ingroup List
16770     */
16771    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16772
16773    /*
16774     * Get the type of mouse pointer/cursor decoration set to be shown,
16775     * when the mouse pointer is over the given list widget item
16776     *
16777     * @param item list item with custom cursor set
16778     * @return the cursor type's name or @c NULL, if no custom cursors
16779     * were set to @p item (and on errors)
16780     *
16781     * @see elm_object_cursor_get()
16782     * @see elm_list_item_cursor_set()
16783     * @see elm_list_item_cursor_unset()
16784     *
16785     * @ingroup List
16786     */
16787    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16788
16789    /**
16790     * Unset any custom mouse pointer/cursor decoration set to be
16791     * shown, when the mouse pointer is over the given list widget
16792     * item, thus making it show the @b default cursor again.
16793     *
16794     * @param item a list item
16795     *
16796     * Use this call to undo any custom settings on this item's cursor
16797     * decoration, bringing it back to defaults (no custom style set).
16798     *
16799     * @see elm_object_cursor_unset()
16800     * @see elm_list_item_cursor_set()
16801     *
16802     * @ingroup List
16803     */
16804    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16805
16806    /**
16807     * Set a different @b style for a given custom cursor set for a
16808     * list item.
16809     *
16810     * @param item list item with custom cursor set
16811     * @param style the <b>theme style</b> to use (e.g. @c "default",
16812     * @c "transparent", etc)
16813     *
16814     * This function only makes sense when one is using custom mouse
16815     * cursor decorations <b>defined in a theme file</b>, which can have,
16816     * given a cursor name/type, <b>alternate styles</b> on it. It
16817     * works analogously as elm_object_cursor_style_set(), but here
16818     * applyed only to list item objects.
16819     *
16820     * @warning Before you set a cursor style you should have definen a
16821     *       custom cursor previously on the item, with
16822     *       elm_list_item_cursor_set()
16823     *
16824     * @see elm_list_item_cursor_engine_only_set()
16825     * @see elm_list_item_cursor_style_get()
16826     *
16827     * @ingroup List
16828     */
16829    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16830
16831    /**
16832     * Get the current @b style set for a given list item's custom
16833     * cursor
16834     *
16835     * @param item list item with custom cursor set.
16836     * @return style the cursor style in use. If the object does not
16837     *         have a cursor set, then @c NULL is returned.
16838     *
16839     * @see elm_list_item_cursor_style_set() for more details
16840     *
16841     * @ingroup List
16842     */
16843    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16844
16845    /**
16846     * Set if the (custom)cursor for a given list item should be
16847     * searched in its theme, also, or should only rely on the
16848     * rendering engine.
16849     *
16850     * @param item item with custom (custom) cursor already set on
16851     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16852     * only on those provided by the rendering engine, @c EINA_FALSE to
16853     * have them searched on the widget's theme, as well.
16854     *
16855     * @note This call is of use only if you've set a custom cursor
16856     * for list items, with elm_list_item_cursor_set().
16857     *
16858     * @note By default, cursors will only be looked for between those
16859     * provided by the rendering engine.
16860     *
16861     * @ingroup List
16862     */
16863    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16864
16865    /**
16866     * Get if the (custom) cursor for a given list item is being
16867     * searched in its theme, also, or is only relying on the rendering
16868     * engine.
16869     *
16870     * @param item a list item
16871     * @return @c EINA_TRUE, if cursors are being looked for only on
16872     * those provided by the rendering engine, @c EINA_FALSE if they
16873     * are being searched on the widget's theme, as well.
16874     *
16875     * @see elm_list_item_cursor_engine_only_set(), for more details
16876     *
16877     * @ingroup List
16878     */
16879    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16880
16881    /**
16882     * @}
16883     */
16884
16885    /**
16886     * @defgroup Slider Slider
16887     * @ingroup Elementary
16888     *
16889     * @image html img/widget/slider/preview-00.png
16890     * @image latex img/widget/slider/preview-00.eps width=\textwidth
16891     *
16892     * The slider adds a dragable “slider” widget for selecting the value of
16893     * something within a range.
16894     *
16895     * A slider can be horizontal or vertical. It can contain an Icon and has a
16896     * primary label as well as a units label (that is formatted with floating
16897     * point values and thus accepts a printf-style format string, like
16898     * “%1.2f units”. There is also an indicator string that may be somewhere
16899     * else (like on the slider itself) that also accepts a format string like
16900     * units. Label, Icon Unit and Indicator strings/objects are optional.
16901     *
16902     * A slider may be inverted which means values invert, with high vales being
16903     * on the left or top and low values on the right or bottom (as opposed to
16904     * normally being low on the left or top and high on the bottom and right).
16905     *
16906     * The slider should have its minimum and maximum values set by the
16907     * application with  elm_slider_min_max_set() and value should also be set by
16908     * the application before use with  elm_slider_value_set(). The span of the
16909     * slider is its length (horizontally or vertically). This will be scaled by
16910     * the object or applications scaling factor. At any point code can query the
16911     * slider for its value with elm_slider_value_get().
16912     *
16913     * Smart callbacks one can listen to:
16914     * - "changed" - Whenever the slider value is changed by the user.
16915     * - "slider,drag,start" - dragging the slider indicator around has started.
16916     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16917     * - "delay,changed" - A short time after the value is changed by the user.
16918     * This will be called only when the user stops dragging for
16919     * a very short period or when they release their
16920     * finger/mouse, so it avoids possibly expensive reactions to
16921     * the value change.
16922     *
16923     * Available styles for it:
16924     * - @c "default"
16925     *
16926     * Here is an example on its usage:
16927     * @li @ref slider_example
16928     */
16929
16930    /**
16931     * @addtogroup Slider
16932     * @{
16933     */
16934
16935    /**
16936     * Add a new slider widget to the given parent Elementary
16937     * (container) object.
16938     *
16939     * @param parent The parent object.
16940     * @return a new slider widget handle or @c NULL, on errors.
16941     *
16942     * This function inserts a new slider widget on the canvas.
16943     *
16944     * @ingroup Slider
16945     */
16946    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16947
16948    /**
16949     * Set the label of a given slider widget
16950     *
16951     * @param obj The progress bar object
16952     * @param label The text label string, in UTF-8
16953     *
16954     * @ingroup Slider
16955     * @deprecated use elm_object_text_set() instead.
16956     */
16957    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16958
16959    /**
16960     * Get the label of a given slider widget
16961     *
16962     * @param obj The progressbar object
16963     * @return The text label string, in UTF-8
16964     *
16965     * @ingroup Slider
16966     * @deprecated use elm_object_text_get() instead.
16967     */
16968    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16969
16970    /**
16971     * Set the icon object of the slider object.
16972     *
16973     * @param obj The slider object.
16974     * @param icon The icon object.
16975     *
16976     * On horizontal mode, icon is placed at left, and on vertical mode,
16977     * placed at top.
16978     *
16979     * @note Once the icon object is set, a previously set one will be deleted.
16980     * If you want to keep that old content object, use the
16981     * elm_slider_icon_unset() function.
16982     *
16983     * @warning If the object being set does not have minimum size hints set,
16984     * it won't get properly displayed.
16985     *
16986     * @ingroup Slider
16987     */
16988    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16989
16990    /**
16991     * Unset an icon set on a given slider widget.
16992     *
16993     * @param obj The slider object.
16994     * @return The icon object that was being used, if any was set, or
16995     * @c NULL, otherwise (and on errors).
16996     *
16997     * On horizontal mode, icon is placed at left, and on vertical mode,
16998     * placed at top.
16999     *
17000     * This call will unparent and return the icon object which was set
17001     * for this widget, previously, on success.
17002     *
17003     * @see elm_slider_icon_set() for more details
17004     * @see elm_slider_icon_get()
17005     *
17006     * @ingroup Slider
17007     */
17008    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17009
17010    /**
17011     * Retrieve the icon object set for a given slider widget.
17012     *
17013     * @param obj The slider object.
17014     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17015     * otherwise (and on errors).
17016     *
17017     * On horizontal mode, icon is placed at left, and on vertical mode,
17018     * placed at top.
17019     *
17020     * @see elm_slider_icon_set() for more details
17021     * @see elm_slider_icon_unset()
17022     *
17023     * @ingroup Slider
17024     */
17025    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17026
17027    /**
17028     * Set the end object of the slider object.
17029     *
17030     * @param obj The slider object.
17031     * @param end The end object.
17032     *
17033     * On horizontal mode, end is placed at left, and on vertical mode,
17034     * placed at bottom.
17035     *
17036     * @note Once the icon object is set, a previously set one will be deleted.
17037     * If you want to keep that old content object, use the
17038     * elm_slider_end_unset() function.
17039     *
17040     * @warning If the object being set does not have minimum size hints set,
17041     * it won't get properly displayed.
17042     *
17043     * @ingroup Slider
17044     */
17045    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17046
17047    /**
17048     * Unset an end object set on a given slider widget.
17049     *
17050     * @param obj The slider object.
17051     * @return The end object that was being used, if any was set, or
17052     * @c NULL, otherwise (and on errors).
17053     *
17054     * On horizontal mode, end is placed at left, and on vertical mode,
17055     * placed at bottom.
17056     *
17057     * This call will unparent and return the icon object which was set
17058     * for this widget, previously, on success.
17059     *
17060     * @see elm_slider_end_set() for more details.
17061     * @see elm_slider_end_get()
17062     *
17063     * @ingroup Slider
17064     */
17065    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17066
17067    /**
17068     * Retrieve the end object set for a given slider widget.
17069     *
17070     * @param obj The slider object.
17071     * @return The end object's handle, if @p obj had one set, or @c NULL,
17072     * otherwise (and on errors).
17073     *
17074     * On horizontal mode, icon is placed at right, and on vertical mode,
17075     * placed at bottom.
17076     *
17077     * @see elm_slider_end_set() for more details.
17078     * @see elm_slider_end_unset()
17079     *
17080     * @ingroup Slider
17081     */
17082    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17083
17084    /**
17085     * Set the (exact) length of the bar region of a given slider widget.
17086     *
17087     * @param obj The slider object.
17088     * @param size The length of the slider's bar region.
17089     *
17090     * This sets the minimum width (when in horizontal mode) or height
17091     * (when in vertical mode) of the actual bar area of the slider
17092     * @p obj. This in turn affects the object's minimum size. Use
17093     * this when you're not setting other size hints expanding on the
17094     * given direction (like weight and alignment hints) and you would
17095     * like it to have a specific size.
17096     *
17097     * @note Icon, end, label, indicator and unit text around @p obj
17098     * will require their
17099     * own space, which will make @p obj to require more the @p size,
17100     * actually.
17101     *
17102     * @see elm_slider_span_size_get()
17103     *
17104     * @ingroup Slider
17105     */
17106    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17107
17108    /**
17109     * Get the length set for the bar region of a given slider widget
17110     *
17111     * @param obj The slider object.
17112     * @return The length of the slider's bar region.
17113     *
17114     * If that size was not set previously, with
17115     * elm_slider_span_size_set(), this call will return @c 0.
17116     *
17117     * @ingroup Slider
17118     */
17119    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17120
17121    /**
17122     * Set the format string for the unit label.
17123     *
17124     * @param obj The slider object.
17125     * @param format The format string for the unit display.
17126     *
17127     * Unit label is displayed all the time, if set, after slider's bar.
17128     * In horizontal mode, at right and in vertical mode, at bottom.
17129     *
17130     * If @c NULL, unit label won't be visible. If not it sets the format
17131     * string for the label text. To the label text is provided a floating point
17132     * value, so the label text can display up to 1 floating point value.
17133     * Note that this is optional.
17134     *
17135     * Use a format string such as "%1.2f meters" for example, and it will
17136     * display values like: "3.14 meters" for a value equal to 3.14159.
17137     *
17138     * Default is unit label disabled.
17139     *
17140     * @see elm_slider_indicator_format_get()
17141     *
17142     * @ingroup Slider
17143     */
17144    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17145
17146    /**
17147     * Get the unit label format of the slider.
17148     *
17149     * @param obj The slider object.
17150     * @return The unit label format string in UTF-8.
17151     *
17152     * Unit label is displayed all the time, if set, after slider's bar.
17153     * In horizontal mode, at right and in vertical mode, at bottom.
17154     *
17155     * @see elm_slider_unit_format_set() for more
17156     * information on how this works.
17157     *
17158     * @ingroup Slider
17159     */
17160    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17161
17162    /**
17163     * Set the format string for the indicator label.
17164     *
17165     * @param obj The slider object.
17166     * @param indicator The format string for the indicator display.
17167     *
17168     * The slider may display its value somewhere else then unit label,
17169     * for example, above the slider knob that is dragged around. This function
17170     * sets the format string used for this.
17171     *
17172     * If @c NULL, indicator label won't be visible. If not it sets the format
17173     * string for the label text. To the label text is provided a floating point
17174     * value, so the label text can display up to 1 floating point value.
17175     * Note that this is optional.
17176     *
17177     * Use a format string such as "%1.2f meters" for example, and it will
17178     * display values like: "3.14 meters" for a value equal to 3.14159.
17179     *
17180     * Default is indicator label disabled.
17181     *
17182     * @see elm_slider_indicator_format_get()
17183     *
17184     * @ingroup Slider
17185     */
17186    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17187
17188    /**
17189     * Get the indicator label format of the slider.
17190     *
17191     * @param obj The slider object.
17192     * @return The indicator label format string in UTF-8.
17193     *
17194     * The slider may display its value somewhere else then unit label,
17195     * for example, above the slider knob that is dragged around. This function
17196     * gets the format string used for this.
17197     *
17198     * @see elm_slider_indicator_format_set() for more
17199     * information on how this works.
17200     *
17201     * @ingroup Slider
17202     */
17203    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17204
17205    /**
17206     * Set the format function pointer for the indicator label
17207     *
17208     * @param obj The slider object.
17209     * @param func The indicator format function.
17210     * @param free_func The freeing function for the format string.
17211     *
17212     * Set the callback function to format the indicator string.
17213     *
17214     * @see elm_slider_indicator_format_set() for more info on how this works.
17215     *
17216     * @ingroup Slider
17217     */
17218   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);
17219
17220   /**
17221    * Set the format function pointer for the units label
17222    *
17223    * @param obj The slider object.
17224    * @param func The units format function.
17225    * @param free_func The freeing function for the format string.
17226    *
17227    * Set the callback function to format the indicator string.
17228    *
17229    * @see elm_slider_units_format_set() for more info on how this works.
17230    *
17231    * @ingroup Slider
17232    */
17233   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);
17234
17235   /**
17236    * Set the orientation of a given slider widget.
17237    *
17238    * @param obj The slider object.
17239    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17240    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17241    *
17242    * Use this function to change how your slider is to be
17243    * disposed: vertically or horizontally.
17244    *
17245    * By default it's displayed horizontally.
17246    *
17247    * @see elm_slider_horizontal_get()
17248    *
17249    * @ingroup Slider
17250    */
17251    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17252
17253    /**
17254     * Retrieve the orientation of a given slider widget
17255     *
17256     * @param obj The slider object.
17257     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17258     * @c EINA_FALSE if it's @b vertical (and on errors).
17259     *
17260     * @see elm_slider_horizontal_set() for more details.
17261     *
17262     * @ingroup Slider
17263     */
17264    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17265
17266    /**
17267     * Set the minimum and maximum values for the slider.
17268     *
17269     * @param obj The slider object.
17270     * @param min The minimum value.
17271     * @param max The maximum value.
17272     *
17273     * Define the allowed range of values to be selected by the user.
17274     *
17275     * If actual value is less than @p min, it will be updated to @p min. If it
17276     * is bigger then @p max, will be updated to @p max. Actual value can be
17277     * get with elm_slider_value_get().
17278     *
17279     * By default, min is equal to 0.0, and max is equal to 1.0.
17280     *
17281     * @warning Maximum must be greater than minimum, otherwise behavior
17282     * is undefined.
17283     *
17284     * @see elm_slider_min_max_get()
17285     *
17286     * @ingroup Slider
17287     */
17288    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17289
17290    /**
17291     * Get the minimum and maximum values of the slider.
17292     *
17293     * @param obj The slider object.
17294     * @param min Pointer where to store the minimum value.
17295     * @param max Pointer where to store the maximum value.
17296     *
17297     * @note If only one value is needed, the other pointer can be passed
17298     * as @c NULL.
17299     *
17300     * @see elm_slider_min_max_set() for details.
17301     *
17302     * @ingroup Slider
17303     */
17304    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17305
17306    /**
17307     * Set the value the slider displays.
17308     *
17309     * @param obj The slider object.
17310     * @param val The value to be displayed.
17311     *
17312     * Value will be presented on the unit label following format specified with
17313     * elm_slider_unit_format_set() and on indicator with
17314     * elm_slider_indicator_format_set().
17315     *
17316     * @warning The value must to be between min and max values. This values
17317     * are set by elm_slider_min_max_set().
17318     *
17319     * @see elm_slider_value_get()
17320     * @see elm_slider_unit_format_set()
17321     * @see elm_slider_indicator_format_set()
17322     * @see elm_slider_min_max_set()
17323     *
17324     * @ingroup Slider
17325     */
17326    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17327
17328    /**
17329     * Get the value displayed by the spinner.
17330     *
17331     * @param obj The spinner object.
17332     * @return The value displayed.
17333     *
17334     * @see elm_spinner_value_set() for details.
17335     *
17336     * @ingroup Slider
17337     */
17338    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17339
17340    /**
17341     * Invert a given slider widget's displaying values order
17342     *
17343     * @param obj The slider object.
17344     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17345     * @c EINA_FALSE to bring it back to default, non-inverted values.
17346     *
17347     * A slider may be @b inverted, in which state it gets its
17348     * values inverted, with high vales being on the left or top and
17349     * low values on the right or bottom, as opposed to normally have
17350     * the low values on the former and high values on the latter,
17351     * respectively, for horizontal and vertical modes.
17352     *
17353     * @see elm_slider_inverted_get()
17354     *
17355     * @ingroup Slider
17356     */
17357    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17358
17359    /**
17360     * Get whether a given slider widget's displaying values are
17361     * inverted or not.
17362     *
17363     * @param obj The slider object.
17364     * @return @c EINA_TRUE, if @p obj has inverted values,
17365     * @c EINA_FALSE otherwise (and on errors).
17366     *
17367     * @see elm_slider_inverted_set() for more details.
17368     *
17369     * @ingroup Slider
17370     */
17371    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17372
17373    /**
17374     * Set whether to enlarge slider indicator (augmented knob) or not.
17375     *
17376     * @param obj The slider object.
17377     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17378     * let the knob always at default size.
17379     *
17380     * By default, indicator will be bigger while dragged by the user.
17381     *
17382     * @warning It won't display values set with
17383     * elm_slider_indicator_format_set() if you disable indicator.
17384     *
17385     * @ingroup Slider
17386     */
17387    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17388
17389    /**
17390     * Get whether a given slider widget's enlarging indicator or not.
17391     *
17392     * @param obj The slider object.
17393     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17394     * @c EINA_FALSE otherwise (and on errors).
17395     *
17396     * @see elm_slider_indicator_show_set() for details.
17397     *
17398     * @ingroup Slider
17399     */
17400    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17401
17402    /**
17403     * @}
17404     */
17405
17406    /**
17407     * @addtogroup Actionslider Actionslider
17408     *
17409     * @image html img/widget/actionslider/preview-00.png
17410     * @image latex img/widget/actionslider/preview-00.eps
17411     *
17412     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17413     * properties. The indicator is the element the user drags to choose a label.
17414     * When the position is set with magnet, when released the indicator will be
17415     * moved to it if it's nearest the magnetized position.
17416     *
17417     * @note By default all positions are set as enabled.
17418     *
17419     * Signals that you can add callbacks for are:
17420     *
17421     * "selected" - when user selects an enabled position (the label is passed
17422     *              as event info)".
17423     * @n
17424     * "pos_changed" - when the indicator reaches any of the positions("left",
17425     *                 "right" or "center").
17426     *
17427     * See an example of actionslider usage @ref actionslider_example_page "here"
17428     * @{
17429     */
17430    typedef enum _Elm_Actionslider_Pos
17431      {
17432         ELM_ACTIONSLIDER_NONE = 0,
17433         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17434         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17435         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17436         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17437      } Elm_Actionslider_Pos;
17438
17439    /**
17440     * Add a new actionslider to the parent.
17441     *
17442     * @param parent The parent object
17443     * @return The new actionslider object or NULL if it cannot be created
17444     */
17445    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17446    /**
17447     * Set actionslider labels.
17448     *
17449     * @param obj The actionslider object
17450     * @param left_label The label to be set on the left.
17451     * @param center_label The label to be set on the center.
17452     * @param right_label The label to be set on the right.
17453     * @deprecated use elm_object_text_set() instead.
17454     */
17455    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);
17456    /**
17457     * Get actionslider labels.
17458     *
17459     * @param obj The actionslider object
17460     * @param left_label A char** to place the left_label of @p obj into.
17461     * @param center_label A char** to place the center_label of @p obj into.
17462     * @param right_label A char** to place the right_label of @p obj into.
17463     * @deprecated use elm_object_text_set() instead.
17464     */
17465    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);
17466    /**
17467     * Get actionslider selected label.
17468     *
17469     * @param obj The actionslider object
17470     * @return The selected label
17471     */
17472    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17473    /**
17474     * Set actionslider indicator position.
17475     *
17476     * @param obj The actionslider object.
17477     * @param pos The position of the indicator.
17478     */
17479    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17480    /**
17481     * Get actionslider indicator position.
17482     *
17483     * @param obj The actionslider object.
17484     * @return The position of the indicator.
17485     */
17486    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17487    /**
17488     * Set actionslider magnet position. To make multiple positions magnets @c or
17489     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17490     *
17491     * @param obj The actionslider object.
17492     * @param pos Bit mask indicating the magnet positions.
17493     */
17494    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17495    /**
17496     * Get actionslider magnet position.
17497     *
17498     * @param obj The actionslider object.
17499     * @return The positions with magnet property.
17500     */
17501    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17502    /**
17503     * Set actionslider enabled position. To set multiple positions as enabled @c or
17504     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17505     *
17506     * @note All the positions are enabled by default.
17507     *
17508     * @param obj The actionslider object.
17509     * @param pos Bit mask indicating the enabled positions.
17510     */
17511    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17512    /**
17513     * Get actionslider enabled position.
17514     *
17515     * @param obj The actionslider object.
17516     * @return The enabled positions.
17517     */
17518    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17519    /**
17520     * Set the label used on the indicator.
17521     *
17522     * @param obj The actionslider object
17523     * @param label The label to be set on the indicator.
17524     * @deprecated use elm_object_text_set() instead.
17525     */
17526    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17527    /**
17528     * Get the label used on the indicator object.
17529     *
17530     * @param obj The actionslider object
17531     * @return The indicator label
17532     * @deprecated use elm_object_text_get() instead.
17533     */
17534    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17535    /**
17536     * @}
17537     */
17538
17539    /**
17540     * @defgroup Genlist Genlist
17541     *
17542     * @image html img/widget/genlist/preview-00.png
17543     * @image latex img/widget/genlist/preview-00.eps
17544     * @image html img/genlist.png
17545     * @image latex img/genlist.eps
17546     *
17547     * This widget aims to have more expansive list than the simple list in
17548     * Elementary that could have more flexible items and allow many more entries
17549     * while still being fast and low on memory usage. At the same time it was
17550     * also made to be able to do tree structures. But the price to pay is more
17551     * complexity when it comes to usage. If all you want is a simple list with
17552     * icons and a single label, use the normal @ref List object.
17553     *
17554     * Genlist has a fairly large API, mostly because it's relatively complex,
17555     * trying to be both expansive, powerful and efficient. First we will begin
17556     * an overview on the theory behind genlist.
17557     *
17558     * @section Genlist_Item_Class Genlist item classes - creating items
17559     *
17560     * In order to have the ability to add and delete items on the fly, genlist
17561     * implements a class (callback) system where the application provides a
17562     * structure with information about that type of item (genlist may contain
17563     * multiple different items with different classes, states and styles).
17564     * Genlist will call the functions in this struct (methods) when an item is
17565     * "realized" (i.e., created dynamically, while the user is scrolling the
17566     * grid). All objects will simply be deleted when no longer needed with
17567     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17568     * following members:
17569     * - @c item_style - This is a constant string and simply defines the name
17570     *   of the item style. It @b must be specified and the default should be @c
17571     *   "default".
17572     * - @c mode_item_style - This is a constant string and simply defines the
17573     *   name of the style that will be used for mode animations. It can be left
17574     *   as @c NULL if you don't plan to use Genlist mode. See
17575     *   elm_genlist_item_mode_set() for more info.
17576     *
17577     * - @c func - A struct with pointers to functions that will be called when
17578     *   an item is going to be actually created. All of them receive a @c data
17579     *   parameter that will point to the same data passed to
17580     *   elm_genlist_item_append() and related item creation functions, and a @c
17581     *   obj parameter that points to the genlist object itself.
17582     *
17583     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17584     * state_get and @c del. The 3 first functions also receive a @c part
17585     * parameter described below. A brief description of these functions follows:
17586     *
17587     * - @c label_get - The @c part parameter is the name string of one of the
17588     *   existing text parts in the Edje group implementing the item's theme.
17589     *   This function @b must return a strdup'()ed string, as the caller will
17590     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17591     * - @c icon_get - The @c part parameter is the name string of one of the
17592     *   existing (icon) swallow parts in the Edje group implementing the item's
17593     *   theme. It must return @c NULL, when no icon is desired, or a valid
17594     *   object handle, otherwise.  The object will be deleted by the genlist on
17595     *   its deletion or when the item is "unrealized".  See
17596     *   #Elm_Genlist_Item_Icon_Get_Cb.
17597     * - @c func.state_get - The @c part parameter is the name string of one of
17598     *   the state parts in the Edje group implementing the item's theme. Return
17599     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17600     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17601     *   and @c "elm" as "emission" and "source" arguments, respectively, when
17602     *   the state is true (the default is false), where @c XXX is the name of
17603     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
17604     * - @c func.del - This is intended for use when genlist items are deleted,
17605     *   so any data attached to the item (e.g. its data parameter on creation)
17606     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
17607     *
17608     * available item styles:
17609     * - default
17610     * - default_style - The text part is a textblock
17611     *
17612     * @image html img/widget/genlist/preview-04.png
17613     * @image latex img/widget/genlist/preview-04.eps
17614     *
17615     * - double_label
17616     *
17617     * @image html img/widget/genlist/preview-01.png
17618     * @image latex img/widget/genlist/preview-01.eps
17619     *
17620     * - icon_top_text_bottom
17621     *
17622     * @image html img/widget/genlist/preview-02.png
17623     * @image latex img/widget/genlist/preview-02.eps
17624     *
17625     * - group_index
17626     *
17627     * @image html img/widget/genlist/preview-03.png
17628     * @image latex img/widget/genlist/preview-03.eps
17629     *
17630     * @section Genlist_Items Structure of items
17631     *
17632     * An item in a genlist can have 0 or more text labels (they can be regular
17633     * text or textblock Evas objects - that's up to the style to determine), 0
17634     * or more icons (which are simply objects swallowed into the genlist item's
17635     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17636     * behavior left to the user to define. The Edje part names for each of
17637     * these properties will be looked up, in the theme file for the genlist,
17638     * under the Edje (string) data items named @c "labels", @c "icons" and @c
17639     * "states", respectively. For each of those properties, if more than one
17640     * part is provided, they must have names listed separated by spaces in the
17641     * data fields. For the default genlist item theme, we have @b one label
17642     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17643     * "elm.swallow.end") and @b no state parts.
17644     *
17645     * A genlist item may be at one of several styles. Elementary provides one
17646     * by default - "default", but this can be extended by system or application
17647     * custom themes/overlays/extensions (see @ref Theme "themes" for more
17648     * details).
17649     *
17650     * @section Genlist_Manipulation Editing and Navigating
17651     *
17652     * Items can be added by several calls. All of them return a @ref
17653     * Elm_Genlist_Item handle that is an internal member inside the genlist.
17654     * They all take a data parameter that is meant to be used for a handle to
17655     * the applications internal data (eg the struct with the original item
17656     * data). The parent parameter is the parent genlist item this belongs to if
17657     * it is a tree or an indexed group, and NULL if there is no parent. The
17658     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17659     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17660     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17661     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
17662     * is set then this item is group index item that is displayed at the top
17663     * until the next group comes. The func parameter is a convenience callback
17664     * that is called when the item is selected and the data parameter will be
17665     * the func_data parameter, obj be the genlist object and event_info will be
17666     * the genlist item.
17667     *
17668     * elm_genlist_item_append() adds an item to the end of the list, or if
17669     * there is a parent, to the end of all the child items of the parent.
17670     * elm_genlist_item_prepend() is the same but adds to the beginning of
17671     * the list or children list. elm_genlist_item_insert_before() inserts at
17672     * item before another item and elm_genlist_item_insert_after() inserts after
17673     * the indicated item.
17674     *
17675     * The application can clear the list with elm_genlist_clear() which deletes
17676     * all the items in the list and elm_genlist_item_del() will delete a specific
17677     * item. elm_genlist_item_subitems_clear() will clear all items that are
17678     * children of the indicated parent item.
17679     *
17680     * To help inspect list items you can jump to the item at the top of the list
17681     * with elm_genlist_first_item_get() which will return the item pointer, and
17682     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17683     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17684     * and previous items respectively relative to the indicated item. Using
17685     * these calls you can walk the entire item list/tree. Note that as a tree
17686     * the items are flattened in the list, so elm_genlist_item_parent_get() will
17687     * let you know which item is the parent (and thus know how to skip them if
17688     * wanted).
17689     *
17690     * @section Genlist_Muti_Selection Multi-selection
17691     *
17692     * If the application wants multiple items to be able to be selected,
17693     * elm_genlist_multi_select_set() can enable this. If the list is
17694     * single-selection only (the default), then elm_genlist_selected_item_get()
17695     * will return the selected item, if any, or NULL I none is selected. If the
17696     * list is multi-select then elm_genlist_selected_items_get() will return a
17697     * list (that is only valid as long as no items are modified (added, deleted,
17698     * selected or unselected)).
17699     *
17700     * @section Genlist_Usage_Hints Usage hints
17701     *
17702     * There are also convenience functions. elm_genlist_item_genlist_get() will
17703     * return the genlist object the item belongs to. elm_genlist_item_show()
17704     * will make the scroller scroll to show that specific item so its visible.
17705     * elm_genlist_item_data_get() returns the data pointer set by the item
17706     * creation functions.
17707     *
17708     * If an item changes (state of boolean changes, label or icons change),
17709     * then use elm_genlist_item_update() to have genlist update the item with
17710     * the new state. Genlist will re-realize the item thus call the functions
17711     * in the _Elm_Genlist_Item_Class for that item.
17712     *
17713     * To programmatically (un)select an item use elm_genlist_item_selected_set().
17714     * To get its selected state use elm_genlist_item_selected_get(). Similarly
17715     * to expand/contract an item and get its expanded state, use
17716     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17717     * again to make an item disabled (unable to be selected and appear
17718     * differently) use elm_genlist_item_disabled_set() to set this and
17719     * elm_genlist_item_disabled_get() to get the disabled state.
17720     *
17721     * In general to indicate how the genlist should expand items horizontally to
17722     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17723     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17724     * mode means that if items are too wide to fit, the scroller will scroll
17725     * horizontally. Otherwise items are expanded to fill the width of the
17726     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17727     * to the viewport width and limited to that size. This can be combined with
17728     * a different style that uses edjes' ellipsis feature (cutting text off like
17729     * this: "tex...").
17730     *
17731     * Items will only call their selection func and callback when first becoming
17732     * selected. Any further clicks will do nothing, unless you enable always
17733     * select with elm_genlist_always_select_mode_set(). This means even if
17734     * selected, every click will make the selected callbacks be called.
17735     * elm_genlist_no_select_mode_set() will turn off the ability to select
17736     * items entirely and they will neither appear selected nor call selected
17737     * callback functions.
17738     *
17739     * Remember that you can create new styles and add your own theme augmentation
17740     * per application with elm_theme_extension_add(). If you absolutely must
17741     * have a specific style that overrides any theme the user or system sets up
17742     * you can use elm_theme_overlay_add() to add such a file.
17743     *
17744     * @section Genlist_Implementation Implementation
17745     *
17746     * Evas tracks every object you create. Every time it processes an event
17747     * (mouse move, down, up etc.) it needs to walk through objects and find out
17748     * what event that affects. Even worse every time it renders display updates,
17749     * in order to just calculate what to re-draw, it needs to walk through many
17750     * many many objects. Thus, the more objects you keep active, the more
17751     * overhead Evas has in just doing its work. It is advisable to keep your
17752     * active objects to the minimum working set you need. Also remember that
17753     * object creation and deletion carries an overhead, so there is a
17754     * middle-ground, which is not easily determined. But don't keep massive lists
17755     * of objects you can't see or use. Genlist does this with list objects. It
17756     * creates and destroys them dynamically as you scroll around. It groups them
17757     * into blocks so it can determine the visibility etc. of a whole block at
17758     * once as opposed to having to walk the whole list. This 2-level list allows
17759     * for very large numbers of items to be in the list (tests have used up to
17760     * 2,000,000 items). Also genlist employs a queue for adding items. As items
17761     * may be different sizes, every item added needs to be calculated as to its
17762     * size and thus this presents a lot of overhead on populating the list, this
17763     * genlist employs a queue. Any item added is queued and spooled off over
17764     * time, actually appearing some time later, so if your list has many members
17765     * you may find it takes a while for them to all appear, with your process
17766     * consuming a lot of CPU while it is busy spooling.
17767     *
17768     * Genlist also implements a tree structure, but it does so with callbacks to
17769     * the application, with the application filling in tree structures when
17770     * requested (allowing for efficient building of a very deep tree that could
17771     * even be used for file-management). See the above smart signal callbacks for
17772     * details.
17773     *
17774     * @section Genlist_Smart_Events Genlist smart events
17775     *
17776     * Signals that you can add callbacks for are:
17777     * - @c "activated" - The user has double-clicked or pressed
17778     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
17779     *   item that was activated.
17780     * - @c "clicked,double" - The user has double-clicked an item.  The @c
17781     *   event_info parameter is the item that was double-clicked.
17782     * - @c "selected" - This is called when a user has made an item selected.
17783     *   The event_info parameter is the genlist item that was selected.
17784     * - @c "unselected" - This is called when a user has made an item
17785     *   unselected. The event_info parameter is the genlist item that was
17786     *   unselected.
17787     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17788     *   called and the item is now meant to be expanded. The event_info
17789     *   parameter is the genlist item that was indicated to expand.  It is the
17790     *   job of this callback to then fill in the child items.
17791     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17792     *   called and the item is now meant to be contracted. The event_info
17793     *   parameter is the genlist item that was indicated to contract. It is the
17794     *   job of this callback to then delete the child items.
17795     * - @c "expand,request" - This is called when a user has indicated they want
17796     *   to expand a tree branch item. The callback should decide if the item can
17797     *   expand (has any children) and then call elm_genlist_item_expanded_set()
17798     *   appropriately to set the state. The event_info parameter is the genlist
17799     *   item that was indicated to expand.
17800     * - @c "contract,request" - This is called when a user has indicated they
17801     *   want to contract a tree branch item. The callback should decide if the
17802     *   item can contract (has any children) and then call
17803     *   elm_genlist_item_expanded_set() appropriately to set the state. The
17804     *   event_info parameter is the genlist item that was indicated to contract.
17805     * - @c "realized" - This is called when the item in the list is created as a
17806     *   real evas object. event_info parameter is the genlist item that was
17807     *   created. The object may be deleted at any time, so it is up to the
17808     *   caller to not use the object pointer from elm_genlist_item_object_get()
17809     *   in a way where it may point to freed objects.
17810     * - @c "unrealized" - This is called just before an item is unrealized.
17811     *   After this call icon objects provided will be deleted and the item
17812     *   object itself delete or be put into a floating cache.
17813     * - @c "drag,start,up" - This is called when the item in the list has been
17814     *   dragged (not scrolled) up.
17815     * - @c "drag,start,down" - This is called when the item in the list has been
17816     *   dragged (not scrolled) down.
17817     * - @c "drag,start,left" - This is called when the item in the list has been
17818     *   dragged (not scrolled) left.
17819     * - @c "drag,start,right" - This is called when the item in the list has
17820     *   been dragged (not scrolled) right.
17821     * - @c "drag,stop" - This is called when the item in the list has stopped
17822     *   being dragged.
17823     * - @c "drag" - This is called when the item in the list is being dragged.
17824     * - @c "longpressed" - This is called when the item is pressed for a certain
17825     *   amount of time. By default it's 1 second.
17826     * - @c "scroll,anim,start" - This is called when scrolling animation has
17827     *   started.
17828     * - @c "scroll,anim,stop" - This is called when scrolling animation has
17829     *   stopped.
17830     * - @c "scroll,drag,start" - This is called when dragging the content has
17831     *   started.
17832     * - @c "scroll,drag,stop" - This is called when dragging the content has
17833     *   stopped.
17834     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
17835     *   the top edge.
17836     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
17837     *   until the bottom edge.
17838     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
17839     *   until the left edge.
17840     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
17841     *   until the right edge.
17842     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17843     *   swiped left.
17844     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17845     *   swiped right.
17846     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17847     *   swiped up.
17848     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17849     *   swiped down.
17850     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17851     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
17852     *   multi-touch pinched in.
17853     * - @c "swipe" - This is called when the genlist is swiped.
17854     *
17855     * @section Genlist_Examples Examples
17856     *
17857     * Here is a list of examples that use the genlist, trying to show some of
17858     * its capabilities:
17859     * - @ref genlist_example_01
17860     * - @ref genlist_example_02
17861     * - @ref genlist_example_03
17862     * - @ref genlist_example_04
17863     * - @ref genlist_example_05
17864     */
17865
17866    /**
17867     * @addtogroup Genlist
17868     * @{
17869     */
17870
17871    /**
17872     * @enum _Elm_Genlist_Item_Flags
17873     * @typedef Elm_Genlist_Item_Flags
17874     *
17875     * Defines if the item is of any special type (has subitems or it's the
17876     * index of a group), or is just a simple item.
17877     *
17878     * @ingroup Genlist
17879     */
17880    typedef enum _Elm_Genlist_Item_Flags
17881      {
17882         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17883         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17884         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17885      } Elm_Genlist_Item_Flags;
17886    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
17887    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17888    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
17889    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
17890    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. */
17891    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. */
17892    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
17893    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
17894
17895    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17896    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17897    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17898    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17899
17900    /**
17901     * @struct _Elm_Genlist_Item_Class
17902     *
17903     * Genlist item class definition structs.
17904     *
17905     * This struct contains the style and fetching functions that will define the
17906     * contents of each item.
17907     *
17908     * @see @ref Genlist_Item_Class
17909     */
17910    struct _Elm_Genlist_Item_Class
17911      {
17912         const char                *item_style; /**< style of this class. */
17913         struct
17914           {
17915              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
17916              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
17917              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
17918              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
17919              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
17920           } func;
17921         const char                *mode_item_style;
17922      };
17923
17924    /**
17925     * Add a new genlist widget to the given parent Elementary
17926     * (container) object
17927     *
17928     * @param parent The parent object
17929     * @return a new genlist widget handle or @c NULL, on errors
17930     *
17931     * This function inserts a new genlist widget on the canvas.
17932     *
17933     * @see elm_genlist_item_append()
17934     * @see elm_genlist_item_del()
17935     * @see elm_genlist_clear()
17936     *
17937     * @ingroup Genlist
17938     */
17939    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17940    /**
17941     * Remove all items from a given genlist widget.
17942     *
17943     * @param obj The genlist object
17944     *
17945     * This removes (and deletes) all items in @p obj, leaving it empty.
17946     *
17947     * @see elm_genlist_item_del(), to remove just one item.
17948     *
17949     * @ingroup Genlist
17950     */
17951    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17952    /**
17953     * Enable or disable multi-selection in the genlist
17954     *
17955     * @param obj The genlist object
17956     * @param multi Multi-select enable/disable. Default is disabled.
17957     *
17958     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17959     * the list. This allows more than 1 item to be selected. To retrieve the list
17960     * of selected items, use elm_genlist_selected_items_get().
17961     *
17962     * @see elm_genlist_selected_items_get()
17963     * @see elm_genlist_multi_select_get()
17964     *
17965     * @ingroup Genlist
17966     */
17967    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17968    /**
17969     * Gets if multi-selection in genlist is enabled or disabled.
17970     *
17971     * @param obj The genlist object
17972     * @return Multi-select enabled/disabled
17973     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17974     *
17975     * @see elm_genlist_multi_select_set()
17976     *
17977     * @ingroup Genlist
17978     */
17979    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17980    /**
17981     * This sets the horizontal stretching mode.
17982     *
17983     * @param obj The genlist object
17984     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17985     *
17986     * This sets the mode used for sizing items horizontally. Valid modes
17987     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17988     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17989     * the scroller will scroll horizontally. Otherwise items are expanded
17990     * to fill the width of the viewport of the scroller. If it is
17991     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17992     * limited to that size.
17993     *
17994     * @see elm_genlist_horizontal_get()
17995     *
17996     * @ingroup Genlist
17997     */
17998    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17999    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18000    /**
18001     * Gets the horizontal stretching mode.
18002     *
18003     * @param obj The genlist object
18004     * @return The mode to use
18005     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18006     *
18007     * @see elm_genlist_horizontal_set()
18008     *
18009     * @ingroup Genlist
18010     */
18011    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18012    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18013    /**
18014     * Set the always select mode.
18015     *
18016     * @param obj The genlist object
18017     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18018     * EINA_FALSE = off). Default is @c EINA_FALSE.
18019     *
18020     * Items will only call their selection func and callback when first
18021     * becoming selected. Any further clicks will do nothing, unless you
18022     * enable always select with elm_genlist_always_select_mode_set().
18023     * This means that, even if selected, every click will make the selected
18024     * callbacks be called.
18025     *
18026     * @see elm_genlist_always_select_mode_get()
18027     *
18028     * @ingroup Genlist
18029     */
18030    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18031    /**
18032     * Get the always select mode.
18033     *
18034     * @param obj The genlist object
18035     * @return The always select mode
18036     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18037     *
18038     * @see elm_genlist_always_select_mode_set()
18039     *
18040     * @ingroup Genlist
18041     */
18042    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18043    /**
18044     * Enable/disable the no select mode.
18045     *
18046     * @param obj The genlist object
18047     * @param no_select The no select mode
18048     * (EINA_TRUE = on, EINA_FALSE = off)
18049     *
18050     * This will turn off the ability to select items entirely and they
18051     * will neither appear selected nor call selected callback functions.
18052     *
18053     * @see elm_genlist_no_select_mode_get()
18054     *
18055     * @ingroup Genlist
18056     */
18057    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18058    /**
18059     * Gets whether the no select mode is enabled.
18060     *
18061     * @param obj The genlist object
18062     * @return The no select mode
18063     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18064     *
18065     * @see elm_genlist_no_select_mode_set()
18066     *
18067     * @ingroup Genlist
18068     */
18069    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18070    /**
18071     * Enable/disable compress mode.
18072     *
18073     * @param obj The genlist object
18074     * @param compress The compress mode
18075     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18076     *
18077     * This will enable the compress mode where items are "compressed"
18078     * horizontally to fit the genlist scrollable viewport width. This is
18079     * special for genlist.  Do not rely on
18080     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18081     * work as genlist needs to handle it specially.
18082     *
18083     * @see elm_genlist_compress_mode_get()
18084     *
18085     * @ingroup Genlist
18086     */
18087    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18088    /**
18089     * Get whether the compress mode is enabled.
18090     *
18091     * @param obj The genlist object
18092     * @return The compress mode
18093     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18094     *
18095     * @see elm_genlist_compress_mode_set()
18096     *
18097     * @ingroup Genlist
18098     */
18099    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18100    /**
18101     * Enable/disable height-for-width mode.
18102     *
18103     * @param obj The genlist object
18104     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18105     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18106     *
18107     * With height-for-width mode the item width will be fixed (restricted
18108     * to a minimum of) to the list width when calculating its size in
18109     * order to allow the height to be calculated based on it. This allows,
18110     * for instance, text block to wrap lines if the Edje part is
18111     * configured with "text.min: 0 1".
18112     *
18113     * @note This mode will make list resize slower as it will have to
18114     *       recalculate every item height again whenever the list width
18115     *       changes!
18116     *
18117     * @note When height-for-width mode is enabled, it also enables
18118     *       compress mode (see elm_genlist_compress_mode_set()) and
18119     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18120     *
18121     * @ingroup Genlist
18122     */
18123    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18124    /**
18125     * Get whether the height-for-width mode is enabled.
18126     *
18127     * @param obj The genlist object
18128     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18129     * off)
18130     *
18131     * @ingroup Genlist
18132     */
18133    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18134    /**
18135     * Enable/disable horizontal and vertical bouncing effect.
18136     *
18137     * @param obj The genlist object
18138     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18139     * EINA_FALSE = off). Default is @c EINA_FALSE.
18140     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18141     * EINA_FALSE = off). Default is @c EINA_TRUE.
18142     *
18143     * This will enable or disable the scroller bouncing effect for the
18144     * genlist. See elm_scroller_bounce_set() for details.
18145     *
18146     * @see elm_scroller_bounce_set()
18147     * @see elm_genlist_bounce_get()
18148     *
18149     * @ingroup Genlist
18150     */
18151    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18152    /**
18153     * Get whether the horizontal and vertical bouncing effect is enabled.
18154     *
18155     * @param obj The genlist object
18156     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18157     * option is set.
18158     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18159     * option is set.
18160     *
18161     * @see elm_genlist_bounce_set()
18162     *
18163     * @ingroup Genlist
18164     */
18165    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18166    /**
18167     * Enable/disable homogenous mode.
18168     *
18169     * @param obj The genlist object
18170     * @param homogeneous Assume the items within the genlist are of the
18171     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18172     * EINA_FALSE.
18173     *
18174     * This will enable the homogeneous mode where items are of the same
18175     * height and width so that genlist may do the lazy-loading at its
18176     * maximum (which increases the performance for scrolling the list). This
18177     * implies 'compressed' mode.
18178     *
18179     * @see elm_genlist_compress_mode_set()
18180     * @see elm_genlist_homogeneous_get()
18181     *
18182     * @ingroup Genlist
18183     */
18184    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18185    /**
18186     * Get whether the homogenous mode is enabled.
18187     *
18188     * @param obj The genlist object
18189     * @return Assume the items within the genlist are of the same height
18190     * and width (EINA_TRUE = on, EINA_FALSE = off)
18191     *
18192     * @see elm_genlist_homogeneous_set()
18193     *
18194     * @ingroup Genlist
18195     */
18196    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18197    /**
18198     * Set the maximum number of items within an item block
18199     *
18200     * @param obj The genlist object
18201     * @param n   Maximum number of items within an item block. Default is 32.
18202     *
18203     * This will configure the block count to tune to the target with
18204     * particular performance matrix.
18205     *
18206     * A block of objects will be used to reduce the number of operations due to
18207     * many objects in the screen. It can determine the visibility, or if the
18208     * object has changed, it theme needs to be updated, etc. doing this kind of
18209     * calculation to the entire block, instead of per object.
18210     *
18211     * The default value for the block count is enough for most lists, so unless
18212     * you know you will have a lot of objects visible in the screen at the same
18213     * time, don't try to change this.
18214     *
18215     * @see elm_genlist_block_count_get()
18216     * @see @ref Genlist_Implementation
18217     *
18218     * @ingroup Genlist
18219     */
18220    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18221    /**
18222     * Get the maximum number of items within an item block
18223     *
18224     * @param obj The genlist object
18225     * @return Maximum number of items within an item block
18226     *
18227     * @see elm_genlist_block_count_set()
18228     *
18229     * @ingroup Genlist
18230     */
18231    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18232    /**
18233     * Set the timeout in seconds for the longpress event.
18234     *
18235     * @param obj The genlist object
18236     * @param timeout timeout in seconds. Default is 1.
18237     *
18238     * This option will change how long it takes to send an event "longpressed"
18239     * after the mouse down signal is sent to the list. If this event occurs, no
18240     * "clicked" event will be sent.
18241     *
18242     * @see elm_genlist_longpress_timeout_set()
18243     *
18244     * @ingroup Genlist
18245     */
18246    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18247    /**
18248     * Get the timeout in seconds for the longpress event.
18249     *
18250     * @param obj The genlist object
18251     * @return timeout in seconds
18252     *
18253     * @see elm_genlist_longpress_timeout_get()
18254     *
18255     * @ingroup Genlist
18256     */
18257    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18258    /**
18259     * Append a new item in a given genlist widget.
18260     *
18261     * @param obj The genlist object
18262     * @param itc The item class for the item
18263     * @param data The item data
18264     * @param parent The parent item, or NULL if none
18265     * @param flags Item flags
18266     * @param func Convenience function called when the item is selected
18267     * @param func_data Data passed to @p func above.
18268     * @return A handle to the item added or @c NULL if not possible
18269     *
18270     * This adds the given item to the end of the list or the end of
18271     * the children list if the @p parent is given.
18272     *
18273     * @see elm_genlist_item_prepend()
18274     * @see elm_genlist_item_insert_before()
18275     * @see elm_genlist_item_insert_after()
18276     * @see elm_genlist_item_del()
18277     *
18278     * @ingroup Genlist
18279     */
18280    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);
18281    /**
18282     * Prepend a new item in a given genlist widget.
18283     *
18284     * @param obj The genlist object
18285     * @param itc The item class for the item
18286     * @param data The item data
18287     * @param parent The parent item, or NULL if none
18288     * @param flags Item flags
18289     * @param func Convenience function called when the item is selected
18290     * @param func_data Data passed to @p func above.
18291     * @return A handle to the item added or NULL if not possible
18292     *
18293     * This adds an item to the beginning of the list or beginning of the
18294     * children of the parent if given.
18295     *
18296     * @see elm_genlist_item_append()
18297     * @see elm_genlist_item_insert_before()
18298     * @see elm_genlist_item_insert_after()
18299     * @see elm_genlist_item_del()
18300     *
18301     * @ingroup Genlist
18302     */
18303    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);
18304    /**
18305     * Insert an item before another in a genlist widget
18306     *
18307     * @param obj The genlist object
18308     * @param itc The item class for the item
18309     * @param data The item data
18310     * @param before The item to place this new one before.
18311     * @param flags Item flags
18312     * @param func Convenience function called when the item is selected
18313     * @param func_data Data passed to @p func above.
18314     * @return A handle to the item added or @c NULL if not possible
18315     *
18316     * This inserts an item before another in the list. It will be in the
18317     * same tree level or group as the item it is inserted before.
18318     *
18319     * @see elm_genlist_item_append()
18320     * @see elm_genlist_item_prepend()
18321     * @see elm_genlist_item_insert_after()
18322     * @see elm_genlist_item_del()
18323     *
18324     * @ingroup Genlist
18325     */
18326    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);
18327    /**
18328     * Insert an item after another in a genlist widget
18329     *
18330     * @param obj The genlist object
18331     * @param itc The item class for the item
18332     * @param data The item data
18333     * @param after The item to place this new one after.
18334     * @param flags Item flags
18335     * @param func Convenience function called when the item is selected
18336     * @param func_data Data passed to @p func above.
18337     * @return A handle to the item added or @c NULL if not possible
18338     *
18339     * This inserts an item after another in the list. It will be in the
18340     * same tree level or group as the item it is inserted after.
18341     *
18342     * @see elm_genlist_item_append()
18343     * @see elm_genlist_item_prepend()
18344     * @see elm_genlist_item_insert_before()
18345     * @see elm_genlist_item_del()
18346     *
18347     * @ingroup Genlist
18348     */
18349    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);
18350    /**
18351     * Insert a new item into the sorted genlist object
18352     *
18353     * @param obj The genlist object
18354     * @param itc The item class for the item
18355     * @param data The item data
18356     * @param parent The parent item, or NULL if none
18357     * @param flags Item flags
18358     * @param comp The function called for the sort
18359     * @param func Convenience function called when item selected
18360     * @param func_data Data passed to @p func above.
18361     * @return A handle to the item added or NULL if not possible
18362     *
18363     * @ingroup Genlist
18364     */
18365    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);
18366    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);
18367    /* operations to retrieve existing items */
18368    /**
18369     * Get the selectd item in the genlist.
18370     *
18371     * @param obj The genlist object
18372     * @return The selected item, or NULL if none is selected.
18373     *
18374     * This gets the selected item in the list (if multi-selection is enabled, only
18375     * the item that was first selected in the list is returned - which is not very
18376     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18377     * used).
18378     *
18379     * If no item is selected, NULL is returned.
18380     *
18381     * @see elm_genlist_selected_items_get()
18382     *
18383     * @ingroup Genlist
18384     */
18385    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18386    /**
18387     * Get a list of selected items in the genlist.
18388     *
18389     * @param obj The genlist object
18390     * @return The list of selected items, or NULL if none are selected.
18391     *
18392     * It returns a list of the selected items. This list pointer is only valid so
18393     * long as the selection doesn't change (no items are selected or unselected, or
18394     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18395     * pointers. The order of the items in this list is the order which they were
18396     * selected, i.e. the first item in this list is the first item that was
18397     * selected, and so on.
18398     *
18399     * @note If not in multi-select mode, consider using function
18400     * elm_genlist_selected_item_get() instead.
18401     *
18402     * @see elm_genlist_multi_select_set()
18403     * @see elm_genlist_selected_item_get()
18404     *
18405     * @ingroup Genlist
18406     */
18407    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18408    /**
18409     * Get a list of realized items in genlist
18410     *
18411     * @param obj The genlist object
18412     * @return The list of realized items, nor NULL if none are realized.
18413     *
18414     * This returns a list of the realized items in the genlist. The list
18415     * contains Elm_Genlist_Item pointers. The list must be freed by the
18416     * caller when done with eina_list_free(). The item pointers in the
18417     * list are only valid so long as those items are not deleted or the
18418     * genlist is not deleted.
18419     *
18420     * @see elm_genlist_realized_items_update()
18421     *
18422     * @ingroup Genlist
18423     */
18424    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18425    /**
18426     * Get the item that is at the x, y canvas coords.
18427     *
18428     * @param obj The gelinst object.
18429     * @param x The input x coordinate
18430     * @param y The input y coordinate
18431     * @param posret The position relative to the item returned here
18432     * @return The item at the coordinates or NULL if none
18433     *
18434     * This returns the item at the given coordinates (which are canvas
18435     * relative, not object-relative). If an item is at that coordinate,
18436     * that item handle is returned, and if @p posret is not NULL, the
18437     * integer pointed to is set to a value of -1, 0 or 1, depending if
18438     * the coordinate is on the upper portion of that item (-1), on the
18439     * middle section (0) or on the lower part (1). If NULL is returned as
18440     * an item (no item found there), then posret may indicate -1 or 1
18441     * based if the coordinate is above or below all items respectively in
18442     * the genlist.
18443     *
18444     * @ingroup Genlist
18445     */
18446    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);
18447    /**
18448     * Get the first item in the genlist
18449     *
18450     * This returns the first item in the list.
18451     *
18452     * @param obj The genlist object
18453     * @return The first item, or NULL if none
18454     *
18455     * @ingroup Genlist
18456     */
18457    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18458    /**
18459     * Get the last item in the genlist
18460     *
18461     * This returns the last item in the list.
18462     *
18463     * @return The last item, or NULL if none
18464     *
18465     * @ingroup Genlist
18466     */
18467    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18468    /**
18469     * Set the scrollbar policy
18470     *
18471     * @param obj The genlist object
18472     * @param policy_h Horizontal scrollbar policy.
18473     * @param policy_v Vertical scrollbar policy.
18474     *
18475     * This sets the scrollbar visibility policy for the given genlist
18476     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18477     * made visible if it is needed, and otherwise kept hidden.
18478     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18479     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18480     * respectively for the horizontal and vertical scrollbars. Default is
18481     * #ELM_SMART_SCROLLER_POLICY_AUTO
18482     *
18483     * @see elm_genlist_scroller_policy_get()
18484     *
18485     * @ingroup Genlist
18486     */
18487    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18488    /**
18489     * Get the scrollbar policy
18490     *
18491     * @param obj The genlist object
18492     * @param policy_h Pointer to store the horizontal scrollbar policy.
18493     * @param policy_v Pointer to store the vertical scrollbar policy.
18494     *
18495     * @see elm_genlist_scroller_policy_set()
18496     *
18497     * @ingroup Genlist
18498     */
18499    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);
18500    /**
18501     * Get the @b next item in a genlist widget's internal list of items,
18502     * given a handle to one of those items.
18503     *
18504     * @param item The genlist item to fetch next from
18505     * @return The item after @p item, or @c NULL if there's none (and
18506     * on errors)
18507     *
18508     * This returns the item placed after the @p item, on the container
18509     * genlist.
18510     *
18511     * @see elm_genlist_item_prev_get()
18512     *
18513     * @ingroup Genlist
18514     */
18515    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18516    /**
18517     * Get the @b previous item in a genlist widget's internal list of items,
18518     * given a handle to one of those items.
18519     *
18520     * @param item The genlist item to fetch previous from
18521     * @return The item before @p item, or @c NULL if there's none (and
18522     * on errors)
18523     *
18524     * This returns the item placed before the @p item, on the container
18525     * genlist.
18526     *
18527     * @see elm_genlist_item_next_get()
18528     *
18529     * @ingroup Genlist
18530     */
18531    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18532    /**
18533     * Get the genlist object's handle which contains a given genlist
18534     * item
18535     *
18536     * @param item The item to fetch the container from
18537     * @return The genlist (parent) object
18538     *
18539     * This returns the genlist object itself that an item belongs to.
18540     *
18541     * @ingroup Genlist
18542     */
18543    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18544    /**
18545     * Get the parent item of the given item
18546     *
18547     * @param it The item
18548     * @return The parent of the item or @c NULL if it has no parent.
18549     *
18550     * This returns the item that was specified as parent of the item @p it on
18551     * elm_genlist_item_append() and insertion related functions.
18552     *
18553     * @ingroup Genlist
18554     */
18555    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18556    /**
18557     * Remove all sub-items (children) of the given item
18558     *
18559     * @param it The item
18560     *
18561     * This removes all items that are children (and their descendants) of the
18562     * given item @p it.
18563     *
18564     * @see elm_genlist_clear()
18565     * @see elm_genlist_item_del()
18566     *
18567     * @ingroup Genlist
18568     */
18569    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18570    /**
18571     * Set whether a given genlist item is selected or not
18572     *
18573     * @param it The item
18574     * @param selected Use @c EINA_TRUE, to make it selected, @c
18575     * EINA_FALSE to make it unselected
18576     *
18577     * This sets the selected state of an item. If multi selection is
18578     * not enabled on the containing genlist and @p selected is @c
18579     * EINA_TRUE, any other previously selected items will get
18580     * unselected in favor of this new one.
18581     *
18582     * @see elm_genlist_item_selected_get()
18583     *
18584     * @ingroup Genlist
18585     */
18586    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18587    /**
18588     * Get whether a given genlist item is selected or not
18589     *
18590     * @param it The item
18591     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18592     *
18593     * @see elm_genlist_item_selected_set() for more details
18594     *
18595     * @ingroup Genlist
18596     */
18597    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18598    /**
18599     * Sets the expanded state of an item.
18600     *
18601     * @param it The item
18602     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18603     *
18604     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18605     * expanded or not.
18606     *
18607     * The theme will respond to this change visually, and a signal "expanded" or
18608     * "contracted" will be sent from the genlist with a pointer to the item that
18609     * has been expanded/contracted.
18610     *
18611     * Calling this function won't show or hide any child of this item (if it is
18612     * a parent). You must manually delete and create them on the callbacks fo
18613     * the "expanded" or "contracted" signals.
18614     *
18615     * @see elm_genlist_item_expanded_get()
18616     *
18617     * @ingroup Genlist
18618     */
18619    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18620    /**
18621     * Get the expanded state of an item
18622     *
18623     * @param it The item
18624     * @return The expanded state
18625     *
18626     * This gets the expanded state of an item.
18627     *
18628     * @see elm_genlist_item_expanded_set()
18629     *
18630     * @ingroup Genlist
18631     */
18632    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18633    /**
18634     * Get the depth of expanded item
18635     *
18636     * @param it The genlist item object
18637     * @return The depth of expanded item
18638     *
18639     * @ingroup Genlist
18640     */
18641    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18642    /**
18643     * Set whether a given genlist item is disabled or not.
18644     *
18645     * @param it The item
18646     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18647     * to enable it back.
18648     *
18649     * A disabled item cannot be selected or unselected. It will also
18650     * change its appearance, to signal the user it's disabled.
18651     *
18652     * @see elm_genlist_item_disabled_get()
18653     *
18654     * @ingroup Genlist
18655     */
18656    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18657    /**
18658     * Get whether a given genlist item is disabled or not.
18659     *
18660     * @param it The item
18661     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18662     * (and on errors).
18663     *
18664     * @see elm_genlist_item_disabled_set() for more details
18665     *
18666     * @ingroup Genlist
18667     */
18668    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18669    /**
18670     * Sets the display only state of an item.
18671     *
18672     * @param it The item
18673     * @param display_only @c EINA_TRUE if the item is display only, @c
18674     * EINA_FALSE otherwise.
18675     *
18676     * A display only item cannot be selected or unselected. It is for
18677     * display only and not selecting or otherwise clicking, dragging
18678     * etc. by the user, thus finger size rules will not be applied to
18679     * this item.
18680     *
18681     * It's good to set group index items to display only state.
18682     *
18683     * @see elm_genlist_item_display_only_get()
18684     *
18685     * @ingroup Genlist
18686     */
18687    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18688    /**
18689     * Get the display only state of an item
18690     *
18691     * @param it The item
18692     * @return @c EINA_TRUE if the item is display only, @c
18693     * EINA_FALSE otherwise.
18694     *
18695     * @see elm_genlist_item_display_only_set()
18696     *
18697     * @ingroup Genlist
18698     */
18699    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18700    /**
18701     * Show the portion of a genlist's internal list containing a given
18702     * item, immediately.
18703     *
18704     * @param it The item to display
18705     *
18706     * This causes genlist to jump to the given item @p it and show it (by
18707     * immediately scrolling to that position), if it is not fully visible.
18708     *
18709     * @see elm_genlist_item_bring_in()
18710     * @see elm_genlist_item_top_show()
18711     * @see elm_genlist_item_middle_show()
18712     *
18713     * @ingroup Genlist
18714     */
18715    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18716    /**
18717     * Animatedly bring in, to the visible are of a genlist, a given
18718     * item on it.
18719     *
18720     * @param it The item to display
18721     *
18722     * This causes genlist to jump to the given item @p it and show it (by
18723     * animatedly scrolling), if it is not fully visible. This may use animation
18724     * to do so and take a period of time
18725     *
18726     * @see elm_genlist_item_show()
18727     * @see elm_genlist_item_top_bring_in()
18728     * @see elm_genlist_item_middle_bring_in()
18729     *
18730     * @ingroup Genlist
18731     */
18732    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18733    /**
18734     * Show the portion of a genlist's internal list containing a given
18735     * item, immediately.
18736     *
18737     * @param it The item to display
18738     *
18739     * This causes genlist to jump to the given item @p it and show it (by
18740     * immediately scrolling to that position), if it is not fully visible.
18741     *
18742     * The item will be positioned at the top of the genlist viewport.
18743     *
18744     * @see elm_genlist_item_show()
18745     * @see elm_genlist_item_top_bring_in()
18746     *
18747     * @ingroup Genlist
18748     */
18749    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18750    /**
18751     * Animatedly bring in, to the visible are of a genlist, a given
18752     * item on it.
18753     *
18754     * @param it The item
18755     *
18756     * This causes genlist to jump to the given item @p it and show it (by
18757     * animatedly scrolling), if it is not fully visible. This may use animation
18758     * to do so and take a period of time
18759     *
18760     * The item will be positioned at the top of the genlist viewport.
18761     *
18762     * @see elm_genlist_item_bring_in()
18763     * @see elm_genlist_item_top_show()
18764     *
18765     * @ingroup Genlist
18766     */
18767    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18768    /**
18769     * Show the portion of a genlist's internal list containing a given
18770     * item, immediately.
18771     *
18772     * @param it The item to display
18773     *
18774     * This causes genlist to jump to the given item @p it and show it (by
18775     * immediately scrolling to that position), if it is not fully visible.
18776     *
18777     * The item will be positioned at the middle of the genlist viewport.
18778     *
18779     * @see elm_genlist_item_show()
18780     * @see elm_genlist_item_middle_bring_in()
18781     *
18782     * @ingroup Genlist
18783     */
18784    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18785    /**
18786     * Animatedly bring in, to the visible are of a genlist, a given
18787     * item on it.
18788     *
18789     * @param it The item
18790     *
18791     * This causes genlist to jump to the given item @p it and show it (by
18792     * animatedly scrolling), if it is not fully visible. This may use animation
18793     * to do so and take a period of time
18794     *
18795     * The item will be positioned at the middle of the genlist viewport.
18796     *
18797     * @see elm_genlist_item_bring_in()
18798     * @see elm_genlist_item_middle_show()
18799     *
18800     * @ingroup Genlist
18801     */
18802    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18803    /**
18804     * Remove a genlist item from the its parent, deleting it.
18805     *
18806     * @param item The item to be removed.
18807     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18808     *
18809     * @see elm_genlist_clear(), to remove all items in a genlist at
18810     * once.
18811     *
18812     * @ingroup Genlist
18813     */
18814    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18815    /**
18816     * Return the data associated to a given genlist item
18817     *
18818     * @param item The genlist item.
18819     * @return the data associated to this item.
18820     *
18821     * This returns the @c data value passed on the
18822     * elm_genlist_item_append() and related item addition calls.
18823     *
18824     * @see elm_genlist_item_append()
18825     * @see elm_genlist_item_data_set()
18826     *
18827     * @ingroup Genlist
18828     */
18829    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18830    /**
18831     * Set the data associated to a given genlist item
18832     *
18833     * @param item The genlist item
18834     * @param data The new data pointer to set on it
18835     *
18836     * This @b overrides the @c data value passed on the
18837     * elm_genlist_item_append() and related item addition calls. This
18838     * function @b won't call elm_genlist_item_update() automatically,
18839     * so you'd issue it afterwards if you want to hove the item
18840     * updated to reflect the that new data.
18841     *
18842     * @see elm_genlist_item_data_get()
18843     *
18844     * @ingroup Genlist
18845     */
18846    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18847    /**
18848     * Tells genlist to "orphan" icons fetchs by the item class
18849     *
18850     * @param it The item
18851     *
18852     * This instructs genlist to release references to icons in the item,
18853     * meaning that they will no longer be managed by genlist and are
18854     * floating "orphans" that can be re-used elsewhere if the user wants
18855     * to.
18856     *
18857     * @ingroup Genlist
18858     */
18859    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18860    /**
18861     * Get the real Evas object created to implement the view of a
18862     * given genlist item
18863     *
18864     * @param item The genlist item.
18865     * @return the Evas object implementing this item's view.
18866     *
18867     * This returns the actual Evas object used to implement the
18868     * specified genlist item's view. This may be @c NULL, as it may
18869     * not have been created or may have been deleted, at any time, by
18870     * the genlist. <b>Do not modify this object</b> (move, resize,
18871     * show, hide, etc.), as the genlist is controlling it. This
18872     * function is for querying, emitting custom signals or hooking
18873     * lower level callbacks for events on that object. Do not delete
18874     * this object under any circumstances.
18875     *
18876     * @see elm_genlist_item_data_get()
18877     *
18878     * @ingroup Genlist
18879     */
18880    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18881    /**
18882     * Update the contents of an item
18883     *
18884     * @param it The item
18885     *
18886     * This updates an item by calling all the item class functions again
18887     * to get the icons, labels and states. Use this when the original
18888     * item data has changed and the changes are desired to be reflected.
18889     *
18890     * Use elm_genlist_realized_items_update() to update all already realized
18891     * items.
18892     *
18893     * @see elm_genlist_realized_items_update()
18894     *
18895     * @ingroup Genlist
18896     */
18897    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18898    /**
18899     * Update the item class of an item
18900     *
18901     * @param it The item
18902     * @param itc The item class for the item
18903     *
18904     * This sets another class fo the item, changing the way that it is
18905     * displayed. After changing the item class, elm_genlist_item_update() is
18906     * called on the item @p it.
18907     *
18908     * @ingroup Genlist
18909     */
18910    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18911    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18912    /**
18913     * Set the text to be shown in a given genlist item's tooltips.
18914     *
18915     * @param item The genlist item
18916     * @param text The text to set in the content
18917     *
18918     * This call will setup the text to be used as tooltip to that item
18919     * (analogous to elm_object_tooltip_text_set(), but being item
18920     * tooltips with higher precedence than object tooltips). It can
18921     * have only one tooltip at a time, so any previous tooltip data
18922     * will get removed.
18923     *
18924     * In order to set an icon or something else as a tooltip, look at
18925     * elm_genlist_item_tooltip_content_cb_set().
18926     *
18927     * @ingroup Genlist
18928     */
18929    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18930    /**
18931     * Set the content to be shown in a given genlist item's tooltips
18932     *
18933     * @param item The genlist item.
18934     * @param func The function returning the tooltip contents.
18935     * @param data What to provide to @a func as callback data/context.
18936     * @param del_cb Called when data is not needed anymore, either when
18937     *        another callback replaces @p func, the tooltip is unset with
18938     *        elm_genlist_item_tooltip_unset() or the owner @p item
18939     *        dies. This callback receives as its first parameter the
18940     *        given @p data, being @c event_info the item handle.
18941     *
18942     * This call will setup the tooltip's contents to @p item
18943     * (analogous to elm_object_tooltip_content_cb_set(), but being
18944     * item tooltips with higher precedence than object tooltips). It
18945     * can have only one tooltip at a time, so any previous tooltip
18946     * content will get removed. @p func (with @p data) will be called
18947     * every time Elementary needs to show the tooltip and it should
18948     * return a valid Evas object, which will be fully managed by the
18949     * tooltip system, getting deleted when the tooltip is gone.
18950     *
18951     * In order to set just a text as a tooltip, look at
18952     * elm_genlist_item_tooltip_text_set().
18953     *
18954     * @ingroup Genlist
18955     */
18956    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);
18957    /**
18958     * Unset a tooltip from a given genlist item
18959     *
18960     * @param item genlist item to remove a previously set tooltip from.
18961     *
18962     * This call removes any tooltip set on @p item. The callback
18963     * provided as @c del_cb to
18964     * elm_genlist_item_tooltip_content_cb_set() will be called to
18965     * notify it is not used anymore (and have resources cleaned, if
18966     * need be).
18967     *
18968     * @see elm_genlist_item_tooltip_content_cb_set()
18969     *
18970     * @ingroup Genlist
18971     */
18972    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18973    /**
18974     * Set a different @b style for a given genlist item's tooltip.
18975     *
18976     * @param item genlist item with tooltip set
18977     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18978     * "default", @c "transparent", etc)
18979     *
18980     * Tooltips can have <b>alternate styles</b> to be displayed on,
18981     * which are defined by the theme set on Elementary. This function
18982     * works analogously as elm_object_tooltip_style_set(), but here
18983     * applied only to genlist item objects. The default style for
18984     * tooltips is @c "default".
18985     *
18986     * @note before you set a style you should define a tooltip with
18987     *       elm_genlist_item_tooltip_content_cb_set() or
18988     *       elm_genlist_item_tooltip_text_set()
18989     *
18990     * @see elm_genlist_item_tooltip_style_get()
18991     *
18992     * @ingroup Genlist
18993     */
18994    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18995    /**
18996     * Get the style set a given genlist item's tooltip.
18997     *
18998     * @param item genlist item with tooltip already set on.
18999     * @return style the theme style in use, which defaults to
19000     *         "default". If the object does not have a tooltip set,
19001     *         then @c NULL is returned.
19002     *
19003     * @see elm_genlist_item_tooltip_style_set() for more details
19004     *
19005     * @ingroup Genlist
19006     */
19007    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19008    /**
19009     * @brief Disable size restrictions on an object's tooltip
19010     * @param item The tooltip's anchor object
19011     * @param disable If EINA_TRUE, size restrictions are disabled
19012     * @return EINA_FALSE on failure, EINA_TRUE on success
19013     *
19014     * This function allows a tooltip to expand beyond its parant window's canvas.
19015     * It will instead be limited only by the size of the display.
19016     */
19017    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19018    /**
19019     * @brief Retrieve size restriction state of an object's tooltip
19020     * @param item The tooltip's anchor object
19021     * @return If EINA_TRUE, size restrictions are disabled
19022     *
19023     * This function returns whether a tooltip is allowed to expand beyond
19024     * its parant window's canvas.
19025     * It will instead be limited only by the size of the display.
19026     */
19027    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19028    /**
19029     * Set the type of mouse pointer/cursor decoration to be shown,
19030     * when the mouse pointer is over the given genlist widget item
19031     *
19032     * @param item genlist item to customize cursor on
19033     * @param cursor the cursor type's name
19034     *
19035     * This function works analogously as elm_object_cursor_set(), but
19036     * here the cursor's changing area is restricted to the item's
19037     * area, and not the whole widget's. Note that that item cursors
19038     * have precedence over widget cursors, so that a mouse over @p
19039     * item will always show cursor @p type.
19040     *
19041     * If this function is called twice for an object, a previously set
19042     * cursor will be unset on the second call.
19043     *
19044     * @see elm_object_cursor_set()
19045     * @see elm_genlist_item_cursor_get()
19046     * @see elm_genlist_item_cursor_unset()
19047     *
19048     * @ingroup Genlist
19049     */
19050    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19051    /**
19052     * Get the type of mouse pointer/cursor decoration set to be shown,
19053     * when the mouse pointer is over the given genlist widget item
19054     *
19055     * @param item genlist item with custom cursor set
19056     * @return the cursor type's name or @c NULL, if no custom cursors
19057     * were set to @p item (and on errors)
19058     *
19059     * @see elm_object_cursor_get()
19060     * @see elm_genlist_item_cursor_set() for more details
19061     * @see elm_genlist_item_cursor_unset()
19062     *
19063     * @ingroup Genlist
19064     */
19065    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19066    /**
19067     * Unset any custom mouse pointer/cursor decoration set to be
19068     * shown, when the mouse pointer is over the given genlist widget
19069     * item, thus making it show the @b default cursor again.
19070     *
19071     * @param item a genlist item
19072     *
19073     * Use this call to undo any custom settings on this item's cursor
19074     * decoration, bringing it back to defaults (no custom style set).
19075     *
19076     * @see elm_object_cursor_unset()
19077     * @see elm_genlist_item_cursor_set() for more details
19078     *
19079     * @ingroup Genlist
19080     */
19081    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19082    /**
19083     * Set a different @b style for a given custom cursor set for a
19084     * genlist item.
19085     *
19086     * @param item genlist item with custom cursor set
19087     * @param style the <b>theme style</b> to use (e.g. @c "default",
19088     * @c "transparent", etc)
19089     *
19090     * This function only makes sense when one is using custom mouse
19091     * cursor decorations <b>defined in a theme file</b> , which can
19092     * have, given a cursor name/type, <b>alternate styles</b> on
19093     * it. It works analogously as elm_object_cursor_style_set(), but
19094     * here applied only to genlist item objects.
19095     *
19096     * @warning Before you set a cursor style you should have defined a
19097     *       custom cursor previously on the item, with
19098     *       elm_genlist_item_cursor_set()
19099     *
19100     * @see elm_genlist_item_cursor_engine_only_set()
19101     * @see elm_genlist_item_cursor_style_get()
19102     *
19103     * @ingroup Genlist
19104     */
19105    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19106    /**
19107     * Get the current @b style set for a given genlist item's custom
19108     * cursor
19109     *
19110     * @param item genlist item with custom cursor set.
19111     * @return style the cursor style in use. If the object does not
19112     *         have a cursor set, then @c NULL is returned.
19113     *
19114     * @see elm_genlist_item_cursor_style_set() for more details
19115     *
19116     * @ingroup Genlist
19117     */
19118    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19119    /**
19120     * Set if the (custom) cursor for a given genlist item should be
19121     * searched in its theme, also, or should only rely on the
19122     * rendering engine.
19123     *
19124     * @param item item with custom (custom) cursor already set on
19125     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19126     * only on those provided by the rendering engine, @c EINA_FALSE to
19127     * have them searched on the widget's theme, as well.
19128     *
19129     * @note This call is of use only if you've set a custom cursor
19130     * for genlist items, with elm_genlist_item_cursor_set().
19131     *
19132     * @note By default, cursors will only be looked for between those
19133     * provided by the rendering engine.
19134     *
19135     * @ingroup Genlist
19136     */
19137    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19138    /**
19139     * Get if the (custom) cursor for a given genlist item is being
19140     * searched in its theme, also, or is only relying on the rendering
19141     * engine.
19142     *
19143     * @param item a genlist item
19144     * @return @c EINA_TRUE, if cursors are being looked for only on
19145     * those provided by the rendering engine, @c EINA_FALSE if they
19146     * are being searched on the widget's theme, as well.
19147     *
19148     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19149     *
19150     * @ingroup Genlist
19151     */
19152    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19153    /**
19154     * Update the contents of all realized items.
19155     *
19156     * @param obj The genlist object.
19157     *
19158     * This updates all realized items by calling all the item class functions again
19159     * to get the icons, labels and states. Use this when the original
19160     * item data has changed and the changes are desired to be reflected.
19161     *
19162     * To update just one item, use elm_genlist_item_update().
19163     *
19164     * @see elm_genlist_realized_items_get()
19165     * @see elm_genlist_item_update()
19166     *
19167     * @ingroup Genlist
19168     */
19169    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19170    /**
19171     * Activate a genlist mode on an item
19172     *
19173     * @param item The genlist item
19174     * @param mode Mode name
19175     * @param mode_set Boolean to define set or unset mode.
19176     *
19177     * A genlist mode is a different way of selecting an item. Once a mode is
19178     * activated on an item, any other selected item is immediately unselected.
19179     * This feature provides an easy way of implementing a new kind of animation
19180     * for selecting an item, without having to entirely rewrite the item style
19181     * theme. However, the elm_genlist_selected_* API can't be used to get what
19182     * item is activate for a mode.
19183     *
19184     * The current item style will still be used, but applying a genlist mode to
19185     * an item will select it using a different kind of animation.
19186     *
19187     * The current active item for a mode can be found by
19188     * elm_genlist_mode_item_get().
19189     *
19190     * The characteristics of genlist mode are:
19191     * - Only one mode can be active at any time, and for only one item.
19192     * - Genlist handles deactivating other items when one item is activated.
19193     * - A mode is defined in the genlist theme (edc), and more modes can easily
19194     *   be added.
19195     * - A mode style and the genlist item style are different things. They
19196     *   can be combined to provide a default style to the item, with some kind
19197     *   of animation for that item when the mode is activated.
19198     *
19199     * When a mode is activated on an item, a new view for that item is created.
19200     * The theme of this mode defines the animation that will be used to transit
19201     * the item from the old view to the new view. This second (new) view will be
19202     * active for that item while the mode is active on the item, and will be
19203     * destroyed after the mode is totally deactivated from that item.
19204     *
19205     * @see elm_genlist_mode_get()
19206     * @see elm_genlist_mode_item_get()
19207     *
19208     * @ingroup Genlist
19209     */
19210    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19211    /**
19212     * Get the last (or current) genlist mode used.
19213     *
19214     * @param obj The genlist object
19215     *
19216     * This function just returns the name of the last used genlist mode. It will
19217     * be the current mode if it's still active.
19218     *
19219     * @see elm_genlist_item_mode_set()
19220     * @see elm_genlist_mode_item_get()
19221     *
19222     * @ingroup Genlist
19223     */
19224    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19225    /**
19226     * Get active genlist mode item
19227     *
19228     * @param obj The genlist object
19229     * @return The active item for that current mode. Or @c NULL if no item is
19230     * activated with any mode.
19231     *
19232     * This function returns the item that was activated with a mode, by the
19233     * function elm_genlist_item_mode_set().
19234     *
19235     * @see elm_genlist_item_mode_set()
19236     * @see elm_genlist_mode_get()
19237     *
19238     * @ingroup Genlist
19239     */
19240    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19241
19242    /**
19243     * Set reorder mode
19244     *
19245     * @param obj The genlist object
19246     * @param reorder_mode The reorder mode
19247     * (EINA_TRUE = on, EINA_FALSE = off)
19248     *
19249     * @ingroup Genlist
19250     */
19251    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19252
19253    /**
19254     * Get the reorder mode
19255     *
19256     * @param obj The genlist object
19257     * @return The reorder mode
19258     * (EINA_TRUE = on, EINA_FALSE = off)
19259     *
19260     * @ingroup Genlist
19261     */
19262    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19263
19264    /**
19265     * @}
19266     */
19267
19268    /**
19269     * @defgroup Check Check
19270     *
19271     * @image html img/widget/check/preview-00.png
19272     * @image latex img/widget/check/preview-00.eps
19273     * @image html img/widget/check/preview-01.png
19274     * @image latex img/widget/check/preview-01.eps
19275     * @image html img/widget/check/preview-02.png
19276     * @image latex img/widget/check/preview-02.eps
19277     *
19278     * @brief The check widget allows for toggling a value between true and
19279     * false.
19280     *
19281     * Check objects are a lot like radio objects in layout and functionality
19282     * except they do not work as a group, but independently and only toggle the
19283     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19284     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19285     * returns the current state. For convenience, like the radio objects, you
19286     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19287     * for it to modify.
19288     *
19289     * Signals that you can add callbacks for are:
19290     * "changed" - This is called whenever the user changes the state of one of
19291     *             the check object(event_info is NULL).
19292     *
19293     * @ref tutorial_check should give you a firm grasp of how to use this widget.
19294     * @{
19295     */
19296    /**
19297     * @brief Add a new Check object
19298     *
19299     * @param parent The parent object
19300     * @return The new object or NULL if it cannot be created
19301     */
19302    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19303    /**
19304     * @brief Set the text label of the check object
19305     *
19306     * @param obj The check object
19307     * @param label The text label string in UTF-8
19308     *
19309     * @deprecated use elm_object_text_set() instead.
19310     */
19311    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19312    /**
19313     * @brief Get the text label of the check object
19314     *
19315     * @param obj The check object
19316     * @return The text label string in UTF-8
19317     *
19318     * @deprecated use elm_object_text_get() instead.
19319     */
19320    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19321    /**
19322     * @brief Set the icon object of the check object
19323     *
19324     * @param obj The check object
19325     * @param icon The icon object
19326     *
19327     * Once the icon object is set, a previously set one will be deleted.
19328     * If you want to keep that old content object, use the
19329     * elm_check_icon_unset() function.
19330     */
19331    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19332    /**
19333     * @brief Get the icon object of the check object
19334     *
19335     * @param obj The check object
19336     * @return The icon object
19337     */
19338    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19339    /**
19340     * @brief Unset the icon used for the check object
19341     *
19342     * @param obj The check object
19343     * @return The icon object that was being used
19344     *
19345     * Unparent and return the icon object which was set for this widget.
19346     */
19347    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19348    /**
19349     * @brief Set the on/off state of the check object
19350     *
19351     * @param obj The check object
19352     * @param state The state to use (1 == on, 0 == off)
19353     *
19354     * This sets the state of the check. If set
19355     * with elm_check_state_pointer_set() the state of that variable is also
19356     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19357     */
19358    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19359    /**
19360     * @brief Get the state of the check object
19361     *
19362     * @param obj The check object
19363     * @return The boolean state
19364     */
19365    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19366    /**
19367     * @brief Set a convenience pointer to a boolean to change
19368     *
19369     * @param obj The check object
19370     * @param statep Pointer to the boolean to modify
19371     *
19372     * This sets a pointer to a boolean, that, in addition to the check objects
19373     * state will also be modified directly. To stop setting the object pointed
19374     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19375     * then when this is called, the check objects state will also be modified to
19376     * reflect the value of the boolean @p statep points to, just like calling
19377     * elm_check_state_set().
19378     */
19379    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19380    /**
19381     * @}
19382     */
19383
19384    /**
19385     * @defgroup Radio Radio
19386     *
19387     * @image html img/widget/radio/preview-00.png
19388     * @image latex img/widget/radio/preview-00.eps
19389     *
19390     * @brief Radio is a widget that allows for 1 or more options to be displayed
19391     * and have the user choose only 1 of them.
19392     *
19393     * A radio object contains an indicator, an optional Label and an optional
19394     * icon object. While it's possible to have a group of only one radio they,
19395     * are normally used in groups of 2 or more. To add a radio to a group use
19396     * elm_radio_group_add(). The radio object(s) will select from one of a set
19397     * of integer values, so any value they are configuring needs to be mapped to
19398     * a set of integers. To configure what value that radio object represents,
19399     * use  elm_radio_state_value_set() to set the integer it represents. To set
19400     * the value the whole group(which one is currently selected) is to indicate
19401     * use elm_radio_value_set() on any group member, and to get the groups value
19402     * use elm_radio_value_get(). For convenience the radio objects are also able
19403     * to directly set an integer(int) to the value that is selected. To specify
19404     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19405     * The radio objects will modify this directly. That implies the pointer must
19406     * point to valid memory for as long as the radio objects exist.
19407     *
19408     * Signals that you can add callbacks for are:
19409     * @li changed - This is called whenever the user changes the state of one of
19410     * the radio objects within the group of radio objects that work together.
19411     *
19412     * @ref tutorial_radio show most of this API in action.
19413     * @{
19414     */
19415    /**
19416     * @brief Add a new radio to the parent
19417     *
19418     * @param parent The parent object
19419     * @return The new object or NULL if it cannot be created
19420     */
19421    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19422    /**
19423     * @brief Set the text label of the radio object
19424     *
19425     * @param obj The radio object
19426     * @param label The text label string in UTF-8
19427     *
19428     * @deprecated use elm_object_text_set() instead.
19429     */
19430    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19431    /**
19432     * @brief Get the text label of the radio object
19433     *
19434     * @param obj The radio object
19435     * @return The text label string in UTF-8
19436     *
19437     * @deprecated use elm_object_text_set() instead.
19438     */
19439    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19440    /**
19441     * @brief Set the icon object of the radio object
19442     *
19443     * @param obj The radio object
19444     * @param icon The icon object
19445     *
19446     * Once the icon object is set, a previously set one will be deleted. If you
19447     * want to keep that old content object, use the elm_radio_icon_unset()
19448     * function.
19449     */
19450    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19451    /**
19452     * @brief Get the icon object of the radio object
19453     *
19454     * @param obj The radio object
19455     * @return The icon object
19456     *
19457     * @see elm_radio_icon_set()
19458     */
19459    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19460    /**
19461     * @brief Unset the icon used for the radio object
19462     *
19463     * @param obj The radio object
19464     * @return The icon object that was being used
19465     *
19466     * Unparent and return the icon object which was set for this widget.
19467     *
19468     * @see elm_radio_icon_set()
19469     */
19470    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19471    /**
19472     * @brief Add this radio to a group of other radio objects
19473     *
19474     * @param obj The radio object
19475     * @param group Any object whose group the @p obj is to join.
19476     *
19477     * Radio objects work in groups. Each member should have a different integer
19478     * value assigned. In order to have them work as a group, they need to know
19479     * about each other. This adds the given radio object to the group of which
19480     * the group object indicated is a member.
19481     */
19482    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19483    /**
19484     * @brief Set the integer value that this radio object represents
19485     *
19486     * @param obj The radio object
19487     * @param value The value to use if this radio object is selected
19488     *
19489     * This sets the value of the radio.
19490     */
19491    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19492    /**
19493     * @brief Get the integer value that this radio object represents
19494     *
19495     * @param obj The radio object
19496     * @return The value used if this radio object is selected
19497     *
19498     * This gets the value of the radio.
19499     *
19500     * @see elm_radio_value_set()
19501     */
19502    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19503    /**
19504     * @brief Set the value of the radio.
19505     *
19506     * @param obj The radio object
19507     * @param value The value to use for the group
19508     *
19509     * This sets the value of the radio group and will also set the value if
19510     * pointed to, to the value supplied, but will not call any callbacks.
19511     */
19512    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19513    /**
19514     * @brief Get the state of the radio object
19515     *
19516     * @param obj The radio object
19517     * @return The integer state
19518     */
19519    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19520    /**
19521     * @brief Set a convenience pointer to a integer to change
19522     *
19523     * @param obj The radio object
19524     * @param valuep Pointer to the integer to modify
19525     *
19526     * This sets a pointer to a integer, that, in addition to the radio objects
19527     * state will also be modified directly. To stop setting the object pointed
19528     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19529     * when this is called, the radio objects state will also be modified to
19530     * reflect the value of the integer valuep points to, just like calling
19531     * elm_radio_value_set().
19532     */
19533    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19534    /**
19535     * @}
19536     */
19537
19538    /**
19539     * @defgroup Pager Pager
19540     *
19541     * @image html img/widget/pager/preview-00.png
19542     * @image latex img/widget/pager/preview-00.eps
19543     *
19544     * @brief Widget that allows flipping between 1 or more “pages” of objects.
19545     *
19546     * The flipping between “pages” of objects is animated. All content in pager
19547     * is kept in a stack, the last content to be added will be on the top of the
19548     * stack(be visible).
19549     *
19550     * Objects can be pushed or popped from the stack or deleted as normal.
19551     * Pushes and pops will animate (and a pop will delete the object once the
19552     * animation is finished). Any object already in the pager can be promoted to
19553     * the top(from its current stacking position) through the use of
19554     * elm_pager_content_promote(). Objects are pushed to the top with
19555     * elm_pager_content_push() and when the top item is no longer wanted, simply
19556     * pop it with elm_pager_content_pop() and it will also be deleted. If an
19557     * object is no longer needed and is not the top item, just delete it as
19558     * normal. You can query which objects are the top and bottom with
19559     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19560     *
19561     * Signals that you can add callbacks for are:
19562     * "hide,finished" - when the previous page is hided
19563     *
19564     * This widget has the following styles available:
19565     * @li default
19566     * @li fade
19567     * @li fade_translucide
19568     * @li fade_invisible
19569     * @note This styles affect only the flipping animations, the appearance when
19570     * not animating is unaffected by styles.
19571     *
19572     * @ref tutorial_pager gives a good overview of the usage of the API.
19573     * @{
19574     */
19575    /**
19576     * Add a new pager to the parent
19577     *
19578     * @param parent The parent object
19579     * @return The new object or NULL if it cannot be created
19580     *
19581     * @ingroup Pager
19582     */
19583    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19584    /**
19585     * @brief Push an object to the top of the pager stack (and show it).
19586     *
19587     * @param obj The pager object
19588     * @param content The object to push
19589     *
19590     * The object pushed becomes a child of the pager, it will be controlled and
19591     * deleted when the pager is deleted.
19592     *
19593     * @note If the content is already in the stack use
19594     * elm_pager_content_promote().
19595     * @warning Using this function on @p content already in the stack results in
19596     * undefined behavior.
19597     */
19598    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19599    /**
19600     * @brief Pop the object that is on top of the stack
19601     *
19602     * @param obj The pager object
19603     *
19604     * This pops the object that is on the top(visible) of the pager, makes it
19605     * disappear, then deletes the object. The object that was underneath it on
19606     * the stack will become visible.
19607     */
19608    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19609    /**
19610     * @brief Moves an object already in the pager stack to the top of the stack.
19611     *
19612     * @param obj The pager object
19613     * @param content The object to promote
19614     *
19615     * This will take the @p content and move it to the top of the stack as
19616     * if it had been pushed there.
19617     *
19618     * @note If the content isn't already in the stack use
19619     * elm_pager_content_push().
19620     * @warning Using this function on @p content not already in the stack
19621     * results in undefined behavior.
19622     */
19623    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19624    /**
19625     * @brief Return the object at the bottom of the pager stack
19626     *
19627     * @param obj The pager object
19628     * @return The bottom object or NULL if none
19629     */
19630    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19631    /**
19632     * @brief  Return the object at the top of the pager stack
19633     *
19634     * @param obj The pager object
19635     * @return The top object or NULL if none
19636     */
19637    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19638    /**
19639     * @}
19640     */
19641
19642    /**
19643     * @defgroup Slideshow Slideshow
19644     *
19645     * @image html img/widget/slideshow/preview-00.png
19646     * @image latex img/widget/slideshow/preview-00.eps
19647     *
19648     * This widget, as the name indicates, is a pre-made image
19649     * slideshow panel, with API functions acting on (child) image
19650     * items presentation. Between those actions, are:
19651     * - advance to next/previous image
19652     * - select the style of image transition animation
19653     * - set the exhibition time for each image
19654     * - start/stop the slideshow
19655     *
19656     * The transition animations are defined in the widget's theme,
19657     * consequently new animations can be added without having to
19658     * update the widget's code.
19659     *
19660     * @section Slideshow_Items Slideshow items
19661     *
19662     * For slideshow items, just like for @ref Genlist "genlist" ones,
19663     * the user defines a @b classes, specifying functions that will be
19664     * called on the item's creation and deletion times.
19665     *
19666     * The #Elm_Slideshow_Item_Class structure contains the following
19667     * members:
19668     *
19669     * - @c func.get - When an item is displayed, this function is
19670     *   called, and it's where one should create the item object, de
19671     *   facto. For example, the object can be a pure Evas image object
19672     *   or an Elementary @ref Photocam "photocam" widget. See
19673     *   #SlideshowItemGetFunc.
19674     * - @c func.del - When an item is no more displayed, this function
19675     *   is called, where the user must delete any data associated to
19676     *   the item. See #SlideshowItemDelFunc.
19677     *
19678     * @section Slideshow_Caching Slideshow caching
19679     *
19680     * The slideshow provides facilities to have items adjacent to the
19681     * one being displayed <b>already "realized"</b> (i.e. loaded) for
19682     * you, so that the system does not have to decode image data
19683     * anymore at the time it has to actually switch images on its
19684     * viewport. The user is able to set the numbers of items to be
19685     * cached @b before and @b after the current item, in the widget's
19686     * item list.
19687     *
19688     * Smart events one can add callbacks for are:
19689     *
19690     * - @c "changed" - when the slideshow switches its view to a new
19691     *   item
19692     *
19693     * List of examples for the slideshow widget:
19694     * @li @ref slideshow_example
19695     */
19696
19697    /**
19698     * @addtogroup Slideshow
19699     * @{
19700     */
19701
19702    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19703    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19704    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
19705    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19706    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19707
19708    /**
19709     * @struct _Elm_Slideshow_Item_Class
19710     *
19711     * Slideshow item class definition. See @ref Slideshow_Items for
19712     * field details.
19713     */
19714    struct _Elm_Slideshow_Item_Class
19715      {
19716         struct _Elm_Slideshow_Item_Class_Func
19717           {
19718              SlideshowItemGetFunc get;
19719              SlideshowItemDelFunc del;
19720           } func;
19721      }; /**< #Elm_Slideshow_Item_Class member definitions */
19722
19723    /**
19724     * Add a new slideshow widget to the given parent Elementary
19725     * (container) object
19726     *
19727     * @param parent The parent object
19728     * @return A new slideshow widget handle or @c NULL, on errors
19729     *
19730     * This function inserts a new slideshow widget on the canvas.
19731     *
19732     * @ingroup Slideshow
19733     */
19734    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19735
19736    /**
19737     * Add (append) a new item in a given slideshow widget.
19738     *
19739     * @param obj The slideshow object
19740     * @param itc The item class for the item
19741     * @param data The item's data
19742     * @return A handle to the item added or @c NULL, on errors
19743     *
19744     * Add a new item to @p obj's internal list of items, appending it.
19745     * The item's class must contain the function really fetching the
19746     * image object to show for this item, which could be an Evas image
19747     * object or an Elementary photo, for example. The @p data
19748     * parameter is going to be passed to both class functions of the
19749     * item.
19750     *
19751     * @see #Elm_Slideshow_Item_Class
19752     * @see elm_slideshow_item_sorted_insert()
19753     *
19754     * @ingroup Slideshow
19755     */
19756    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19757
19758    /**
19759     * Insert a new item into the given slideshow widget, using the @p func
19760     * function to sort items (by item handles).
19761     *
19762     * @param obj The slideshow object
19763     * @param itc The item class for the item
19764     * @param data The item's data
19765     * @param func The comparing function to be used to sort slideshow
19766     * items <b>by #Elm_Slideshow_Item item handles</b>
19767     * @return Returns The slideshow item handle, on success, or
19768     * @c NULL, on errors
19769     *
19770     * Add a new item to @p obj's internal list of items, in a position
19771     * determined by the @p func comparing function. The item's class
19772     * must contain the function really fetching the image object to
19773     * show for this item, which could be an Evas image object or an
19774     * Elementary photo, for example. The @p data parameter is going to
19775     * be passed to both class functions of the item.
19776     *
19777     * @see #Elm_Slideshow_Item_Class
19778     * @see elm_slideshow_item_add()
19779     *
19780     * @ingroup Slideshow
19781     */
19782    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);
19783
19784    /**
19785     * Display a given slideshow widget's item, programmatically.
19786     *
19787     * @param obj The slideshow object
19788     * @param item The item to display on @p obj's viewport
19789     *
19790     * The change between the current item and @p item will use the
19791     * transition @p obj is set to use (@see
19792     * elm_slideshow_transition_set()).
19793     *
19794     * @ingroup Slideshow
19795     */
19796    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19797
19798    /**
19799     * Slide to the @b next item, in a given slideshow widget
19800     *
19801     * @param obj The slideshow object
19802     *
19803     * The sliding animation @p obj is set to use will be the
19804     * transition effect used, after this call is issued.
19805     *
19806     * @note If the end of the slideshow's internal list of items is
19807     * reached, it'll wrap around to the list's beginning, again.
19808     *
19809     * @ingroup Slideshow
19810     */
19811    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19812
19813    /**
19814     * Slide to the @b previous item, in a given slideshow widget
19815     *
19816     * @param obj The slideshow object
19817     *
19818     * The sliding animation @p obj is set to use will be the
19819     * transition effect used, after this call is issued.
19820     *
19821     * @note If the beginning of the slideshow's internal list of items
19822     * is reached, it'll wrap around to the list's end, again.
19823     *
19824     * @ingroup Slideshow
19825     */
19826    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19827
19828    /**
19829     * Returns the list of sliding transition/effect names available, for a
19830     * given slideshow widget.
19831     *
19832     * @param obj The slideshow object
19833     * @return The list of transitions (list of @b stringshared strings
19834     * as data)
19835     *
19836     * The transitions, which come from @p obj's theme, must be an EDC
19837     * data item named @c "transitions" on the theme file, with (prefix)
19838     * names of EDC programs actually implementing them.
19839     *
19840     * The available transitions for slideshows on the default theme are:
19841     * - @c "fade" - the current item fades out, while the new one
19842     *   fades in to the slideshow's viewport.
19843     * - @c "black_fade" - the current item fades to black, and just
19844     *   then, the new item will fade in.
19845     * - @c "horizontal" - the current item slides horizontally, until
19846     *   it gets out of the slideshow's viewport, while the new item
19847     *   comes from the left to take its place.
19848     * - @c "vertical" - the current item slides vertically, until it
19849     *   gets out of the slideshow's viewport, while the new item comes
19850     *   from the bottom to take its place.
19851     * - @c "square" - the new item starts to appear from the middle of
19852     *   the current one, but with a tiny size, growing until its
19853     *   target (full) size and covering the old one.
19854     *
19855     * @warning The stringshared strings get no new references
19856     * exclusive to the user grabbing the list, here, so if you'd like
19857     * to use them out of this call's context, you'd better @c
19858     * eina_stringshare_ref() them.
19859     *
19860     * @see elm_slideshow_transition_set()
19861     *
19862     * @ingroup Slideshow
19863     */
19864    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19865
19866    /**
19867     * Set the current slide transition/effect in use for a given
19868     * slideshow widget
19869     *
19870     * @param obj The slideshow object
19871     * @param transition The new transition's name string
19872     *
19873     * If @p transition is implemented in @p obj's theme (i.e., is
19874     * contained in the list returned by
19875     * elm_slideshow_transitions_get()), this new sliding effect will
19876     * be used on the widget.
19877     *
19878     * @see elm_slideshow_transitions_get() for more details
19879     *
19880     * @ingroup Slideshow
19881     */
19882    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19883
19884    /**
19885     * Get the current slide transition/effect in use for a given
19886     * slideshow widget
19887     *
19888     * @param obj The slideshow object
19889     * @return The current transition's name
19890     *
19891     * @see elm_slideshow_transition_set() for more details
19892     *
19893     * @ingroup Slideshow
19894     */
19895    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19896
19897    /**
19898     * Set the interval between each image transition on a given
19899     * slideshow widget, <b>and start the slideshow, itself</b>
19900     *
19901     * @param obj The slideshow object
19902     * @param timeout The new displaying timeout for images
19903     *
19904     * After this call, the slideshow widget will start cycling its
19905     * view, sequentially and automatically, with the images of the
19906     * items it has. The time between each new image displayed is going
19907     * to be @p timeout, in @b seconds. If a different timeout was set
19908     * previously and an slideshow was in progress, it will continue
19909     * with the new time between transitions, after this call.
19910     *
19911     * @note A value less than or equal to 0 on @p timeout will disable
19912     * the widget's internal timer, thus halting any slideshow which
19913     * could be happening on @p obj.
19914     *
19915     * @see elm_slideshow_timeout_get()
19916     *
19917     * @ingroup Slideshow
19918     */
19919    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19920
19921    /**
19922     * Get the interval set for image transitions on a given slideshow
19923     * widget.
19924     *
19925     * @param obj The slideshow object
19926     * @return Returns the timeout set on it
19927     *
19928     * @see elm_slideshow_timeout_set() for more details
19929     *
19930     * @ingroup Slideshow
19931     */
19932    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19933
19934    /**
19935     * Set if, after a slideshow is started, for a given slideshow
19936     * widget, its items should be displayed cyclically or not.
19937     *
19938     * @param obj The slideshow object
19939     * @param loop Use @c EINA_TRUE to make it cycle through items or
19940     * @c EINA_FALSE for it to stop at the end of @p obj's internal
19941     * list of items
19942     *
19943     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19944     * ignore what is set by this functions, i.e., they'll @b always
19945     * cycle through items. This affects only the "automatic"
19946     * slideshow, as set by elm_slideshow_timeout_set().
19947     *
19948     * @see elm_slideshow_loop_get()
19949     *
19950     * @ingroup Slideshow
19951     */
19952    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19953
19954    /**
19955     * Get if, after a slideshow is started, for a given slideshow
19956     * widget, its items are to be displayed cyclically or not.
19957     *
19958     * @param obj The slideshow object
19959     * @return @c EINA_TRUE, if the items in @p obj will be cycled
19960     * through or @c EINA_FALSE, otherwise
19961     *
19962     * @see elm_slideshow_loop_set() for more details
19963     *
19964     * @ingroup Slideshow
19965     */
19966    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19967
19968    /**
19969     * Remove all items from a given slideshow widget
19970     *
19971     * @param obj The slideshow object
19972     *
19973     * This removes (and deletes) all items in @p obj, leaving it
19974     * empty.
19975     *
19976     * @see elm_slideshow_item_del(), to remove just one item.
19977     *
19978     * @ingroup Slideshow
19979     */
19980    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19981
19982    /**
19983     * Get the internal list of items in a given slideshow widget.
19984     *
19985     * @param obj The slideshow object
19986     * @return The list of items (#Elm_Slideshow_Item as data) or
19987     * @c NULL on errors.
19988     *
19989     * This list is @b not to be modified in any way and must not be
19990     * freed. Use the list members with functions like
19991     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19992     *
19993     * @warning This list is only valid until @p obj object's internal
19994     * items list is changed. It should be fetched again with another
19995     * call to this function when changes happen.
19996     *
19997     * @ingroup Slideshow
19998     */
19999    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20000
20001    /**
20002     * Delete a given item from a slideshow widget.
20003     *
20004     * @param item The slideshow item
20005     *
20006     * @ingroup Slideshow
20007     */
20008    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20009
20010    /**
20011     * Return the data associated with a given slideshow item
20012     *
20013     * @param item The slideshow item
20014     * @return Returns the data associated to this item
20015     *
20016     * @ingroup Slideshow
20017     */
20018    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20019
20020    /**
20021     * Returns the currently displayed item, in a given slideshow widget
20022     *
20023     * @param obj The slideshow object
20024     * @return A handle to the item being displayed in @p obj or
20025     * @c NULL, if none is (and on errors)
20026     *
20027     * @ingroup Slideshow
20028     */
20029    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20030
20031    /**
20032     * Get the real Evas object created to implement the view of a
20033     * given slideshow item
20034     *
20035     * @param item The slideshow item.
20036     * @return the Evas object implementing this item's view.
20037     *
20038     * This returns the actual Evas object used to implement the
20039     * specified slideshow item's view. This may be @c NULL, as it may
20040     * not have been created or may have been deleted, at any time, by
20041     * the slideshow. <b>Do not modify this object</b> (move, resize,
20042     * show, hide, etc.), as the slideshow is controlling it. This
20043     * function is for querying, emitting custom signals or hooking
20044     * lower level callbacks for events on that object. Do not delete
20045     * this object under any circumstances.
20046     *
20047     * @see elm_slideshow_item_data_get()
20048     *
20049     * @ingroup Slideshow
20050     */
20051    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20052
20053    /**
20054     * Get the the item, in a given slideshow widget, placed at
20055     * position @p nth, in its internal items list
20056     *
20057     * @param obj The slideshow object
20058     * @param nth The number of the item to grab a handle to (0 being
20059     * the first)
20060     * @return The item stored in @p obj at position @p nth or @c NULL,
20061     * if there's no item with that index (and on errors)
20062     *
20063     * @ingroup Slideshow
20064     */
20065    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20066
20067    /**
20068     * Set the current slide layout in use for a given slideshow widget
20069     *
20070     * @param obj The slideshow object
20071     * @param layout The new layout's name string
20072     *
20073     * If @p layout is implemented in @p obj's theme (i.e., is contained
20074     * in the list returned by elm_slideshow_layouts_get()), this new
20075     * images layout will be used on the widget.
20076     *
20077     * @see elm_slideshow_layouts_get() for more details
20078     *
20079     * @ingroup Slideshow
20080     */
20081    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20082
20083    /**
20084     * Get the current slide layout in use for a given slideshow widget
20085     *
20086     * @param obj The slideshow object
20087     * @return The current layout's name
20088     *
20089     * @see elm_slideshow_layout_set() for more details
20090     *
20091     * @ingroup Slideshow
20092     */
20093    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20094
20095    /**
20096     * Returns the list of @b layout names available, for a given
20097     * slideshow widget.
20098     *
20099     * @param obj The slideshow object
20100     * @return The list of layouts (list of @b stringshared strings
20101     * as data)
20102     *
20103     * Slideshow layouts will change how the widget is to dispose each
20104     * image item in its viewport, with regard to cropping, scaling,
20105     * etc.
20106     *
20107     * The layouts, which come from @p obj's theme, must be an EDC
20108     * data item name @c "layouts" on the theme file, with (prefix)
20109     * names of EDC programs actually implementing them.
20110     *
20111     * The available layouts for slideshows on the default theme are:
20112     * - @c "fullscreen" - item images with original aspect, scaled to
20113     *   touch top and down slideshow borders or, if the image's heigh
20114     *   is not enough, left and right slideshow borders.
20115     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20116     *   one, but always leaving 10% of the slideshow's dimensions of
20117     *   distance between the item image's borders and the slideshow
20118     *   borders, for each axis.
20119     *
20120     * @warning The stringshared strings get no new references
20121     * exclusive to the user grabbing the list, here, so if you'd like
20122     * to use them out of this call's context, you'd better @c
20123     * eina_stringshare_ref() them.
20124     *
20125     * @see elm_slideshow_layout_set()
20126     *
20127     * @ingroup Slideshow
20128     */
20129    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20130
20131    /**
20132     * Set the number of items to cache, on a given slideshow widget,
20133     * <b>before the current item</b>
20134     *
20135     * @param obj The slideshow object
20136     * @param count Number of items to cache before the current one
20137     *
20138     * The default value for this property is @c 2. See
20139     * @ref Slideshow_Caching "slideshow caching" for more details.
20140     *
20141     * @see elm_slideshow_cache_before_get()
20142     *
20143     * @ingroup Slideshow
20144     */
20145    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20146
20147    /**
20148     * Retrieve the number of items to cache, on a given slideshow widget,
20149     * <b>before the current item</b>
20150     *
20151     * @param obj The slideshow object
20152     * @return The number of items set to be cached before the current one
20153     *
20154     * @see elm_slideshow_cache_before_set() for more details
20155     *
20156     * @ingroup Slideshow
20157     */
20158    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20159
20160    /**
20161     * Set the number of items to cache, on a given slideshow widget,
20162     * <b>after the current item</b>
20163     *
20164     * @param obj The slideshow object
20165     * @param count Number of items to cache after the current one
20166     *
20167     * The default value for this property is @c 2. See
20168     * @ref Slideshow_Caching "slideshow caching" for more details.
20169     *
20170     * @see elm_slideshow_cache_after_get()
20171     *
20172     * @ingroup Slideshow
20173     */
20174    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20175
20176    /**
20177     * Retrieve the number of items to cache, on a given slideshow widget,
20178     * <b>after the current item</b>
20179     *
20180     * @param obj The slideshow object
20181     * @return The number of items set to be cached after the current one
20182     *
20183     * @see elm_slideshow_cache_after_set() for more details
20184     *
20185     * @ingroup Slideshow
20186     */
20187    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20188
20189    /**
20190     * Get the number of items stored in a given slideshow widget
20191     *
20192     * @param obj The slideshow object
20193     * @return The number of items on @p obj, at the moment of this call
20194     *
20195     * @ingroup Slideshow
20196     */
20197    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20198
20199    /**
20200     * @}
20201     */
20202
20203    /**
20204     * @defgroup Fileselector File Selector
20205     *
20206     * @image html img/widget/fileselector/preview-00.png
20207     * @image latex img/widget/fileselector/preview-00.eps
20208     *
20209     * A file selector is a widget that allows a user to navigate
20210     * through a file system, reporting file selections back via its
20211     * API.
20212     *
20213     * It contains shortcut buttons for home directory (@c ~) and to
20214     * jump one directory upwards (..), as well as cancel/ok buttons to
20215     * confirm/cancel a given selection. After either one of those two
20216     * former actions, the file selector will issue its @c "done" smart
20217     * callback.
20218     *
20219     * There's a text entry on it, too, showing the name of the current
20220     * selection. There's the possibility of making it editable, so it
20221     * is useful on file saving dialogs on applications, where one
20222     * gives a file name to save contents to, in a given directory in
20223     * the system. This custom file name will be reported on the @c
20224     * "done" smart callback (explained in sequence).
20225     *
20226     * Finally, it has a view to display file system items into in two
20227     * possible forms:
20228     * - list
20229     * - grid
20230     *
20231     * If Elementary is built with support of the Ethumb thumbnailing
20232     * library, the second form of view will display preview thumbnails
20233     * of files which it supports.
20234     *
20235     * Smart callbacks one can register to:
20236     *
20237     * - @c "selected" - the user has clicked on a file (when not in
20238     *      folders-only mode) or directory (when in folders-only mode)
20239     * - @c "directory,open" - the list has been populated with new
20240     *      content (@c event_info is a pointer to the directory's
20241     *      path, a @b stringshared string)
20242     * - @c "done" - the user has clicked on the "ok" or "cancel"
20243     *      buttons (@c event_info is a pointer to the selection's
20244     *      path, a @b stringshared string)
20245     *
20246     * Here is an example on its usage:
20247     * @li @ref fileselector_example
20248     */
20249
20250    /**
20251     * @addtogroup Fileselector
20252     * @{
20253     */
20254
20255    /**
20256     * Defines how a file selector widget is to layout its contents
20257     * (file system entries).
20258     */
20259    typedef enum _Elm_Fileselector_Mode
20260      {
20261         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20262         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20263         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20264      } Elm_Fileselector_Mode;
20265
20266    /**
20267     * Add a new file selector widget to the given parent Elementary
20268     * (container) object
20269     *
20270     * @param parent The parent object
20271     * @return a new file selector widget handle or @c NULL, on errors
20272     *
20273     * This function inserts a new file selector widget on the canvas.
20274     *
20275     * @ingroup Fileselector
20276     */
20277    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20278
20279    /**
20280     * Enable/disable the file name entry box where the user can type
20281     * in a name for a file, in a given file selector widget
20282     *
20283     * @param obj The file selector object
20284     * @param is_save @c EINA_TRUE to make the file selector a "saving
20285     * dialog", @c EINA_FALSE otherwise
20286     *
20287     * Having the entry editable is useful on file saving dialogs on
20288     * applications, where one gives a file name to save contents to,
20289     * in a given directory in the system. This custom file name will
20290     * be reported on the @c "done" smart callback.
20291     *
20292     * @see elm_fileselector_is_save_get()
20293     *
20294     * @ingroup Fileselector
20295     */
20296    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20297
20298    /**
20299     * Get whether the given file selector is in "saving dialog" mode
20300     *
20301     * @param obj The file selector object
20302     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20303     * mode, @c EINA_FALSE otherwise (and on errors)
20304     *
20305     * @see elm_fileselector_is_save_set() for more details
20306     *
20307     * @ingroup Fileselector
20308     */
20309    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20310
20311    /**
20312     * Enable/disable folder-only view for a given file selector widget
20313     *
20314     * @param obj The file selector object
20315     * @param only @c EINA_TRUE to make @p obj only display
20316     * directories, @c EINA_FALSE to make files to be displayed in it
20317     * too
20318     *
20319     * If enabled, the widget's view will only display folder items,
20320     * naturally.
20321     *
20322     * @see elm_fileselector_folder_only_get()
20323     *
20324     * @ingroup Fileselector
20325     */
20326    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20327
20328    /**
20329     * Get whether folder-only view is set for a given file selector
20330     * widget
20331     *
20332     * @param obj The file selector object
20333     * @return only @c EINA_TRUE if @p obj is only displaying
20334     * directories, @c EINA_FALSE if files are being displayed in it
20335     * too (and on errors)
20336     *
20337     * @see elm_fileselector_folder_only_get()
20338     *
20339     * @ingroup Fileselector
20340     */
20341    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20342
20343    /**
20344     * Enable/disable the "ok" and "cancel" buttons on a given file
20345     * selector widget
20346     *
20347     * @param obj The file selector object
20348     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20349     *
20350     * @note A file selector without those buttons will never emit the
20351     * @c "done" smart event, and is only usable if one is just hooking
20352     * to the other two events.
20353     *
20354     * @see elm_fileselector_buttons_ok_cancel_get()
20355     *
20356     * @ingroup Fileselector
20357     */
20358    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20359
20360    /**
20361     * Get whether the "ok" and "cancel" buttons on a given file
20362     * selector widget are being shown.
20363     *
20364     * @param obj The file selector object
20365     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20366     * otherwise (and on errors)
20367     *
20368     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20369     *
20370     * @ingroup Fileselector
20371     */
20372    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20373
20374    /**
20375     * Enable/disable a tree view in the given file selector widget,
20376     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20377     *
20378     * @param obj The file selector object
20379     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20380     * disable
20381     *
20382     * In a tree view, arrows are created on the sides of directories,
20383     * allowing them to expand in place.
20384     *
20385     * @note If it's in other mode, the changes made by this function
20386     * will only be visible when one switches back to "list" mode.
20387     *
20388     * @see elm_fileselector_expandable_get()
20389     *
20390     * @ingroup Fileselector
20391     */
20392    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20393
20394    /**
20395     * Get whether tree view is enabled for the given file selector
20396     * widget
20397     *
20398     * @param obj The file selector object
20399     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20400     * otherwise (and or errors)
20401     *
20402     * @see elm_fileselector_expandable_set() for more details
20403     *
20404     * @ingroup Fileselector
20405     */
20406    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20407
20408    /**
20409     * Set, programmatically, the @b directory that a given file
20410     * selector widget will display contents from
20411     *
20412     * @param obj The file selector object
20413     * @param path The path to display in @p obj
20414     *
20415     * This will change the @b directory that @p obj is displaying. It
20416     * will also clear the text entry area on the @p obj object, which
20417     * displays select files' names.
20418     *
20419     * @see elm_fileselector_path_get()
20420     *
20421     * @ingroup Fileselector
20422     */
20423    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20424
20425    /**
20426     * Get the parent directory's path that a given file selector
20427     * widget is displaying
20428     *
20429     * @param obj The file selector object
20430     * @return The (full) path of the directory the file selector is
20431     * displaying, a @b stringshared string
20432     *
20433     * @see elm_fileselector_path_set()
20434     *
20435     * @ingroup Fileselector
20436     */
20437    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20438
20439    /**
20440     * Set, programmatically, the currently selected file/directory in
20441     * the given file selector widget
20442     *
20443     * @param obj The file selector object
20444     * @param path The (full) path to a file or directory
20445     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20446     * latter case occurs if the directory or file pointed to do not
20447     * exist.
20448     *
20449     * @see elm_fileselector_selected_get()
20450     *
20451     * @ingroup Fileselector
20452     */
20453    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20454
20455    /**
20456     * Get the currently selected item's (full) path, in the given file
20457     * selector widget
20458     *
20459     * @param obj The file selector object
20460     * @return The absolute path of the selected item, a @b
20461     * stringshared string
20462     *
20463     * @note Custom editions on @p obj object's text entry, if made,
20464     * will appear on the return string of this function, naturally.
20465     *
20466     * @see elm_fileselector_selected_set() for more details
20467     *
20468     * @ingroup Fileselector
20469     */
20470    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20471
20472    /**
20473     * Set the mode in which a given file selector widget will display
20474     * (layout) file system entries in its view
20475     *
20476     * @param obj The file selector object
20477     * @param mode The mode of the fileselector, being it one of
20478     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20479     * first one, naturally, will display the files in a list. The
20480     * latter will make the widget to display its entries in a grid
20481     * form.
20482     *
20483     * @note By using elm_fileselector_expandable_set(), the user may
20484     * trigger a tree view for that list.
20485     *
20486     * @note If Elementary is built with support of the Ethumb
20487     * thumbnailing library, the second form of view will display
20488     * preview thumbnails of files which it supports. You must have
20489     * elm_need_ethumb() called in your Elementary for thumbnailing to
20490     * work, though.
20491     *
20492     * @see elm_fileselector_expandable_set().
20493     * @see elm_fileselector_mode_get().
20494     *
20495     * @ingroup Fileselector
20496     */
20497    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20498
20499    /**
20500     * Get the mode in which a given file selector widget is displaying
20501     * (layouting) file system entries in its view
20502     *
20503     * @param obj The fileselector object
20504     * @return The mode in which the fileselector is at
20505     *
20506     * @see elm_fileselector_mode_set() for more details
20507     *
20508     * @ingroup Fileselector
20509     */
20510    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20511
20512    /**
20513     * @}
20514     */
20515
20516    /**
20517     * @defgroup Progressbar Progress bar
20518     *
20519     * The progress bar is a widget for visually representing the
20520     * progress status of a given job/task.
20521     *
20522     * A progress bar may be horizontal or vertical. It may display an
20523     * icon besides it, as well as primary and @b units labels. The
20524     * former is meant to label the widget as a whole, while the
20525     * latter, which is formatted with floating point values (and thus
20526     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20527     * units"</c>), is meant to label the widget's <b>progress
20528     * value</b>. Label, icon and unit strings/objects are @b optional
20529     * for progress bars.
20530     *
20531     * A progress bar may be @b inverted, in which state it gets its
20532     * values inverted, with high values being on the left or top and
20533     * low values on the right or bottom, as opposed to normally have
20534     * the low values on the former and high values on the latter,
20535     * respectively, for horizontal and vertical modes.
20536     *
20537     * The @b span of the progress, as set by
20538     * elm_progressbar_span_size_set(), is its length (horizontally or
20539     * vertically), unless one puts size hints on the widget to expand
20540     * on desired directions, by any container. That length will be
20541     * scaled by the object or applications scaling factor. At any
20542     * point code can query the progress bar for its value with
20543     * elm_progressbar_value_get().
20544     *
20545     * Available widget styles for progress bars:
20546     * - @c "default"
20547     * - @c "wheel" (simple style, no text, no progression, only
20548     *      "pulse" effect is available)
20549     *
20550     * Here is an example on its usage:
20551     * @li @ref progressbar_example
20552     */
20553
20554    /**
20555     * Add a new progress bar widget to the given parent Elementary
20556     * (container) object
20557     *
20558     * @param parent The parent object
20559     * @return a new progress bar widget handle or @c NULL, on errors
20560     *
20561     * This function inserts a new progress bar widget on the canvas.
20562     *
20563     * @ingroup Progressbar
20564     */
20565    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20566
20567    /**
20568     * Set whether a given progress bar widget is at "pulsing mode" or
20569     * not.
20570     *
20571     * @param obj The progress bar object
20572     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20573     * @c EINA_FALSE to put it back to its default one
20574     *
20575     * By default, progress bars will display values from the low to
20576     * high value boundaries. There are, though, contexts in which the
20577     * state of progression of a given task is @b unknown.  For those,
20578     * one can set a progress bar widget to a "pulsing state", to give
20579     * the user an idea that some computation is being held, but
20580     * without exact progress values. In the default theme it will
20581     * animate its bar with the contents filling in constantly and back
20582     * to non-filled, in a loop. To start and stop this pulsing
20583     * animation, one has to explicitly call elm_progressbar_pulse().
20584     *
20585     * @see elm_progressbar_pulse_get()
20586     * @see elm_progressbar_pulse()
20587     *
20588     * @ingroup Progressbar
20589     */
20590    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20591
20592    /**
20593     * Get whether a given progress bar widget is at "pulsing mode" or
20594     * not.
20595     *
20596     * @param obj The progress bar object
20597     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20598     * if it's in the default one (and on errors)
20599     *
20600     * @ingroup Progressbar
20601     */
20602    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20603
20604    /**
20605     * Start/stop a given progress bar "pulsing" animation, if its
20606     * under that mode
20607     *
20608     * @param obj The progress bar object
20609     * @param state @c EINA_TRUE, to @b start the pulsing animation,
20610     * @c EINA_FALSE to @b stop it
20611     *
20612     * @note This call won't do anything if @p obj is not under "pulsing mode".
20613     *
20614     * @see elm_progressbar_pulse_set() for more details.
20615     *
20616     * @ingroup Progressbar
20617     */
20618    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20619
20620    /**
20621     * Set the progress value (in percentage) on a given progress bar
20622     * widget
20623     *
20624     * @param obj The progress bar object
20625     * @param val The progress value (@b must be between @c 0.0 and @c
20626     * 1.0)
20627     *
20628     * Use this call to set progress bar levels.
20629     *
20630     * @note If you passes a value out of the specified range for @p
20631     * val, it will be interpreted as the @b closest of the @b boundary
20632     * values in the range.
20633     *
20634     * @ingroup Progressbar
20635     */
20636    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20637
20638    /**
20639     * Get the progress value (in percentage) on a given progress bar
20640     * widget
20641     *
20642     * @param obj The progress bar object
20643     * @return The value of the progressbar
20644     *
20645     * @see elm_progressbar_value_set() for more details
20646     *
20647     * @ingroup Progressbar
20648     */
20649    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20650
20651    /**
20652     * Set the label of a given progress bar widget
20653     *
20654     * @param obj The progress bar object
20655     * @param label The text label string, in UTF-8
20656     *
20657     * @ingroup Progressbar
20658     * @deprecated use elm_object_text_set() instead.
20659     */
20660    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20661
20662    /**
20663     * Get the label of a given progress bar widget
20664     *
20665     * @param obj The progressbar object
20666     * @return The text label string, in UTF-8
20667     *
20668     * @ingroup Progressbar
20669     * @deprecated use elm_object_text_set() instead.
20670     */
20671    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20672
20673    /**
20674     * Set the icon object of a given progress bar widget
20675     *
20676     * @param obj The progress bar object
20677     * @param icon The icon object
20678     *
20679     * Use this call to decorate @p obj with an icon next to it.
20680     *
20681     * @note Once the icon object is set, a previously set one will be
20682     * deleted. If you want to keep that old content object, use the
20683     * elm_progressbar_icon_unset() function.
20684     *
20685     * @see elm_progressbar_icon_get()
20686     *
20687     * @ingroup Progressbar
20688     */
20689    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20690
20691    /**
20692     * Retrieve the icon object set for a given progress bar widget
20693     *
20694     * @param obj The progress bar object
20695     * @return The icon object's handle, if @p obj had one set, or @c NULL,
20696     * otherwise (and on errors)
20697     *
20698     * @see elm_progressbar_icon_set() for more details
20699     *
20700     * @ingroup Progressbar
20701     */
20702    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20703
20704    /**
20705     * Unset an icon set on a given progress bar widget
20706     *
20707     * @param obj The progress bar object
20708     * @return The icon object that was being used, if any was set, or
20709     * @c NULL, otherwise (and on errors)
20710     *
20711     * This call will unparent and return the icon object which was set
20712     * for this widget, previously, on success.
20713     *
20714     * @see elm_progressbar_icon_set() for more details
20715     *
20716     * @ingroup Progressbar
20717     */
20718    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20719
20720    /**
20721     * Set the (exact) length of the bar region of a given progress bar
20722     * widget
20723     *
20724     * @param obj The progress bar object
20725     * @param size The length of the progress bar's bar region
20726     *
20727     * This sets the minimum width (when in horizontal mode) or height
20728     * (when in vertical mode) of the actual bar area of the progress
20729     * bar @p obj. This in turn affects the object's minimum size. Use
20730     * this when you're not setting other size hints expanding on the
20731     * given direction (like weight and alignment hints) and you would
20732     * like it to have a specific size.
20733     *
20734     * @note Icon, label and unit text around @p obj will require their
20735     * own space, which will make @p obj to require more the @p size,
20736     * actually.
20737     *
20738     * @see elm_progressbar_span_size_get()
20739     *
20740     * @ingroup Progressbar
20741     */
20742    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20743
20744    /**
20745     * Get the length set for the bar region of a given progress bar
20746     * widget
20747     *
20748     * @param obj The progress bar object
20749     * @return The length of the progress bar's bar region
20750     *
20751     * If that size was not set previously, with
20752     * elm_progressbar_span_size_set(), this call will return @c 0.
20753     *
20754     * @ingroup Progressbar
20755     */
20756    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20757
20758    /**
20759     * Set the format string for a given progress bar widget's units
20760     * label
20761     *
20762     * @param obj The progress bar object
20763     * @param format The format string for @p obj's units label
20764     *
20765     * If @c NULL is passed on @p format, it will make @p obj's units
20766     * area to be hidden completely. If not, it'll set the <b>format
20767     * string</b> for the units label's @b text. The units label is
20768     * provided a floating point value, so the units text is up display
20769     * at most one floating point falue. Note that the units label is
20770     * optional. Use a format string such as "%1.2f meters" for
20771     * example.
20772     *
20773     * @note The default format string for a progress bar is an integer
20774     * percentage, as in @c "%.0f %%".
20775     *
20776     * @see elm_progressbar_unit_format_get()
20777     *
20778     * @ingroup Progressbar
20779     */
20780    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20781
20782    /**
20783     * Retrieve the format string set for a given progress bar widget's
20784     * units label
20785     *
20786     * @param obj The progress bar object
20787     * @return The format set string for @p obj's units label or
20788     * @c NULL, if none was set (and on errors)
20789     *
20790     * @see elm_progressbar_unit_format_set() for more details
20791     *
20792     * @ingroup Progressbar
20793     */
20794    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20795
20796    /**
20797     * Set the orientation of a given progress bar widget
20798     *
20799     * @param obj The progress bar object
20800     * @param horizontal Use @c EINA_TRUE to make @p obj to be
20801     * @b horizontal, @c EINA_FALSE to make it @b vertical
20802     *
20803     * Use this function to change how your progress bar is to be
20804     * disposed: vertically or horizontally.
20805     *
20806     * @see elm_progressbar_horizontal_get()
20807     *
20808     * @ingroup Progressbar
20809     */
20810    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20811
20812    /**
20813     * Retrieve the orientation of a given progress bar widget
20814     *
20815     * @param obj The progress bar object
20816     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20817     * @c EINA_FALSE if it's @b vertical (and on errors)
20818     *
20819     * @see elm_progressbar_horizontal_set() for more details
20820     *
20821     * @ingroup Progressbar
20822     */
20823    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20824
20825    /**
20826     * Invert a given progress bar widget's displaying values order
20827     *
20828     * @param obj The progress bar object
20829     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20830     * @c EINA_FALSE to bring it back to default, non-inverted values.
20831     *
20832     * A progress bar may be @b inverted, in which state it gets its
20833     * values inverted, with high values being on the left or top and
20834     * low values on the right or bottom, as opposed to normally have
20835     * the low values on the former and high values on the latter,
20836     * respectively, for horizontal and vertical modes.
20837     *
20838     * @see elm_progressbar_inverted_get()
20839     *
20840     * @ingroup Progressbar
20841     */
20842    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20843
20844    /**
20845     * Get whether a given progress bar widget's displaying values are
20846     * inverted or not
20847     *
20848     * @param obj The progress bar object
20849     * @return @c EINA_TRUE, if @p obj has inverted values,
20850     * @c EINA_FALSE otherwise (and on errors)
20851     *
20852     * @see elm_progressbar_inverted_set() for more details
20853     *
20854     * @ingroup Progressbar
20855     */
20856    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20857
20858    /**
20859     * @defgroup Separator Separator
20860     *
20861     * @brief Separator is a very thin object used to separate other objects.
20862     *
20863     * A separator can be vertical or horizontal.
20864     *
20865     * @ref tutorial_separator is a good example of how to use a separator.
20866     * @{
20867     */
20868    /**
20869     * @brief Add a separator object to @p parent
20870     *
20871     * @param parent The parent object
20872     *
20873     * @return The separator object, or NULL upon failure
20874     */
20875    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20876    /**
20877     * @brief Set the horizontal mode of a separator object
20878     *
20879     * @param obj The separator object
20880     * @param horizontal If true, the separator is horizontal
20881     */
20882    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20883    /**
20884     * @brief Get the horizontal mode of a separator object
20885     *
20886     * @param obj The separator object
20887     * @return If true, the separator is horizontal
20888     *
20889     * @see elm_separator_horizontal_set()
20890     */
20891    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20892    /**
20893     * @}
20894     */
20895
20896    /**
20897     * @defgroup Spinner Spinner
20898     * @ingroup Elementary
20899     *
20900     * @image html img/widget/spinner/preview-00.png
20901     * @image latex img/widget/spinner/preview-00.eps
20902     *
20903     * A spinner is a widget which allows the user to increase or decrease
20904     * numeric values using arrow buttons, or edit values directly, clicking
20905     * over it and typing the new value.
20906     *
20907     * By default the spinner will not wrap and has a label
20908     * of "%.0f" (just showing the integer value of the double).
20909     *
20910     * A spinner has a label that is formatted with floating
20911     * point values and thus accepts a printf-style format string, like
20912     * “%1.2f units”.
20913     *
20914     * It also allows specific values to be replaced by pre-defined labels.
20915     *
20916     * Smart callbacks one can register to:
20917     *
20918     * - "changed" - Whenever the spinner value is changed.
20919     * - "delay,changed" - A short time after the value is changed by the user.
20920     *    This will be called only when the user stops dragging for a very short
20921     *    period or when they release their finger/mouse, so it avoids possibly
20922     *    expensive reactions to the value change.
20923     *
20924     * Available styles for it:
20925     * - @c "default";
20926     * - @c "vertical": up/down buttons at the right side and text left aligned.
20927     *
20928     * Here is an example on its usage:
20929     * @ref spinner_example
20930     */
20931
20932    /**
20933     * @addtogroup Spinner
20934     * @{
20935     */
20936
20937    /**
20938     * Add a new spinner widget to the given parent Elementary
20939     * (container) object.
20940     *
20941     * @param parent The parent object.
20942     * @return a new spinner widget handle or @c NULL, on errors.
20943     *
20944     * This function inserts a new spinner widget on the canvas.
20945     *
20946     * @ingroup Spinner
20947     *
20948     */
20949    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20950
20951    /**
20952     * Set the format string of the displayed label.
20953     *
20954     * @param obj The spinner object.
20955     * @param fmt The format string for the label display.
20956     *
20957     * If @c NULL, this sets the format to "%.0f". If not it sets the format
20958     * string for the label text. The label text is provided a floating point
20959     * value, so the label text can display up to 1 floating point value.
20960     * Note that this is optional.
20961     *
20962     * Use a format string such as "%1.2f meters" for example, and it will
20963     * display values like: "3.14 meters" for a value equal to 3.14159.
20964     *
20965     * Default is "%0.f".
20966     *
20967     * @see elm_spinner_label_format_get()
20968     *
20969     * @ingroup Spinner
20970     */
20971    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20972
20973    /**
20974     * Get the label format of the spinner.
20975     *
20976     * @param obj The spinner object.
20977     * @return The text label format string in UTF-8.
20978     *
20979     * @see elm_spinner_label_format_set() for details.
20980     *
20981     * @ingroup Spinner
20982     */
20983    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20984
20985    /**
20986     * Set the minimum and maximum values for the spinner.
20987     *
20988     * @param obj The spinner object.
20989     * @param min The minimum value.
20990     * @param max The maximum value.
20991     *
20992     * Define the allowed range of values to be selected by the user.
20993     *
20994     * If actual value is less than @p min, it will be updated to @p min. If it
20995     * is bigger then @p max, will be updated to @p max. Actual value can be
20996     * get with elm_spinner_value_get().
20997     *
20998     * By default, min is equal to 0, and max is equal to 100.
20999     *
21000     * @warning Maximum must be greater than minimum.
21001     *
21002     * @see elm_spinner_min_max_get()
21003     *
21004     * @ingroup Spinner
21005     */
21006    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21007
21008    /**
21009     * Get the minimum and maximum values of the spinner.
21010     *
21011     * @param obj The spinner object.
21012     * @param min Pointer where to store the minimum value.
21013     * @param max Pointer where to store the maximum value.
21014     *
21015     * @note If only one value is needed, the other pointer can be passed
21016     * as @c NULL.
21017     *
21018     * @see elm_spinner_min_max_set() for details.
21019     *
21020     * @ingroup Spinner
21021     */
21022    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21023
21024    /**
21025     * Set the step used to increment or decrement the spinner value.
21026     *
21027     * @param obj The spinner object.
21028     * @param step The step value.
21029     *
21030     * This value will be incremented or decremented to the displayed value.
21031     * It will be incremented while the user keep right or top arrow pressed,
21032     * and will be decremented while the user keep left or bottom arrow pressed.
21033     *
21034     * The interval to increment / decrement can be set with
21035     * elm_spinner_interval_set().
21036     *
21037     * By default step value is equal to 1.
21038     *
21039     * @see elm_spinner_step_get()
21040     *
21041     * @ingroup Spinner
21042     */
21043    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21044
21045    /**
21046     * Get the step used to increment or decrement the spinner value.
21047     *
21048     * @param obj The spinner object.
21049     * @return The step value.
21050     *
21051     * @see elm_spinner_step_get() for more details.
21052     *
21053     * @ingroup Spinner
21054     */
21055    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21056
21057    /**
21058     * Set the value the spinner displays.
21059     *
21060     * @param obj The spinner object.
21061     * @param val The value to be displayed.
21062     *
21063     * Value will be presented on the label following format specified with
21064     * elm_spinner_format_set().
21065     *
21066     * @warning The value must to be between min and max values. This values
21067     * are set by elm_spinner_min_max_set().
21068     *
21069     * @see elm_spinner_value_get().
21070     * @see elm_spinner_format_set().
21071     * @see elm_spinner_min_max_set().
21072     *
21073     * @ingroup Spinner
21074     */
21075    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21076
21077    /**
21078     * Get the value displayed by the spinner.
21079     *
21080     * @param obj The spinner object.
21081     * @return The value displayed.
21082     *
21083     * @see elm_spinner_value_set() for details.
21084     *
21085     * @ingroup Spinner
21086     */
21087    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21088
21089    /**
21090     * Set whether the spinner should wrap when it reaches its
21091     * minimum or maximum value.
21092     *
21093     * @param obj The spinner object.
21094     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21095     * disable it.
21096     *
21097     * Disabled by default. If disabled, when the user tries to increment the
21098     * value,
21099     * but displayed value plus step value is bigger than maximum value,
21100     * the spinner
21101     * won't allow it. The same happens when the user tries to decrement it,
21102     * but the value less step is less than minimum value.
21103     *
21104     * When wrap is enabled, in such situations it will allow these changes,
21105     * but will get the value that would be less than minimum and subtracts
21106     * from maximum. Or add the value that would be more than maximum to
21107     * the minimum.
21108     *
21109     * E.g.:
21110     * @li min value = 10
21111     * @li max value = 50
21112     * @li step value = 20
21113     * @li displayed value = 20
21114     *
21115     * When the user decrement value (using left or bottom arrow), it will
21116     * displays @c 40, because max - (min - (displayed - step)) is
21117     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21118     *
21119     * @see elm_spinner_wrap_get().
21120     *
21121     * @ingroup Spinner
21122     */
21123    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21124
21125    /**
21126     * Get whether the spinner should wrap when it reaches its
21127     * minimum or maximum value.
21128     *
21129     * @param obj The spinner object
21130     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21131     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21132     *
21133     * @see elm_spinner_wrap_set() for details.
21134     *
21135     * @ingroup Spinner
21136     */
21137    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21138
21139    /**
21140     * Set whether the spinner can be directly edited by the user or not.
21141     *
21142     * @param obj The spinner object.
21143     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21144     * don't allow users to edit it directly.
21145     *
21146     * Spinner objects can have edition @b disabled, in which state they will
21147     * be changed only by arrows.
21148     * Useful for contexts
21149     * where you don't want your users to interact with it writting the value.
21150     * Specially
21151     * when using special values, the user can see real value instead
21152     * of special label on edition.
21153     *
21154     * It's enabled by default.
21155     *
21156     * @see elm_spinner_editable_get()
21157     *
21158     * @ingroup Spinner
21159     */
21160    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21161
21162    /**
21163     * Get whether the spinner can be directly edited by the user or not.
21164     *
21165     * @param obj The spinner object.
21166     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21167     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21168     *
21169     * @see elm_spinner_editable_set() for details.
21170     *
21171     * @ingroup Spinner
21172     */
21173    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21174
21175    /**
21176     * Set a special string to display in the place of the numerical value.
21177     *
21178     * @param obj The spinner object.
21179     * @param value The value to be replaced.
21180     * @param label The label to be used.
21181     *
21182     * It's useful for cases when a user should select an item that is
21183     * better indicated by a label than a value. For example, weekdays or months.
21184     *
21185     * E.g.:
21186     * @code
21187     * sp = elm_spinner_add(win);
21188     * elm_spinner_min_max_set(sp, 1, 3);
21189     * elm_spinner_special_value_add(sp, 1, "January");
21190     * elm_spinner_special_value_add(sp, 2, "February");
21191     * elm_spinner_special_value_add(sp, 3, "March");
21192     * evas_object_show(sp);
21193     * @endcode
21194     *
21195     * @ingroup Spinner
21196     */
21197    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21198
21199    /**
21200     * Set the interval on time updates for an user mouse button hold
21201     * on spinner widgets' arrows.
21202     *
21203     * @param obj The spinner object.
21204     * @param interval The (first) interval value in seconds.
21205     *
21206     * This interval value is @b decreased while the user holds the
21207     * mouse pointer either incrementing or decrementing spinner's value.
21208     *
21209     * This helps the user to get to a given value distant from the
21210     * current one easier/faster, as it will start to change quicker and
21211     * quicker on mouse button holds.
21212     *
21213     * The calculation for the next change interval value, starting from
21214     * the one set with this call, is the previous interval divided by
21215     * @c 1.05, so it decreases a little bit.
21216     *
21217     * The default starting interval value for automatic changes is
21218     * @c 0.85 seconds.
21219     *
21220     * @see elm_spinner_interval_get()
21221     *
21222     * @ingroup Spinner
21223     */
21224    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21225
21226    /**
21227     * Get the interval on time updates for an user mouse button hold
21228     * on spinner widgets' arrows.
21229     *
21230     * @param obj The spinner object.
21231     * @return The (first) interval value, in seconds, set on it.
21232     *
21233     * @see elm_spinner_interval_set() for more details.
21234     *
21235     * @ingroup Spinner
21236     */
21237    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21238
21239    /**
21240     * @}
21241     */
21242
21243    /**
21244     * @defgroup Index Index
21245     *
21246     * @image html img/widget/index/preview-00.png
21247     * @image latex img/widget/index/preview-00.eps
21248     *
21249     * An index widget gives you an index for fast access to whichever
21250     * group of other UI items one might have. It's a list of text
21251     * items (usually letters, for alphabetically ordered access).
21252     *
21253     * Index widgets are by default hidden and just appear when the
21254     * user clicks over it's reserved area in the canvas. In its
21255     * default theme, it's an area one @ref Fingers "finger" wide on
21256     * the right side of the index widget's container.
21257     *
21258     * When items on the index are selected, smart callbacks get
21259     * called, so that its user can make other container objects to
21260     * show a given area or child object depending on the index item
21261     * selected. You'd probably be using an index together with @ref
21262     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21263     * "general grids".
21264     *
21265     * Smart events one  can add callbacks for are:
21266     * - @c "changed" - When the selected index item changes. @c
21267     *      event_info is the selected item's data pointer.
21268     * - @c "delay,changed" - When the selected index item changes, but
21269     *      after a small idling period. @c event_info is the selected
21270     *      item's data pointer.
21271     * - @c "selected" - When the user releases a mouse button and
21272     *      selects an item. @c event_info is the selected item's data
21273     *      pointer.
21274     * - @c "level,up" - when the user moves a finger from the first
21275     *      level to the second level
21276     * - @c "level,down" - when the user moves a finger from the second
21277     *      level to the first level
21278     *
21279     * The @c "delay,changed" event is so that it'll wait a small time
21280     * before actually reporting those events and, moreover, just the
21281     * last event happening on those time frames will actually be
21282     * reported.
21283     *
21284     * Here are some examples on its usage:
21285     * @li @ref index_example_01
21286     * @li @ref index_example_02
21287     */
21288
21289    /**
21290     * @addtogroup Index
21291     * @{
21292     */
21293
21294    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21295
21296    /**
21297     * Add a new index widget to the given parent Elementary
21298     * (container) object
21299     *
21300     * @param parent The parent object
21301     * @return a new index widget handle or @c NULL, on errors
21302     *
21303     * This function inserts a new index widget on the canvas.
21304     *
21305     * @ingroup Index
21306     */
21307    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21308
21309    /**
21310     * Set whether a given index widget is or not visible,
21311     * programatically.
21312     *
21313     * @param obj The index object
21314     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21315     *
21316     * Not to be confused with visible as in @c evas_object_show() --
21317     * visible with regard to the widget's auto hiding feature.
21318     *
21319     * @see elm_index_active_get()
21320     *
21321     * @ingroup Index
21322     */
21323    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21324
21325    /**
21326     * Get whether a given index widget is currently visible or not.
21327     *
21328     * @param obj The index object
21329     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21330     *
21331     * @see elm_index_active_set() for more details
21332     *
21333     * @ingroup Index
21334     */
21335    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21336
21337    /**
21338     * Set the items level for a given index widget.
21339     *
21340     * @param obj The index object.
21341     * @param level @c 0 or @c 1, the currently implemented levels.
21342     *
21343     * @see elm_index_item_level_get()
21344     *
21345     * @ingroup Index
21346     */
21347    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21348
21349    /**
21350     * Get the items level set for a given index widget.
21351     *
21352     * @param obj The index object.
21353     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21354     *
21355     * @see elm_index_item_level_set() for more information
21356     *
21357     * @ingroup Index
21358     */
21359    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21360
21361    /**
21362     * Returns the last selected item's data, for a given index widget.
21363     *
21364     * @param obj The index object.
21365     * @return The item @b data associated to the last selected item on
21366     * @p obj (or @c NULL, on errors).
21367     *
21368     * @warning The returned value is @b not an #Elm_Index_Item item
21369     * handle, but the data associated to it (see the @c item parameter
21370     * in elm_index_item_append(), as an example).
21371     *
21372     * @ingroup Index
21373     */
21374    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21375
21376    /**
21377     * Append a new item on a given index widget.
21378     *
21379     * @param obj The index object.
21380     * @param letter Letter under which the item should be indexed
21381     * @param item The item data to set for the index's item
21382     *
21383     * Despite the most common usage of the @p letter argument is for
21384     * single char strings, one could use arbitrary strings as index
21385     * entries.
21386     *
21387     * @c item will be the pointer returned back on @c "changed", @c
21388     * "delay,changed" and @c "selected" smart events.
21389     *
21390     * @ingroup Index
21391     */
21392    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21393
21394    /**
21395     * Prepend a new item on a given index widget.
21396     *
21397     * @param obj The index object.
21398     * @param letter Letter under which the item should be indexed
21399     * @param item The item data to set for the index's item
21400     *
21401     * Despite the most common usage of the @p letter argument is for
21402     * single char strings, one could use arbitrary strings as index
21403     * entries.
21404     *
21405     * @c item will be the pointer returned back on @c "changed", @c
21406     * "delay,changed" and @c "selected" smart events.
21407     *
21408     * @ingroup Index
21409     */
21410    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21411
21412    /**
21413     * Append a new item, on a given index widget, <b>after the item
21414     * having @p relative as data</b>.
21415     *
21416     * @param obj The index object.
21417     * @param letter Letter under which the item should be indexed
21418     * @param item The item data to set for the index's item
21419     * @param relative The item data of the index item to be the
21420     * predecessor of this new one
21421     *
21422     * Despite the most common usage of the @p letter argument is for
21423     * single char strings, one could use arbitrary strings as index
21424     * entries.
21425     *
21426     * @c item will be the pointer returned back on @c "changed", @c
21427     * "delay,changed" and @c "selected" smart events.
21428     *
21429     * @note If @p relative is @c NULL or if it's not found to be data
21430     * set on any previous item on @p obj, this function will behave as
21431     * elm_index_item_append().
21432     *
21433     * @ingroup Index
21434     */
21435    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21436
21437    /**
21438     * Prepend a new item, on a given index widget, <b>after the item
21439     * having @p relative as data</b>.
21440     *
21441     * @param obj The index object.
21442     * @param letter Letter under which the item should be indexed
21443     * @param item The item data to set for the index's item
21444     * @param relative The item data of the index item to be the
21445     * successor of this new one
21446     *
21447     * Despite the most common usage of the @p letter argument is for
21448     * single char strings, one could use arbitrary strings as index
21449     * entries.
21450     *
21451     * @c item will be the pointer returned back on @c "changed", @c
21452     * "delay,changed" and @c "selected" smart events.
21453     *
21454     * @note If @p relative is @c NULL or if it's not found to be data
21455     * set on any previous item on @p obj, this function will behave as
21456     * elm_index_item_prepend().
21457     *
21458     * @ingroup Index
21459     */
21460    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21461
21462    /**
21463     * Insert a new item into the given index widget, using @p cmp_func
21464     * function to sort items (by item handles).
21465     *
21466     * @param obj The index object.
21467     * @param letter Letter under which the item should be indexed
21468     * @param item The item data to set for the index's item
21469     * @param cmp_func The comparing function to be used to sort index
21470     * items <b>by #Elm_Index_Item item handles</b>
21471     * @param cmp_data_func A @b fallback function to be called for the
21472     * sorting of index items <b>by item data</b>). It will be used
21473     * when @p cmp_func returns @c 0 (equality), which means an index
21474     * item with provided item data already exists. To decide which
21475     * data item should be pointed to by the index item in question, @p
21476     * cmp_data_func will be used. If @p cmp_data_func returns a
21477     * non-negative value, the previous index item data will be
21478     * replaced by the given @p item pointer. If the previous data need
21479     * to be freed, it should be done by the @p cmp_data_func function,
21480     * because all references to it will be lost. If this function is
21481     * not provided (@c NULL is given), index items will be @b
21482     * duplicated, if @p cmp_func returns @c 0.
21483     *
21484     * Despite the most common usage of the @p letter argument is for
21485     * single char strings, one could use arbitrary strings as index
21486     * entries.
21487     *
21488     * @c item will be the pointer returned back on @c "changed", @c
21489     * "delay,changed" and @c "selected" smart events.
21490     *
21491     * @ingroup Index
21492     */
21493    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);
21494
21495    /**
21496     * Remove an item from a given index widget, <b>to be referenced by
21497     * it's data value</b>.
21498     *
21499     * @param obj The index object
21500     * @param item The item's data pointer for the item to be removed
21501     * from @p obj
21502     *
21503     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21504     * that callback function will be called by this one.
21505     *
21506     * @warning The item to be removed from @p obj will be found via
21507     * its item data pointer, and not by an #Elm_Index_Item handle.
21508     *
21509     * @ingroup Index
21510     */
21511    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21512
21513    /**
21514     * Find a given index widget's item, <b>using item data</b>.
21515     *
21516     * @param obj The index object
21517     * @param item The item data pointed to by the desired index item
21518     * @return The index item handle, if found, or @c NULL otherwise
21519     *
21520     * @ingroup Index
21521     */
21522    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21523
21524    /**
21525     * Removes @b all items from a given index widget.
21526     *
21527     * @param obj The index object.
21528     *
21529     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21530     * that callback function will be called for each item in @p obj.
21531     *
21532     * @ingroup Index
21533     */
21534    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21535
21536    /**
21537     * Go to a given items level on a index widget
21538     *
21539     * @param obj The index object
21540     * @param level The index level (one of @c 0 or @c 1)
21541     *
21542     * @ingroup Index
21543     */
21544    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21545
21546    /**
21547     * Return the data associated with a given index widget item
21548     *
21549     * @param it The index widget item handle
21550     * @return The data associated with @p it
21551     *
21552     * @see elm_index_item_data_set()
21553     *
21554     * @ingroup Index
21555     */
21556    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21557
21558    /**
21559     * Set the data associated with a given index widget item
21560     *
21561     * @param it The index widget item handle
21562     * @param data The new data pointer to set to @p it
21563     *
21564     * This sets new item data on @p it.
21565     *
21566     * @warning The old data pointer won't be touched by this function, so
21567     * the user had better to free that old data himself/herself.
21568     *
21569     * @ingroup Index
21570     */
21571    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21572
21573    /**
21574     * Set the function to be called when a given index widget item is freed.
21575     *
21576     * @param it The item to set the callback on
21577     * @param func The function to call on the item's deletion
21578     *
21579     * When called, @p func will have both @c data and @c event_info
21580     * arguments with the @p it item's data value and, naturally, the
21581     * @c obj argument with a handle to the parent index widget.
21582     *
21583     * @ingroup Index
21584     */
21585    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21586
21587    /**
21588     * Get the letter (string) set on a given index widget item.
21589     *
21590     * @param it The index item handle
21591     * @return The letter string set on @p it
21592     *
21593     * @ingroup Index
21594     */
21595    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21596
21597    /**
21598     * @}
21599     */
21600
21601    /**
21602     * @defgroup Photocam Photocam
21603     *
21604     * @image html img/widget/photocam/preview-00.png
21605     * @image latex img/widget/photocam/preview-00.eps
21606     *
21607     * This is a widget specifically for displaying high-resolution digital
21608     * camera photos giving speedy feedback (fast load), low memory footprint
21609     * and zooming and panning as well as fitting logic. It is entirely focused
21610     * on jpeg images, and takes advantage of properties of the jpeg format (via
21611     * evas loader features in the jpeg loader).
21612     *
21613     * Signals that you can add callbacks for are:
21614     * @li "clicked" - This is called when a user has clicked the photo without
21615     *                 dragging around.
21616     * @li "press" - This is called when a user has pressed down on the photo.
21617     * @li "longpressed" - This is called when a user has pressed down on the
21618     *                     photo for a long time without dragging around.
21619     * @li "clicked,double" - This is called when a user has double-clicked the
21620     *                        photo.
21621     * @li "load" - Photo load begins.
21622     * @li "loaded" - This is called when the image file load is complete for the
21623     *                first view (low resolution blurry version).
21624     * @li "load,detail" - Photo detailed data load begins.
21625     * @li "loaded,detail" - This is called when the image file load is complete
21626     *                      for the detailed image data (full resolution needed).
21627     * @li "zoom,start" - Zoom animation started.
21628     * @li "zoom,stop" - Zoom animation stopped.
21629     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21630     * @li "scroll" - the content has been scrolled (moved)
21631     * @li "scroll,anim,start" - scrolling animation has started
21632     * @li "scroll,anim,stop" - scrolling animation has stopped
21633     * @li "scroll,drag,start" - dragging the contents around has started
21634     * @li "scroll,drag,stop" - dragging the contents around has stopped
21635     *
21636     * @ref tutorial_photocam shows the API in action.
21637     * @{
21638     */
21639    /**
21640     * @brief Types of zoom available.
21641     */
21642    typedef enum _Elm_Photocam_Zoom_Mode
21643      {
21644         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21645         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21646         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21647         ELM_PHOTOCAM_ZOOM_MODE_LAST
21648      } Elm_Photocam_Zoom_Mode;
21649    /**
21650     * @brief Add a new Photocam object
21651     *
21652     * @param parent The parent object
21653     * @return The new object or NULL if it cannot be created
21654     */
21655    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21656    /**
21657     * @brief Set the photo file to be shown
21658     *
21659     * @param obj The photocam object
21660     * @param file The photo file
21661     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21662     *
21663     * This sets (and shows) the specified file (with a relative or absolute
21664     * path) and will return a load error (same error that
21665     * evas_object_image_load_error_get() will return). The image will change and
21666     * adjust its size at this point and begin a background load process for this
21667     * photo that at some time in the future will be displayed at the full
21668     * quality needed.
21669     */
21670    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21671    /**
21672     * @brief Returns the path of the current image file
21673     *
21674     * @param obj The photocam object
21675     * @return Returns the path
21676     *
21677     * @see elm_photocam_file_set()
21678     */
21679    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21680    /**
21681     * @brief Set the zoom level of the photo
21682     *
21683     * @param obj The photocam object
21684     * @param zoom The zoom level to set
21685     *
21686     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21687     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21688     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21689     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21690     * 16, 32, etc.).
21691     */
21692    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21693    /**
21694     * @brief Get the zoom level of the photo
21695     *
21696     * @param obj The photocam object
21697     * @return The current zoom level
21698     *
21699     * This returns the current zoom level of the photocam object. Note that if
21700     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21701     * (which is the default), the zoom level may be changed at any time by the
21702     * photocam object itself to account for photo size and photocam viewpoer
21703     * size.
21704     *
21705     * @see elm_photocam_zoom_set()
21706     * @see elm_photocam_zoom_mode_set()
21707     */
21708    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21709    /**
21710     * @brief Set the zoom mode
21711     *
21712     * @param obj The photocam object
21713     * @param mode The desired mode
21714     *
21715     * This sets the zoom mode to manual or one of several automatic levels.
21716     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21717     * elm_photocam_zoom_set() and will stay at that level until changed by code
21718     * or until zoom mode is changed. This is the default mode. The Automatic
21719     * modes will allow the photocam object to automatically adjust zoom mode
21720     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21721     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21722     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21723     * pixels within the frame are left unfilled.
21724     */
21725    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21726    /**
21727     * @brief Get the zoom mode
21728     *
21729     * @param obj The photocam object
21730     * @return The current zoom mode
21731     *
21732     * This gets the current zoom mode of the photocam object.
21733     *
21734     * @see elm_photocam_zoom_mode_set()
21735     */
21736    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21737    /**
21738     * @brief Get the current image pixel width and height
21739     *
21740     * @param obj The photocam object
21741     * @param w A pointer to the width return
21742     * @param h A pointer to the height return
21743     *
21744     * This gets the current photo pixel width and height (for the original).
21745     * The size will be returned in the integers @p w and @p h that are pointed
21746     * to.
21747     */
21748    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21749    /**
21750     * @brief Get the area of the image that is currently shown
21751     *
21752     * @param obj
21753     * @param x A pointer to the X-coordinate of region
21754     * @param y A pointer to the Y-coordinate of region
21755     * @param w A pointer to the width
21756     * @param h A pointer to the height
21757     *
21758     * @see elm_photocam_image_region_show()
21759     * @see elm_photocam_image_region_bring_in()
21760     */
21761    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21762    /**
21763     * @brief Set the viewed portion of the image
21764     *
21765     * @param obj The photocam object
21766     * @param x X-coordinate of region in image original pixels
21767     * @param y Y-coordinate of region in image original pixels
21768     * @param w Width of region in image original pixels
21769     * @param h Height of region in image original pixels
21770     *
21771     * This shows the region of the image without using animation.
21772     */
21773    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21774    /**
21775     * @brief Bring in the viewed portion of the image
21776     *
21777     * @param obj The photocam object
21778     * @param x X-coordinate of region in image original pixels
21779     * @param y Y-coordinate of region in image original pixels
21780     * @param w Width of region in image original pixels
21781     * @param h Height of region in image original pixels
21782     *
21783     * This shows the region of the image using animation.
21784     */
21785    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21786    /**
21787     * @brief Set the paused state for photocam
21788     *
21789     * @param obj The photocam object
21790     * @param paused The pause state to set
21791     *
21792     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21793     * photocam. The default is off. This will stop zooming using animation on
21794     * zoom levels changes and change instantly. This will stop any existing
21795     * animations that are running.
21796     */
21797    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21798    /**
21799     * @brief Get the paused state for photocam
21800     *
21801     * @param obj The photocam object
21802     * @return The current paused state
21803     *
21804     * This gets the current paused state for the photocam object.
21805     *
21806     * @see elm_photocam_paused_set()
21807     */
21808    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21809    /**
21810     * @brief Get the internal low-res image used for photocam
21811     *
21812     * @param obj The photocam object
21813     * @return The internal image object handle, or NULL if none exists
21814     *
21815     * This gets the internal image object inside photocam. Do not modify it. It
21816     * is for inspection only, and hooking callbacks to. Nothing else. It may be
21817     * deleted at any time as well.
21818     */
21819    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21820    /**
21821     * @brief Set the photocam scrolling bouncing.
21822     *
21823     * @param obj The photocam object
21824     * @param h_bounce bouncing for horizontal
21825     * @param v_bounce bouncing for vertical
21826     */
21827    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21828    /**
21829     * @brief Get the photocam scrolling bouncing.
21830     *
21831     * @param obj The photocam object
21832     * @param h_bounce bouncing for horizontal
21833     * @param v_bounce bouncing for vertical
21834     *
21835     * @see elm_photocam_bounce_set()
21836     */
21837    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21838    /**
21839     * @}
21840     */
21841
21842    /**
21843     * @defgroup Map Map
21844     * @ingroup Elementary
21845     *
21846     * @image html img/widget/map/preview-00.png
21847     * @image latex img/widget/map/preview-00.eps
21848     *
21849     * This is a widget specifically for displaying a map. It uses basically
21850     * OpenStreetMap provider http://www.openstreetmap.org/,
21851     * but custom providers can be added.
21852     *
21853     * It supports some basic but yet nice features:
21854     * @li zoom and scroll
21855     * @li markers with content to be displayed when user clicks over it
21856     * @li group of markers
21857     * @li routes
21858     *
21859     * Smart callbacks one can listen to:
21860     *
21861     * - "clicked" - This is called when a user has clicked the map without
21862     *   dragging around.
21863     * - "press" - This is called when a user has pressed down on the map.
21864     * - "longpressed" - This is called when a user has pressed down on the map
21865     *   for a long time without dragging around.
21866     * - "clicked,double" - This is called when a user has double-clicked
21867     *   the map.
21868     * - "load,detail" - Map detailed data load begins.
21869     * - "loaded,detail" - This is called when all currently visible parts of
21870     *   the map are loaded.
21871     * - "zoom,start" - Zoom animation started.
21872     * - "zoom,stop" - Zoom animation stopped.
21873     * - "zoom,change" - Zoom changed when using an auto zoom mode.
21874     * - "scroll" - the content has been scrolled (moved).
21875     * - "scroll,anim,start" - scrolling animation has started.
21876     * - "scroll,anim,stop" - scrolling animation has stopped.
21877     * - "scroll,drag,start" - dragging the contents around has started.
21878     * - "scroll,drag,stop" - dragging the contents around has stopped.
21879     * - "downloaded" - This is called when all currently required map images
21880     *   are downloaded.
21881     * - "route,load" - This is called when route request begins.
21882     * - "route,loaded" - This is called when route request ends.
21883     * - "name,load" - This is called when name request begins.
21884     * - "name,loaded- This is called when name request ends.
21885     *
21886     * Available style for map widget:
21887     * - @c "default"
21888     *
21889     * Available style for markers:
21890     * - @c "radio"
21891     * - @c "radio2"
21892     * - @c "empty"
21893     *
21894     * Available style for marker bubble:
21895     * - @c "default"
21896     *
21897     * List of examples:
21898     * @li @ref map_example_01
21899     * @li @ref map_example_02
21900     * @li @ref map_example_03
21901     */
21902
21903    /**
21904     * @addtogroup Map
21905     * @{
21906     */
21907
21908    /**
21909     * @enum _Elm_Map_Zoom_Mode
21910     * @typedef Elm_Map_Zoom_Mode
21911     *
21912     * Set map's zoom behavior. It can be set to manual or automatic.
21913     *
21914     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21915     *
21916     * Values <b> don't </b> work as bitmask, only one can be choosen.
21917     *
21918     * @note Valid sizes are 2^zoom, consequently the map may be smaller
21919     * than the scroller view.
21920     *
21921     * @see elm_map_zoom_mode_set()
21922     * @see elm_map_zoom_mode_get()
21923     *
21924     * @ingroup Map
21925     */
21926    typedef enum _Elm_Map_Zoom_Mode
21927      {
21928         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21929         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21930         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21931         ELM_MAP_ZOOM_MODE_LAST
21932      } Elm_Map_Zoom_Mode;
21933
21934    /**
21935     * @enum _Elm_Map_Route_Sources
21936     * @typedef Elm_Map_Route_Sources
21937     *
21938     * Set route service to be used. By default used source is
21939     * #ELM_MAP_ROUTE_SOURCE_YOURS.
21940     *
21941     * @see elm_map_route_source_set()
21942     * @see elm_map_route_source_get()
21943     *
21944     * @ingroup Map
21945     */
21946    typedef enum _Elm_Map_Route_Sources
21947      {
21948         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21949         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. */
21950         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21951         ELM_MAP_ROUTE_SOURCE_LAST
21952      } Elm_Map_Route_Sources;
21953
21954    typedef enum _Elm_Map_Name_Sources
21955      {
21956         ELM_MAP_NAME_SOURCE_NOMINATIM,
21957         ELM_MAP_NAME_SOURCE_LAST
21958      } Elm_Map_Name_Sources;
21959
21960    /**
21961     * @enum _Elm_Map_Route_Type
21962     * @typedef Elm_Map_Route_Type
21963     *
21964     * Set type of transport used on route.
21965     *
21966     * @see elm_map_route_add()
21967     *
21968     * @ingroup Map
21969     */
21970    typedef enum _Elm_Map_Route_Type
21971      {
21972         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21973         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21974         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21975         ELM_MAP_ROUTE_TYPE_LAST
21976      } Elm_Map_Route_Type;
21977
21978    /**
21979     * @enum _Elm_Map_Route_Method
21980     * @typedef Elm_Map_Route_Method
21981     *
21982     * Set the routing method, what should be priorized, time or distance.
21983     *
21984     * @see elm_map_route_add()
21985     *
21986     * @ingroup Map
21987     */
21988    typedef enum _Elm_Map_Route_Method
21989      {
21990         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21991         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21992         ELM_MAP_ROUTE_METHOD_LAST
21993      } Elm_Map_Route_Method;
21994
21995    typedef enum _Elm_Map_Name_Method
21996      {
21997         ELM_MAP_NAME_METHOD_SEARCH,
21998         ELM_MAP_NAME_METHOD_REVERSE,
21999         ELM_MAP_NAME_METHOD_LAST
22000      } Elm_Map_Name_Method;
22001
22002    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(). */
22003    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(). */
22004    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(). */
22005    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(). */
22006    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22007    typedef struct _Elm_Map_Track           Elm_Map_Track;
22008
22009    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. */
22010    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22011    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22012    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22013
22014    typedef char        *(*ElmMapModuleSourceFunc) (void);
22015    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22016    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22017    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22018    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22019    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22020    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22021    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22022    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22023
22024    /**
22025     * Add a new map widget to the given parent Elementary (container) object.
22026     *
22027     * @param parent The parent object.
22028     * @return a new map widget handle or @c NULL, on errors.
22029     *
22030     * This function inserts a new map widget on the canvas.
22031     *
22032     * @ingroup Map
22033     */
22034    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22035
22036    /**
22037     * Set the zoom level of the map.
22038     *
22039     * @param obj The map object.
22040     * @param zoom The zoom level to set.
22041     *
22042     * This sets the zoom level.
22043     *
22044     * It will respect limits defined by elm_map_source_zoom_min_set() and
22045     * elm_map_source_zoom_max_set().
22046     *
22047     * By default these values are 0 (world map) and 18 (maximum zoom).
22048     *
22049     * This function should be used when zoom mode is set to
22050     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22051     * with elm_map_zoom_mode_set().
22052     *
22053     * @see elm_map_zoom_mode_set().
22054     * @see elm_map_zoom_get().
22055     *
22056     * @ingroup Map
22057     */
22058    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22059
22060    /**
22061     * Get the zoom level of the map.
22062     *
22063     * @param obj The map object.
22064     * @return The current zoom level.
22065     *
22066     * This returns the current zoom level of the map object.
22067     *
22068     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22069     * (which is the default), the zoom level may be changed at any time by the
22070     * map object itself to account for map size and map viewport size.
22071     *
22072     * @see elm_map_zoom_set() for details.
22073     *
22074     * @ingroup Map
22075     */
22076    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22077
22078    /**
22079     * Set the zoom mode used by the map object.
22080     *
22081     * @param obj The map object.
22082     * @param mode The zoom mode of the map, being it one of
22083     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22084     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22085     *
22086     * This sets the zoom mode to manual or one of the automatic levels.
22087     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22088     * elm_map_zoom_set() and will stay at that level until changed by code
22089     * or until zoom mode is changed. This is the default mode.
22090     *
22091     * The Automatic modes will allow the map object to automatically
22092     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22093     * adjust zoom so the map fits inside the scroll frame with no pixels
22094     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22095     * ensure no pixels within the frame are left unfilled. Do not forget that
22096     * the valid sizes are 2^zoom, consequently the map may be smaller than
22097     * the scroller view.
22098     *
22099     * @see elm_map_zoom_set()
22100     *
22101     * @ingroup Map
22102     */
22103    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22104
22105    /**
22106     * Get the zoom mode used by the map object.
22107     *
22108     * @param obj The map object.
22109     * @return The zoom mode of the map, being it one of
22110     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22111     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22112     *
22113     * This function returns the current zoom mode used by the map object.
22114     *
22115     * @see elm_map_zoom_mode_set() for more details.
22116     *
22117     * @ingroup Map
22118     */
22119    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22120
22121    /**
22122     * Get the current coordinates of the map.
22123     *
22124     * @param obj The map object.
22125     * @param lon Pointer where to store longitude.
22126     * @param lat Pointer where to store latitude.
22127     *
22128     * This gets the current center coordinates of the map object. It can be
22129     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22130     *
22131     * @see elm_map_geo_region_bring_in()
22132     * @see elm_map_geo_region_show()
22133     *
22134     * @ingroup Map
22135     */
22136    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22137
22138    /**
22139     * Animatedly bring in given coordinates to the center of the map.
22140     *
22141     * @param obj The map object.
22142     * @param lon Longitude to center at.
22143     * @param lat Latitude to center at.
22144     *
22145     * This causes map to jump to the given @p lat and @p lon coordinates
22146     * and show it (by scrolling) in the center of the viewport, if it is not
22147     * already centered. This will use animation to do so and take a period
22148     * of time to complete.
22149     *
22150     * @see elm_map_geo_region_show() for a function to avoid animation.
22151     * @see elm_map_geo_region_get()
22152     *
22153     * @ingroup Map
22154     */
22155    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22156
22157    /**
22158     * Show the given coordinates at the center of the map, @b immediately.
22159     *
22160     * @param obj The map object.
22161     * @param lon Longitude to center at.
22162     * @param lat Latitude to center at.
22163     *
22164     * This causes map to @b redraw its viewport's contents to the
22165     * region contining the given @p lat and @p lon, that will be moved to the
22166     * center of the map.
22167     *
22168     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22169     * @see elm_map_geo_region_get()
22170     *
22171     * @ingroup Map
22172     */
22173    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22174
22175    /**
22176     * Pause or unpause the map.
22177     *
22178     * @param obj The map object.
22179     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22180     * to unpause it.
22181     *
22182     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22183     * for map.
22184     *
22185     * The default is off.
22186     *
22187     * This will stop zooming using animation, changing zoom levels will
22188     * change instantly. This will stop any existing animations that are running.
22189     *
22190     * @see elm_map_paused_get()
22191     *
22192     * @ingroup Map
22193     */
22194    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22195
22196    /**
22197     * Get a value whether map is paused or not.
22198     *
22199     * @param obj The map object.
22200     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22201     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22202     *
22203     * This gets the current paused state for the map object.
22204     *
22205     * @see elm_map_paused_set() for details.
22206     *
22207     * @ingroup Map
22208     */
22209    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22210
22211    /**
22212     * Set to show markers during zoom level changes or not.
22213     *
22214     * @param obj The map object.
22215     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22216     * to show them.
22217     *
22218     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22219     * for map.
22220     *
22221     * The default is off.
22222     *
22223     * This will stop zooming using animation, changing zoom levels will
22224     * change instantly. This will stop any existing animations that are running.
22225     *
22226     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22227     * for the markers.
22228     *
22229     * The default  is off.
22230     *
22231     * Enabling it will force the map to stop displaying the markers during
22232     * zoom level changes. Set to on if you have a large number of markers.
22233     *
22234     * @see elm_map_paused_markers_get()
22235     *
22236     * @ingroup Map
22237     */
22238    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22239
22240    /**
22241     * Get a value whether markers will be displayed on zoom level changes or not
22242     *
22243     * @param obj The map object.
22244     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22245     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22246     *
22247     * This gets the current markers paused state for the map object.
22248     *
22249     * @see elm_map_paused_markers_set() for details.
22250     *
22251     * @ingroup Map
22252     */
22253    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22254
22255    /**
22256     * Get the information of downloading status.
22257     *
22258     * @param obj The map object.
22259     * @param try_num Pointer where to store number of tiles being downloaded.
22260     * @param finish_num Pointer where to store number of tiles successfully
22261     * downloaded.
22262     *
22263     * This gets the current downloading status for the map object, the number
22264     * of tiles being downloaded and the number of tiles already downloaded.
22265     *
22266     * @ingroup Map
22267     */
22268    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22269
22270    /**
22271     * Convert a pixel coordinate (x,y) into a geographic coordinate
22272     * (longitude, latitude).
22273     *
22274     * @param obj The map object.
22275     * @param x the coordinate.
22276     * @param y the coordinate.
22277     * @param size the size in pixels of the map.
22278     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22279     * @param lon Pointer where to store the longitude that correspond to x.
22280     * @param lat Pointer where to store the latitude that correspond to y.
22281     *
22282     * @note Origin pixel point is the top left corner of the viewport.
22283     * Map zoom and size are taken on account.
22284     *
22285     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22286     *
22287     * @ingroup Map
22288     */
22289    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);
22290
22291    /**
22292     * Convert a geographic coordinate (longitude, latitude) into a pixel
22293     * coordinate (x, y).
22294     *
22295     * @param obj The map object.
22296     * @param lon the longitude.
22297     * @param lat the latitude.
22298     * @param size the size in pixels of the map. The map is a square
22299     * and generally his size is : pow(2.0, zoom)*256.
22300     * @param x Pointer where to store the horizontal pixel coordinate that
22301     * correspond to the longitude.
22302     * @param y Pointer where to store the vertical pixel coordinate that
22303     * correspond to the latitude.
22304     *
22305     * @note Origin pixel point is the top left corner of the viewport.
22306     * Map zoom and size are taken on account.
22307     *
22308     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22309     *
22310     * @ingroup Map
22311     */
22312    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);
22313
22314    /**
22315     * Convert a geographic coordinate (longitude, latitude) into a name
22316     * (address).
22317     *
22318     * @param obj The map object.
22319     * @param lon the longitude.
22320     * @param lat the latitude.
22321     * @return name A #Elm_Map_Name handle for this coordinate.
22322     *
22323     * To get the string for this address, elm_map_name_address_get()
22324     * should be used.
22325     *
22326     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22327     *
22328     * @ingroup Map
22329     */
22330    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22331
22332    /**
22333     * Convert a name (address) into a geographic coordinate
22334     * (longitude, latitude).
22335     *
22336     * @param obj The map object.
22337     * @param name The address.
22338     * @return name A #Elm_Map_Name handle for this address.
22339     *
22340     * To get the longitude and latitude, elm_map_name_region_get()
22341     * should be used.
22342     *
22343     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22344     *
22345     * @ingroup Map
22346     */
22347    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22348
22349    /**
22350     * Convert a pixel coordinate into a rotated pixel coordinate.
22351     *
22352     * @param obj The map object.
22353     * @param x horizontal coordinate of the point to rotate.
22354     * @param y vertical coordinate of the point to rotate.
22355     * @param cx rotation's center horizontal position.
22356     * @param cy rotation's center vertical position.
22357     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22358     * @param xx Pointer where to store rotated x.
22359     * @param yy Pointer where to store rotated y.
22360     *
22361     * @ingroup Map
22362     */
22363    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);
22364
22365    /**
22366     * Add a new marker to the map object.
22367     *
22368     * @param obj The map object.
22369     * @param lon The longitude of the marker.
22370     * @param lat The latitude of the marker.
22371     * @param clas The class, to use when marker @b isn't grouped to others.
22372     * @param clas_group The class group, to use when marker is grouped to others
22373     * @param data The data passed to the callbacks.
22374     *
22375     * @return The created marker or @c NULL upon failure.
22376     *
22377     * A marker will be created and shown in a specific point of the map, defined
22378     * by @p lon and @p lat.
22379     *
22380     * It will be displayed using style defined by @p class when this marker
22381     * is displayed alone (not grouped). A new class can be created with
22382     * elm_map_marker_class_new().
22383     *
22384     * If the marker is grouped to other markers, it will be displayed with
22385     * style defined by @p class_group. Markers with the same group are grouped
22386     * if they are close. A new group class can be created with
22387     * elm_map_marker_group_class_new().
22388     *
22389     * Markers created with this method can be deleted with
22390     * elm_map_marker_remove().
22391     *
22392     * A marker can have associated content to be displayed by a bubble,
22393     * when a user click over it, as well as an icon. These objects will
22394     * be fetch using class' callback functions.
22395     *
22396     * @see elm_map_marker_class_new()
22397     * @see elm_map_marker_group_class_new()
22398     * @see elm_map_marker_remove()
22399     *
22400     * @ingroup Map
22401     */
22402    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);
22403
22404    /**
22405     * Set the maximum numbers of markers' content to be displayed in a group.
22406     *
22407     * @param obj The map object.
22408     * @param max The maximum numbers of items displayed in a bubble.
22409     *
22410     * A bubble will be displayed when the user clicks over the group,
22411     * and will place the content of markers that belong to this group
22412     * inside it.
22413     *
22414     * A group can have a long list of markers, consequently the creation
22415     * of the content of the bubble can be very slow.
22416     *
22417     * In order to avoid this, a maximum number of items is displayed
22418     * in a bubble.
22419     *
22420     * By default this number is 30.
22421     *
22422     * Marker with the same group class are grouped if they are close.
22423     *
22424     * @see elm_map_marker_add()
22425     *
22426     * @ingroup Map
22427     */
22428    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22429
22430    /**
22431     * Remove a marker from the map.
22432     *
22433     * @param marker The marker to remove.
22434     *
22435     * @see elm_map_marker_add()
22436     *
22437     * @ingroup Map
22438     */
22439    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22440
22441    /**
22442     * Get the current coordinates of the marker.
22443     *
22444     * @param marker marker.
22445     * @param lat Pointer where to store the marker's latitude.
22446     * @param lon Pointer where to store the marker's longitude.
22447     *
22448     * These values are set when adding markers, with function
22449     * elm_map_marker_add().
22450     *
22451     * @see elm_map_marker_add()
22452     *
22453     * @ingroup Map
22454     */
22455    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22456
22457    /**
22458     * Animatedly bring in given marker to the center of the map.
22459     *
22460     * @param marker The marker to center at.
22461     *
22462     * This causes map to jump to the given @p marker's coordinates
22463     * and show it (by scrolling) in the center of the viewport, if it is not
22464     * already centered. This will use animation to do so and take a period
22465     * of time to complete.
22466     *
22467     * @see elm_map_marker_show() for a function to avoid animation.
22468     * @see elm_map_marker_region_get()
22469     *
22470     * @ingroup Map
22471     */
22472    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22473
22474    /**
22475     * Show the given marker at the center of the map, @b immediately.
22476     *
22477     * @param marker The marker to center at.
22478     *
22479     * This causes map to @b redraw its viewport's contents to the
22480     * region contining the given @p marker's coordinates, that will be
22481     * moved to the center of the map.
22482     *
22483     * @see elm_map_marker_bring_in() for a function to move with animation.
22484     * @see elm_map_markers_list_show() if more than one marker need to be
22485     * displayed.
22486     * @see elm_map_marker_region_get()
22487     *
22488     * @ingroup Map
22489     */
22490    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22491
22492    /**
22493     * Move and zoom the map to display a list of markers.
22494     *
22495     * @param markers A list of #Elm_Map_Marker handles.
22496     *
22497     * The map will be centered on the center point of the markers in the list.
22498     * Then the map will be zoomed in order to fit the markers using the maximum
22499     * zoom which allows display of all the markers.
22500     *
22501     * @warning All the markers should belong to the same map object.
22502     *
22503     * @see elm_map_marker_show() to show a single marker.
22504     * @see elm_map_marker_bring_in()
22505     *
22506     * @ingroup Map
22507     */
22508    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22509
22510    /**
22511     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22512     *
22513     * @param marker The marker wich content should be returned.
22514     * @return Return the evas object if it exists, else @c NULL.
22515     *
22516     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22517     * elm_map_marker_class_get_cb_set() should be used.
22518     *
22519     * This content is what will be inside the bubble that will be displayed
22520     * when an user clicks over the marker.
22521     *
22522     * This returns the actual Evas object used to be placed inside
22523     * the bubble. This may be @c NULL, as it may
22524     * not have been created or may have been deleted, at any time, by
22525     * the map. <b>Do not modify this object</b> (move, resize,
22526     * show, hide, etc.), as the map is controlling it. This
22527     * function is for querying, emitting custom signals or hooking
22528     * lower level callbacks for events on that object. Do not delete
22529     * this object under any circumstances.
22530     *
22531     * @ingroup Map
22532     */
22533    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22534
22535    /**
22536     * Update the marker
22537     *
22538     * @param marker The marker to be updated.
22539     *
22540     * If a content is set to this marker, it will call function to delete it,
22541     * #ElmMapMarkerDelFunc, and then will fetch the content again with
22542     * #ElmMapMarkerGetFunc.
22543     *
22544     * These functions are set for the marker class with
22545     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22546     *
22547     * @ingroup Map
22548     */
22549    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22550
22551    /**
22552     * Close all the bubbles opened by the user.
22553     *
22554     * @param obj The map object.
22555     *
22556     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22557     * when the user clicks on a marker.
22558     *
22559     * This functions is set for the marker class with
22560     * elm_map_marker_class_get_cb_set().
22561     *
22562     * @ingroup Map
22563     */
22564    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22565
22566    /**
22567     * Create a new group class.
22568     *
22569     * @param obj The map object.
22570     * @return Returns the new group class.
22571     *
22572     * Each marker must be associated to a group class. Markers in the same
22573     * group are grouped if they are close.
22574     *
22575     * The group class defines the style of the marker when a marker is grouped
22576     * to others markers. When it is alone, another class will be used.
22577     *
22578     * A group class will need to be provided when creating a marker with
22579     * elm_map_marker_add().
22580     *
22581     * Some properties and functions can be set by class, as:
22582     * - style, with elm_map_group_class_style_set()
22583     * - data - to be associated to the group class. It can be set using
22584     *   elm_map_group_class_data_set().
22585     * - min zoom to display markers, set with
22586     *   elm_map_group_class_zoom_displayed_set().
22587     * - max zoom to group markers, set using
22588     *   elm_map_group_class_zoom_grouped_set().
22589     * - visibility - set if markers will be visible or not, set with
22590     *   elm_map_group_class_hide_set().
22591     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22592     *   It can be set using elm_map_group_class_icon_cb_set().
22593     *
22594     * @see elm_map_marker_add()
22595     * @see elm_map_group_class_style_set()
22596     * @see elm_map_group_class_data_set()
22597     * @see elm_map_group_class_zoom_displayed_set()
22598     * @see elm_map_group_class_zoom_grouped_set()
22599     * @see elm_map_group_class_hide_set()
22600     * @see elm_map_group_class_icon_cb_set()
22601     *
22602     * @ingroup Map
22603     */
22604    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22605
22606    /**
22607     * Set the marker's style of a group class.
22608     *
22609     * @param clas The group class.
22610     * @param style The style to be used by markers.
22611     *
22612     * Each marker must be associated to a group class, and will use the style
22613     * defined by such class when grouped to other markers.
22614     *
22615     * The following styles are provided by default theme:
22616     * @li @c radio - blue circle
22617     * @li @c radio2 - green circle
22618     * @li @c empty
22619     *
22620     * @see elm_map_group_class_new() for more details.
22621     * @see elm_map_marker_add()
22622     *
22623     * @ingroup Map
22624     */
22625    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22626
22627    /**
22628     * Set the icon callback function of a group class.
22629     *
22630     * @param clas The group class.
22631     * @param icon_get The callback function that will return the icon.
22632     *
22633     * Each marker must be associated to a group class, and it can display a
22634     * custom icon. The function @p icon_get must return this icon.
22635     *
22636     * @see elm_map_group_class_new() for more details.
22637     * @see elm_map_marker_add()
22638     *
22639     * @ingroup Map
22640     */
22641    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22642
22643    /**
22644     * Set the data associated to the group class.
22645     *
22646     * @param clas The group class.
22647     * @param data The new user data.
22648     *
22649     * This data will be passed for callback functions, like icon get callback,
22650     * that can be set with elm_map_group_class_icon_cb_set().
22651     *
22652     * If a data was previously set, the object will lose the pointer for it,
22653     * so if needs to be freed, you must do it yourself.
22654     *
22655     * @see elm_map_group_class_new() for more details.
22656     * @see elm_map_group_class_icon_cb_set()
22657     * @see elm_map_marker_add()
22658     *
22659     * @ingroup Map
22660     */
22661    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22662
22663    /**
22664     * Set the minimum zoom from where the markers are displayed.
22665     *
22666     * @param clas The group class.
22667     * @param zoom The minimum zoom.
22668     *
22669     * Markers only will be displayed when the map is displayed at @p zoom
22670     * or bigger.
22671     *
22672     * @see elm_map_group_class_new() for more details.
22673     * @see elm_map_marker_add()
22674     *
22675     * @ingroup Map
22676     */
22677    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22678
22679    /**
22680     * Set the zoom from where the markers are no more grouped.
22681     *
22682     * @param clas The group class.
22683     * @param zoom The maximum zoom.
22684     *
22685     * Markers only will be grouped when the map is displayed at
22686     * less than @p zoom.
22687     *
22688     * @see elm_map_group_class_new() for more details.
22689     * @see elm_map_marker_add()
22690     *
22691     * @ingroup Map
22692     */
22693    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22694
22695    /**
22696     * Set if the markers associated to the group class @clas are hidden or not.
22697     *
22698     * @param clas The group class.
22699     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22700     * to show them.
22701     *
22702     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22703     * is to show them.
22704     *
22705     * @ingroup Map
22706     */
22707    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22708
22709    /**
22710     * Create a new marker class.
22711     *
22712     * @param obj The map object.
22713     * @return Returns the new group class.
22714     *
22715     * Each marker must be associated to a class.
22716     *
22717     * The marker class defines the style of the marker when a marker is
22718     * displayed alone, i.e., not grouped to to others markers. When grouped
22719     * it will use group class style.
22720     *
22721     * A marker class will need to be provided when creating a marker with
22722     * elm_map_marker_add().
22723     *
22724     * Some properties and functions can be set by class, as:
22725     * - style, with elm_map_marker_class_style_set()
22726     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22727     *   It can be set using elm_map_marker_class_icon_cb_set().
22728     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22729     *   Set using elm_map_marker_class_get_cb_set().
22730     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22731     *   Set using elm_map_marker_class_del_cb_set().
22732     *
22733     * @see elm_map_marker_add()
22734     * @see elm_map_marker_class_style_set()
22735     * @see elm_map_marker_class_icon_cb_set()
22736     * @see elm_map_marker_class_get_cb_set()
22737     * @see elm_map_marker_class_del_cb_set()
22738     *
22739     * @ingroup Map
22740     */
22741    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22742
22743    /**
22744     * Set the marker's style of a marker class.
22745     *
22746     * @param clas The marker class.
22747     * @param style The style to be used by markers.
22748     *
22749     * Each marker must be associated to a marker class, and will use the style
22750     * defined by such class when alone, i.e., @b not grouped to other markers.
22751     *
22752     * The following styles are provided by default theme:
22753     * @li @c radio
22754     * @li @c radio2
22755     * @li @c empty
22756     *
22757     * @see elm_map_marker_class_new() for more details.
22758     * @see elm_map_marker_add()
22759     *
22760     * @ingroup Map
22761     */
22762    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22763
22764    /**
22765     * Set the icon callback function of a marker class.
22766     *
22767     * @param clas The marker class.
22768     * @param icon_get The callback function that will return the icon.
22769     *
22770     * Each marker must be associated to a marker class, and it can display a
22771     * custom icon. The function @p icon_get must return this icon.
22772     *
22773     * @see elm_map_marker_class_new() for more details.
22774     * @see elm_map_marker_add()
22775     *
22776     * @ingroup Map
22777     */
22778    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22779
22780    /**
22781     * Set the bubble content callback function of a marker class.
22782     *
22783     * @param clas The marker class.
22784     * @param get The callback function that will return the content.
22785     *
22786     * Each marker must be associated to a marker class, and it can display a
22787     * a content on a bubble that opens when the user click over the marker.
22788     * The function @p get must return this content object.
22789     *
22790     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22791     * can be used.
22792     *
22793     * @see elm_map_marker_class_new() for more details.
22794     * @see elm_map_marker_class_del_cb_set()
22795     * @see elm_map_marker_add()
22796     *
22797     * @ingroup Map
22798     */
22799    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22800
22801    /**
22802     * Set the callback function used to delete bubble content of a marker class.
22803     *
22804     * @param clas The marker class.
22805     * @param del The callback function that will delete the content.
22806     *
22807     * Each marker must be associated to a marker class, and it can display a
22808     * a content on a bubble that opens when the user click over the marker.
22809     * The function to return such content can be set with
22810     * elm_map_marker_class_get_cb_set().
22811     *
22812     * If this content must be freed, a callback function need to be
22813     * set for that task with this function.
22814     *
22815     * If this callback is defined it will have to delete (or not) the
22816     * object inside, but if the callback is not defined the object will be
22817     * destroyed with evas_object_del().
22818     *
22819     * @see elm_map_marker_class_new() for more details.
22820     * @see elm_map_marker_class_get_cb_set()
22821     * @see elm_map_marker_add()
22822     *
22823     * @ingroup Map
22824     */
22825    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22826
22827    /**
22828     * Get the list of available sources.
22829     *
22830     * @param obj The map object.
22831     * @return The source names list.
22832     *
22833     * It will provide a list with all available sources, that can be set as
22834     * current source with elm_map_source_name_set(), or get with
22835     * elm_map_source_name_get().
22836     *
22837     * Available sources:
22838     * @li "Mapnik"
22839     * @li "Osmarender"
22840     * @li "CycleMap"
22841     * @li "Maplint"
22842     *
22843     * @see elm_map_source_name_set() for more details.
22844     * @see elm_map_source_name_get()
22845     *
22846     * @ingroup Map
22847     */
22848    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22849
22850    /**
22851     * Set the source of the map.
22852     *
22853     * @param obj The map object.
22854     * @param source The source to be used.
22855     *
22856     * Map widget retrieves images that composes the map from a web service.
22857     * This web service can be set with this method.
22858     *
22859     * A different service can return a different maps with different
22860     * information and it can use different zoom values.
22861     *
22862     * The @p source_name need to match one of the names provided by
22863     * elm_map_source_names_get().
22864     *
22865     * The current source can be get using elm_map_source_name_get().
22866     *
22867     * @see elm_map_source_names_get()
22868     * @see elm_map_source_name_get()
22869     *
22870     *
22871     * @ingroup Map
22872     */
22873    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22874
22875    /**
22876     * Get the name of currently used source.
22877     *
22878     * @param obj The map object.
22879     * @return Returns the name of the source in use.
22880     *
22881     * @see elm_map_source_name_set() for more details.
22882     *
22883     * @ingroup Map
22884     */
22885    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22886
22887    /**
22888     * Set the source of the route service to be used by the map.
22889     *
22890     * @param obj The map object.
22891     * @param source The route service to be used, being it one of
22892     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22893     * and #ELM_MAP_ROUTE_SOURCE_ORS.
22894     *
22895     * Each one has its own algorithm, so the route retrieved may
22896     * differ depending on the source route. Now, only the default is working.
22897     *
22898     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22899     * http://www.yournavigation.org/.
22900     *
22901     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22902     * assumptions. Its routing core is based on Contraction Hierarchies.
22903     *
22904     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22905     *
22906     * @see elm_map_route_source_get().
22907     *
22908     * @ingroup Map
22909     */
22910    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22911
22912    /**
22913     * Get the current route source.
22914     *
22915     * @param obj The map object.
22916     * @return The source of the route service used by the map.
22917     *
22918     * @see elm_map_route_source_set() for details.
22919     *
22920     * @ingroup Map
22921     */
22922    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22923
22924    /**
22925     * Set the minimum zoom of the source.
22926     *
22927     * @param obj The map object.
22928     * @param zoom New minimum zoom value to be used.
22929     *
22930     * By default, it's 0.
22931     *
22932     * @ingroup Map
22933     */
22934    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22935
22936    /**
22937     * Get the minimum zoom of the source.
22938     *
22939     * @param obj The map object.
22940     * @return Returns the minimum zoom of the source.
22941     *
22942     * @see elm_map_source_zoom_min_set() for details.
22943     *
22944     * @ingroup Map
22945     */
22946    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22947
22948    /**
22949     * Set the maximum zoom of the source.
22950     *
22951     * @param obj The map object.
22952     * @param zoom New maximum zoom value to be used.
22953     *
22954     * By default, it's 18.
22955     *
22956     * @ingroup Map
22957     */
22958    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22959
22960    /**
22961     * Get the maximum zoom of the source.
22962     *
22963     * @param obj The map object.
22964     * @return Returns the maximum zoom of the source.
22965     *
22966     * @see elm_map_source_zoom_min_set() for details.
22967     *
22968     * @ingroup Map
22969     */
22970    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22971
22972    /**
22973     * Set the user agent used by the map object to access routing services.
22974     *
22975     * @param obj The map object.
22976     * @param user_agent The user agent to be used by the map.
22977     *
22978     * User agent is a client application implementing a network protocol used
22979     * in communications within a client–server distributed computing system
22980     *
22981     * The @p user_agent identification string will transmitted in a header
22982     * field @c User-Agent.
22983     *
22984     * @see elm_map_user_agent_get()
22985     *
22986     * @ingroup Map
22987     */
22988    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22989
22990    /**
22991     * Get the user agent used by the map object.
22992     *
22993     * @param obj The map object.
22994     * @return The user agent identification string used by the map.
22995     *
22996     * @see elm_map_user_agent_set() for details.
22997     *
22998     * @ingroup Map
22999     */
23000    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23001
23002    /**
23003     * Add a new route to the map object.
23004     *
23005     * @param obj The map object.
23006     * @param type The type of transport to be considered when tracing a route.
23007     * @param method The routing method, what should be priorized.
23008     * @param flon The start longitude.
23009     * @param flat The start latitude.
23010     * @param tlon The destination longitude.
23011     * @param tlat The destination latitude.
23012     *
23013     * @return The created route or @c NULL upon failure.
23014     *
23015     * A route will be traced by point on coordinates (@p flat, @p flon)
23016     * to point on coordinates (@p tlat, @p tlon), using the route service
23017     * set with elm_map_route_source_set().
23018     *
23019     * It will take @p type on consideration to define the route,
23020     * depending if the user will be walking or driving, the route may vary.
23021     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23022     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23023     *
23024     * Another parameter is what the route should priorize, the minor distance
23025     * or the less time to be spend on the route. So @p method should be one
23026     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23027     *
23028     * Routes created with this method can be deleted with
23029     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23030     * and distance can be get with elm_map_route_distance_get().
23031     *
23032     * @see elm_map_route_remove()
23033     * @see elm_map_route_color_set()
23034     * @see elm_map_route_distance_get()
23035     * @see elm_map_route_source_set()
23036     *
23037     * @ingroup Map
23038     */
23039    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);
23040
23041    /**
23042     * Remove a route from the map.
23043     *
23044     * @param route The route to remove.
23045     *
23046     * @see elm_map_route_add()
23047     *
23048     * @ingroup Map
23049     */
23050    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23051
23052    /**
23053     * Set the route color.
23054     *
23055     * @param route The route object.
23056     * @param r Red channel value, from 0 to 255.
23057     * @param g Green channel value, from 0 to 255.
23058     * @param b Blue channel value, from 0 to 255.
23059     * @param a Alpha channel value, from 0 to 255.
23060     *
23061     * It uses an additive color model, so each color channel represents
23062     * how much of each primary colors must to be used. 0 represents
23063     * ausence of this color, so if all of the three are set to 0,
23064     * the color will be black.
23065     *
23066     * These component values should be integers in the range 0 to 255,
23067     * (single 8-bit byte).
23068     *
23069     * This sets the color used for the route. By default, it is set to
23070     * solid red (r = 255, g = 0, b = 0, a = 255).
23071     *
23072     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23073     *
23074     * @see elm_map_route_color_get()
23075     *
23076     * @ingroup Map
23077     */
23078    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23079
23080    /**
23081     * Get the route color.
23082     *
23083     * @param route The route object.
23084     * @param r Pointer where to store the red channel value.
23085     * @param g Pointer where to store the green channel value.
23086     * @param b Pointer where to store the blue channel value.
23087     * @param a Pointer where to store the alpha channel value.
23088     *
23089     * @see elm_map_route_color_set() for details.
23090     *
23091     * @ingroup Map
23092     */
23093    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23094
23095    /**
23096     * Get the route distance in kilometers.
23097     *
23098     * @param route The route object.
23099     * @return The distance of route (unit : km).
23100     *
23101     * @ingroup Map
23102     */
23103    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23104
23105    /**
23106     * Get the information of route nodes.
23107     *
23108     * @param route The route object.
23109     * @return Returns a string with the nodes of route.
23110     *
23111     * @ingroup Map
23112     */
23113    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23114
23115    /**
23116     * Get the information of route waypoint.
23117     *
23118     * @param route the route object.
23119     * @return Returns a string with information about waypoint of route.
23120     *
23121     * @ingroup Map
23122     */
23123    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23124
23125    /**
23126     * Get the address of the name.
23127     *
23128     * @param name The name handle.
23129     * @return Returns the address string of @p name.
23130     *
23131     * This gets the coordinates of the @p name, created with one of the
23132     * conversion functions.
23133     *
23134     * @see elm_map_utils_convert_name_into_coord()
23135     * @see elm_map_utils_convert_coord_into_name()
23136     *
23137     * @ingroup Map
23138     */
23139    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23140
23141    /**
23142     * Get the current coordinates of the name.
23143     *
23144     * @param name The name handle.
23145     * @param lat Pointer where to store the latitude.
23146     * @param lon Pointer where to store The longitude.
23147     *
23148     * This gets the coordinates of the @p name, created with one of the
23149     * conversion functions.
23150     *
23151     * @see elm_map_utils_convert_name_into_coord()
23152     * @see elm_map_utils_convert_coord_into_name()
23153     *
23154     * @ingroup Map
23155     */
23156    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23157
23158    /**
23159     * Remove a name from the map.
23160     *
23161     * @param name The name to remove.
23162     *
23163     * Basically the struct handled by @p name will be freed, so convertions
23164     * between address and coordinates will be lost.
23165     *
23166     * @see elm_map_utils_convert_name_into_coord()
23167     * @see elm_map_utils_convert_coord_into_name()
23168     *
23169     * @ingroup Map
23170     */
23171    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23172
23173    /**
23174     * Rotate the map.
23175     *
23176     * @param obj The map object.
23177     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23178     * @param cx Rotation's center horizontal position.
23179     * @param cy Rotation's center vertical position.
23180     *
23181     * @see elm_map_rotate_get()
23182     *
23183     * @ingroup Map
23184     */
23185    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23186
23187    /**
23188     * Get the rotate degree of the map
23189     *
23190     * @param obj The map object
23191     * @param degree Pointer where to store degrees from 0.0 to 360.0
23192     * to rotate arount Z axis.
23193     * @param cx Pointer where to store rotation's center horizontal position.
23194     * @param cy Pointer where to store rotation's center vertical position.
23195     *
23196     * @see elm_map_rotate_set() to set map rotation.
23197     *
23198     * @ingroup Map
23199     */
23200    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);
23201
23202    /**
23203     * Enable or disable mouse wheel to be used to zoom in / out the map.
23204     *
23205     * @param obj The map object.
23206     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23207     * to enable it.
23208     *
23209     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23210     *
23211     * It's disabled by default.
23212     *
23213     * @see elm_map_wheel_disabled_get()
23214     *
23215     * @ingroup Map
23216     */
23217    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23218
23219    /**
23220     * Get a value whether mouse wheel is enabled or not.
23221     *
23222     * @param obj The map object.
23223     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23224     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23225     *
23226     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23227     *
23228     * @see elm_map_wheel_disabled_set() for details.
23229     *
23230     * @ingroup Map
23231     */
23232    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23233
23234 #ifdef ELM_EMAP
23235    /**
23236     * Add a track on the map
23237     *
23238     * @param obj The map object.
23239     * @param emap The emap route object.
23240     * @return The route object. This is an elm object of type Route.
23241     *
23242     * @see elm_route_add() for details.
23243     *
23244     * @ingroup Map
23245     */
23246    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23247 #endif
23248
23249    /**
23250     * Remove a track from the map
23251     *
23252     * @param obj The map object.
23253     * @param route The track to remove.
23254     *
23255     * @ingroup Map
23256     */
23257    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23258
23259    /**
23260     * @}
23261     */
23262
23263    /* Route */
23264    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23265 #ifdef ELM_EMAP
23266    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23267 #endif
23268    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23269    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23270    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23271    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23272
23273
23274    /**
23275     * @defgroup Panel Panel
23276     *
23277     * @image html img/widget/panel/preview-00.png
23278     * @image latex img/widget/panel/preview-00.eps
23279     *
23280     * @brief A panel is a type of animated container that contains subobjects.
23281     * It can be expanded or contracted by clicking the button on it's edge.
23282     *
23283     * Orientations are as follows:
23284     * @li ELM_PANEL_ORIENT_TOP
23285     * @li ELM_PANEL_ORIENT_LEFT
23286     * @li ELM_PANEL_ORIENT_RIGHT
23287     *
23288     * @ref tutorial_panel shows one way to use this widget.
23289     * @{
23290     */
23291    typedef enum _Elm_Panel_Orient
23292      {
23293         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23294         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23295         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23296         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23297      } Elm_Panel_Orient;
23298    /**
23299     * @brief Adds a panel object
23300     *
23301     * @param parent The parent object
23302     *
23303     * @return The panel object, or NULL on failure
23304     */
23305    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23306    /**
23307     * @brief Sets the orientation of the panel
23308     *
23309     * @param parent The parent object
23310     * @param orient The panel orientation. Can be one of the following:
23311     * @li ELM_PANEL_ORIENT_TOP
23312     * @li ELM_PANEL_ORIENT_LEFT
23313     * @li ELM_PANEL_ORIENT_RIGHT
23314     *
23315     * Sets from where the panel will (dis)appear.
23316     */
23317    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23318    /**
23319     * @brief Get the orientation of the panel.
23320     *
23321     * @param obj The panel object
23322     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23323     */
23324    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23325    /**
23326     * @brief Set the content of the panel.
23327     *
23328     * @param obj The panel object
23329     * @param content The panel content
23330     *
23331     * Once the content object is set, a previously set one will be deleted.
23332     * If you want to keep that old content object, use the
23333     * elm_panel_content_unset() function.
23334     */
23335    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23336    /**
23337     * @brief Get the content of the panel.
23338     *
23339     * @param obj The panel object
23340     * @return The content that is being used
23341     *
23342     * Return the content object which is set for this widget.
23343     *
23344     * @see elm_panel_content_set()
23345     */
23346    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23347    /**
23348     * @brief Unset the content of the panel.
23349     *
23350     * @param obj The panel object
23351     * @return The content that was being used
23352     *
23353     * Unparent and return the content object which was set for this widget.
23354     *
23355     * @see elm_panel_content_set()
23356     */
23357    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23358    /**
23359     * @brief Set the state of the panel.
23360     *
23361     * @param obj The panel object
23362     * @param hidden If true, the panel will run the animation to contract
23363     */
23364    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23365    /**
23366     * @brief Get the state of the panel.
23367     *
23368     * @param obj The panel object
23369     * @param hidden If true, the panel is in the "hide" state
23370     */
23371    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23372    /**
23373     * @brief Toggle the hidden state of the panel from code
23374     *
23375     * @param obj The panel object
23376     */
23377    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23378    /**
23379     * @}
23380     */
23381
23382    /**
23383     * @defgroup Panes Panes
23384     * @ingroup Elementary
23385     *
23386     * @image html img/widget/panes/preview-00.png
23387     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23388     *
23389     * @image html img/panes.png
23390     * @image latex img/panes.eps width=\textwidth
23391     *
23392     * The panes adds a dragable bar between two contents. When dragged
23393     * this bar will resize contents size.
23394     *
23395     * Panes can be displayed vertically or horizontally, and contents
23396     * size proportion can be customized (homogeneous by default).
23397     *
23398     * Smart callbacks one can listen to:
23399     * - "press" - The panes has been pressed (button wasn't released yet).
23400     * - "unpressed" - The panes was released after being pressed.
23401     * - "clicked" - The panes has been clicked>
23402     * - "clicked,double" - The panes has been double clicked
23403     *
23404     * Available styles for it:
23405     * - @c "default"
23406     *
23407     * Here is an example on its usage:
23408     * @li @ref panes_example
23409     */
23410
23411    /**
23412     * @addtogroup Panes
23413     * @{
23414     */
23415
23416    /**
23417     * Add a new panes widget to the given parent Elementary
23418     * (container) object.
23419     *
23420     * @param parent The parent object.
23421     * @return a new panes widget handle or @c NULL, on errors.
23422     *
23423     * This function inserts a new panes widget on the canvas.
23424     *
23425     * @ingroup Panes
23426     */
23427    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23428
23429    /**
23430     * Set the left content of the panes widget.
23431     *
23432     * @param obj The panes object.
23433     * @param content The new left content object.
23434     *
23435     * Once the content object is set, a previously set one will be deleted.
23436     * If you want to keep that old content object, use the
23437     * elm_panes_content_left_unset() function.
23438     *
23439     * If panes is displayed vertically, left content will be displayed at
23440     * top.
23441     *
23442     * @see elm_panes_content_left_get()
23443     * @see elm_panes_content_right_set() to set content on the other side.
23444     *
23445     * @ingroup Panes
23446     */
23447    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23448
23449    /**
23450     * Set the right content of the panes widget.
23451     *
23452     * @param obj The panes object.
23453     * @param content The new right content object.
23454     *
23455     * Once the content object is set, a previously set one will be deleted.
23456     * If you want to keep that old content object, use the
23457     * elm_panes_content_right_unset() function.
23458     *
23459     * If panes is displayed vertically, left content will be displayed at
23460     * bottom.
23461     *
23462     * @see elm_panes_content_right_get()
23463     * @see elm_panes_content_left_set() to set content on the other side.
23464     *
23465     * @ingroup Panes
23466     */
23467    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23468
23469    /**
23470     * Get the left content of the panes.
23471     *
23472     * @param obj The panes object.
23473     * @return The left content object that is being used.
23474     *
23475     * Return the left content object which is set for this widget.
23476     *
23477     * @see elm_panes_content_left_set() for details.
23478     *
23479     * @ingroup Panes
23480     */
23481    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23482
23483    /**
23484     * Get the right content of the panes.
23485     *
23486     * @param obj The panes object
23487     * @return The right content object that is being used
23488     *
23489     * Return the right content object which is set for this widget.
23490     *
23491     * @see elm_panes_content_right_set() for details.
23492     *
23493     * @ingroup Panes
23494     */
23495    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23496
23497    /**
23498     * Unset the left content used for the panes.
23499     *
23500     * @param obj The panes object.
23501     * @return The left content object that was being used.
23502     *
23503     * Unparent and return the left content object which was set for this widget.
23504     *
23505     * @see elm_panes_content_left_set() for details.
23506     * @see elm_panes_content_left_get().
23507     *
23508     * @ingroup Panes
23509     */
23510    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23511
23512    /**
23513     * Unset the right content used for the panes.
23514     *
23515     * @param obj The panes object.
23516     * @return The right content object that was being used.
23517     *
23518     * Unparent and return the right content object which was set for this
23519     * widget.
23520     *
23521     * @see elm_panes_content_right_set() for details.
23522     * @see elm_panes_content_right_get().
23523     *
23524     * @ingroup Panes
23525     */
23526    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23527
23528    /**
23529     * Get the size proportion of panes widget's left side.
23530     *
23531     * @param obj The panes object.
23532     * @return float value between 0.0 and 1.0 representing size proportion
23533     * of left side.
23534     *
23535     * @see elm_panes_content_left_size_set() for more details.
23536     *
23537     * @ingroup Panes
23538     */
23539    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23540
23541    /**
23542     * Set the size proportion of panes widget's left side.
23543     *
23544     * @param obj The panes object.
23545     * @param size Value between 0.0 and 1.0 representing size proportion
23546     * of left side.
23547     *
23548     * By default it's homogeneous, i.e., both sides have the same size.
23549     *
23550     * If something different is required, it can be set with this function.
23551     * For example, if the left content should be displayed over
23552     * 75% of the panes size, @p size should be passed as @c 0.75.
23553     * This way, right content will be resized to 25% of panes size.
23554     *
23555     * If displayed vertically, left content is displayed at top, and
23556     * right content at bottom.
23557     *
23558     * @note This proportion will change when user drags the panes bar.
23559     *
23560     * @see elm_panes_content_left_size_get()
23561     *
23562     * @ingroup Panes
23563     */
23564    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23565
23566   /**
23567    * Set the orientation of a given panes widget.
23568    *
23569    * @param obj The panes object.
23570    * @param horizontal Use @c EINA_TRUE to make @p obj to be
23571    * @b horizontal, @c EINA_FALSE to make it @b vertical.
23572    *
23573    * Use this function to change how your panes is to be
23574    * disposed: vertically or horizontally.
23575    *
23576    * By default it's displayed horizontally.
23577    *
23578    * @see elm_panes_horizontal_get()
23579    *
23580    * @ingroup Panes
23581    */
23582    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23583
23584    /**
23585     * Retrieve the orientation of a given panes widget.
23586     *
23587     * @param obj The panes object.
23588     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23589     * @c EINA_FALSE if it's @b vertical (and on errors).
23590     *
23591     * @see elm_panes_horizontal_set() for more details.
23592     *
23593     * @ingroup Panes
23594     */
23595    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23596
23597    /**
23598     * @}
23599     */
23600
23601    /**
23602     * @defgroup Flip Flip
23603     *
23604     * @image html img/widget/flip/preview-00.png
23605     * @image latex img/widget/flip/preview-00.eps
23606     *
23607     * This widget holds 2 content objects(Evas_Object): one on the front and one
23608     * on the back. It allows you to flip from front to back and vice-versa using
23609     * various animations.
23610     *
23611     * If either the front or back contents are not set the flip will treat that
23612     * as transparent. So if you wore to set the front content but not the back,
23613     * and then call elm_flip_go() you would see whatever is below the flip.
23614     *
23615     * For a list of supported animations see elm_flip_go().
23616     *
23617     * Signals that you can add callbacks for are:
23618     * "animate,begin" - when a flip animation was started
23619     * "animate,done" - when a flip animation is finished
23620     *
23621     * @ref tutorial_flip show how to use most of the API.
23622     *
23623     * @{
23624     */
23625    typedef enum _Elm_Flip_Mode
23626      {
23627         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23628         ELM_FLIP_ROTATE_X_CENTER_AXIS,
23629         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23630         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23631         ELM_FLIP_CUBE_LEFT,
23632         ELM_FLIP_CUBE_RIGHT,
23633         ELM_FLIP_CUBE_UP,
23634         ELM_FLIP_CUBE_DOWN,
23635         ELM_FLIP_PAGE_LEFT,
23636         ELM_FLIP_PAGE_RIGHT,
23637         ELM_FLIP_PAGE_UP,
23638         ELM_FLIP_PAGE_DOWN
23639      } Elm_Flip_Mode;
23640    typedef enum _Elm_Flip_Interaction
23641      {
23642         ELM_FLIP_INTERACTION_NONE,
23643         ELM_FLIP_INTERACTION_ROTATE,
23644         ELM_FLIP_INTERACTION_CUBE,
23645         ELM_FLIP_INTERACTION_PAGE
23646      } Elm_Flip_Interaction;
23647    typedef enum _Elm_Flip_Direction
23648      {
23649         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23650         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23651         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23652         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23653      } Elm_Flip_Direction;
23654    /**
23655     * @brief Add a new flip to the parent
23656     *
23657     * @param parent The parent object
23658     * @return The new object or NULL if it cannot be created
23659     */
23660    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23661    /**
23662     * @brief Set the front content of the flip widget.
23663     *
23664     * @param obj The flip object
23665     * @param content The new front content object
23666     *
23667     * Once the content object is set, a previously set one will be deleted.
23668     * If you want to keep that old content object, use the
23669     * elm_flip_content_front_unset() function.
23670     */
23671    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23672    /**
23673     * @brief Set the back content of the flip widget.
23674     *
23675     * @param obj The flip object
23676     * @param content The new back content object
23677     *
23678     * Once the content object is set, a previously set one will be deleted.
23679     * If you want to keep that old content object, use the
23680     * elm_flip_content_back_unset() function.
23681     */
23682    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23683    /**
23684     * @brief Get the front content used for the flip
23685     *
23686     * @param obj The flip object
23687     * @return The front content object that is being used
23688     *
23689     * Return the front content object which is set for this widget.
23690     */
23691    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23692    /**
23693     * @brief Get the back content used for the flip
23694     *
23695     * @param obj The flip object
23696     * @return The back content object that is being used
23697     *
23698     * Return the back content object which is set for this widget.
23699     */
23700    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23701    /**
23702     * @brief Unset the front content used for the flip
23703     *
23704     * @param obj The flip object
23705     * @return The front content object that was being used
23706     *
23707     * Unparent and return the front content object which was set for this widget.
23708     */
23709    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23710    /**
23711     * @brief Unset the back content used for the flip
23712     *
23713     * @param obj The flip object
23714     * @return The back content object that was being used
23715     *
23716     * Unparent and return the back content object which was set for this widget.
23717     */
23718    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23719    /**
23720     * @brief Get flip front visibility state
23721     *
23722     * @param obj The flip objct
23723     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23724     * showing.
23725     */
23726    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23727    /**
23728     * @brief Set flip perspective
23729     *
23730     * @param obj The flip object
23731     * @param foc The coordinate to set the focus on
23732     * @param x The X coordinate
23733     * @param y The Y coordinate
23734     *
23735     * @warning This function currently does nothing.
23736     */
23737    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23738    /**
23739     * @brief Runs the flip animation
23740     *
23741     * @param obj The flip object
23742     * @param mode The mode type
23743     *
23744     * Flips the front and back contents using the @p mode animation. This
23745     * efectively hides the currently visible content and shows the hidden one.
23746     *
23747     * There a number of possible animations to use for the flipping:
23748     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23749     * around a horizontal axis in the middle of its height, the other content
23750     * is shown as the other side of the flip.
23751     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23752     * around a vertical axis in the middle of its width, the other content is
23753     * shown as the other side of the flip.
23754     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23755     * around a diagonal axis in the middle of its width, the other content is
23756     * shown as the other side of the flip.
23757     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23758     * around a diagonal axis in the middle of its height, the other content is
23759     * shown as the other side of the flip.
23760     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23761     * as if the flip was a cube, the other content is show as the right face of
23762     * the cube.
23763     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23764     * right as if the flip was a cube, the other content is show as the left
23765     * face of the cube.
23766     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23767     * flip was a cube, the other content is show as the bottom face of the cube.
23768     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23769     * the flip was a cube, the other content is show as the upper face of the
23770     * cube.
23771     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23772     * if the flip was a book, the other content is shown as the page below that.
23773     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23774     * as if the flip was a book, the other content is shown as the page below
23775     * that.
23776     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23777     * flip was a book, the other content is shown as the page below that.
23778     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23779     * flip was a book, the other content is shown as the page below that.
23780     *
23781     * @image html elm_flip.png
23782     * @image latex elm_flip.eps width=\textwidth
23783     */
23784    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23785    /**
23786     * @brief Set the interactive flip mode
23787     *
23788     * @param obj The flip object
23789     * @param mode The interactive flip mode to use
23790     *
23791     * This sets if the flip should be interactive (allow user to click and
23792     * drag a side of the flip to reveal the back page and cause it to flip).
23793     * By default a flip is not interactive. You may also need to set which
23794     * sides of the flip are "active" for flipping and how much space they use
23795     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23796     * and elm_flip_interacton_direction_hitsize_set()
23797     *
23798     * The four avilable mode of interaction are:
23799     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23800     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23801     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23802     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23803     *
23804     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23805     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23806     * happen, those can only be acheived with elm_flip_go();
23807     */
23808    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23809    /**
23810     * @brief Get the interactive flip mode
23811     *
23812     * @param obj The flip object
23813     * @return The interactive flip mode
23814     *
23815     * Returns the interactive flip mode set by elm_flip_interaction_set()
23816     */
23817    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23818    /**
23819     * @brief Set which directions of the flip respond to interactive flip
23820     *
23821     * @param obj The flip object
23822     * @param dir The direction to change
23823     * @param enabled If that direction is enabled or not
23824     *
23825     * By default all directions are disabled, so you may want to enable the
23826     * desired directions for flipping if you need interactive flipping. You must
23827     * call this function once for each direction that should be enabled.
23828     *
23829     * @see elm_flip_interaction_set()
23830     */
23831    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23832    /**
23833     * @brief Get the enabled state of that flip direction
23834     *
23835     * @param obj The flip object
23836     * @param dir The direction to check
23837     * @return If that direction is enabled or not
23838     *
23839     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23840     *
23841     * @see elm_flip_interaction_set()
23842     */
23843    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23844    /**
23845     * @brief Set the amount of the flip that is sensitive to interactive flip
23846     *
23847     * @param obj The flip object
23848     * @param dir The direction to modify
23849     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23850     *
23851     * Set the amount of the flip that is sensitive to interactive flip, with 0
23852     * representing no area in the flip and 1 representing the entire flip. There
23853     * is however a consideration to be made in that the area will never be
23854     * smaller than the finger size set(as set in your Elementary configuration).
23855     *
23856     * @see elm_flip_interaction_set()
23857     */
23858    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23859    /**
23860     * @brief Get the amount of the flip that is sensitive to interactive flip
23861     *
23862     * @param obj The flip object
23863     * @param dir The direction to check
23864     * @return The size set for that direction
23865     *
23866     * Returns the amount os sensitive area set by
23867     * elm_flip_interacton_direction_hitsize_set().
23868     */
23869    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23870    /**
23871     * @}
23872     */
23873
23874    /* scrolledentry */
23875    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23876    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23877    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23878    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23879    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23880    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23881    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23882    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23883    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23884    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23885    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23886    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23887    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23888    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23889    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23890    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23891    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23892    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23893    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23894    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23895    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23896    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23897    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23898    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23899    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23900    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23901    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23902    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23903    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23904    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23905    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23906    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23907    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23908    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23909    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23910    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);
23911    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23912    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23913    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);
23914    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23915    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);
23916    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23917    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23918    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23919    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23920    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23921    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23922    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23923    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23924    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);
23925    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);
23926    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);
23927    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);
23928    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);
23929    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);
23930    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23931    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23932    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23933    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23934    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23935    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23936    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23937
23938    /**
23939     * @defgroup Conformant Conformant
23940     * @ingroup Elementary
23941     *
23942     * @image html img/widget/conformant/preview-00.png
23943     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23944     *
23945     * @image html img/conformant.png
23946     * @image latex img/conformant.eps width=\textwidth
23947     *
23948     * The aim is to provide a widget that can be used in elementary apps to
23949     * account for space taken up by the indicator, virtual keypad & softkey
23950     * windows when running the illume2 module of E17.
23951     *
23952     * So conformant content will be sized and positioned considering the
23953     * space required for such stuff, and when they popup, as a keyboard
23954     * shows when an entry is selected, conformant content won't change.
23955     *
23956     * Available styles for it:
23957     * - @c "default"
23958     *
23959     * See how to use this widget in this example:
23960     * @ref conformant_example
23961     */
23962
23963    /**
23964     * @addtogroup Conformant
23965     * @{
23966     */
23967
23968    /**
23969     * Add a new conformant widget to the given parent Elementary
23970     * (container) object.
23971     *
23972     * @param parent The parent object.
23973     * @return A new conformant widget handle or @c NULL, on errors.
23974     *
23975     * This function inserts a new conformant widget on the canvas.
23976     *
23977     * @ingroup Conformant
23978     */
23979    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23980
23981    /**
23982     * Set the content of the conformant widget.
23983     *
23984     * @param obj The conformant object.
23985     * @param content The content to be displayed by the conformant.
23986     *
23987     * Content will be sized and positioned considering the space required
23988     * to display a virtual keyboard. So it won't fill all the conformant
23989     * size. This way is possible to be sure that content won't resize
23990     * or be re-positioned after the keyboard is displayed.
23991     *
23992     * Once the content object is set, a previously set one will be deleted.
23993     * If you want to keep that old content object, use the
23994     * elm_conformat_content_unset() function.
23995     *
23996     * @see elm_conformant_content_unset()
23997     * @see elm_conformant_content_get()
23998     *
23999     * @ingroup Conformant
24000     */
24001    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24002
24003    /**
24004     * Get the content of the conformant widget.
24005     *
24006     * @param obj The conformant object.
24007     * @return The content that is being used.
24008     *
24009     * Return the content object which is set for this widget.
24010     * It won't be unparent from conformant. For that, use
24011     * elm_conformant_content_unset().
24012     *
24013     * @see elm_conformant_content_set() for more details.
24014     * @see elm_conformant_content_unset()
24015     *
24016     * @ingroup Conformant
24017     */
24018    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24019
24020    /**
24021     * Unset the content of the conformant widget.
24022     *
24023     * @param obj The conformant object.
24024     * @return The content that was being used.
24025     *
24026     * Unparent and return the content object which was set for this widget.
24027     *
24028     * @see elm_conformant_content_set() for more details.
24029     *
24030     * @ingroup Conformant
24031     */
24032    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24033
24034    /**
24035     * Returns the Evas_Object that represents the content area.
24036     *
24037     * @param obj The conformant object.
24038     * @return The content area of the widget.
24039     *
24040     * @ingroup Conformant
24041     */
24042    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24043
24044    /**
24045     * @}
24046     */
24047
24048    /**
24049     * @defgroup Mapbuf Mapbuf
24050     * @ingroup Elementary
24051     *
24052     * @image html img/widget/mapbuf/preview-00.png
24053     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24054     *
24055     * This holds one content object and uses an Evas Map of transformation
24056     * points to be later used with this content. So the content will be
24057     * moved, resized, etc as a single image. So it will improve performance
24058     * when you have a complex interafce, with a lot of elements, and will
24059     * need to resize or move it frequently (the content object and its
24060     * children).
24061     *
24062     * See how to use this widget in this example:
24063     * @ref mapbuf_example
24064     */
24065
24066    /**
24067     * @addtogroup Mapbuf
24068     * @{
24069     */
24070
24071    /**
24072     * Add a new mapbuf widget to the given parent Elementary
24073     * (container) object.
24074     *
24075     * @param parent The parent object.
24076     * @return A new mapbuf widget handle or @c NULL, on errors.
24077     *
24078     * This function inserts a new mapbuf widget on the canvas.
24079     *
24080     * @ingroup Mapbuf
24081     */
24082    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24083
24084    /**
24085     * Set the content of the mapbuf.
24086     *
24087     * @param obj The mapbuf object.
24088     * @param content The content that will be filled in this mapbuf object.
24089     *
24090     * Once the content object is set, a previously set one will be deleted.
24091     * If you want to keep that old content object, use the
24092     * elm_mapbuf_content_unset() function.
24093     *
24094     * To enable map, elm_mapbuf_enabled_set() should be used.
24095     *
24096     * @ingroup Mapbuf
24097     */
24098    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24099
24100    /**
24101     * Get the content of the mapbuf.
24102     *
24103     * @param obj The mapbuf object.
24104     * @return The content that is being used.
24105     *
24106     * Return the content object which is set for this widget.
24107     *
24108     * @see elm_mapbuf_content_set() for details.
24109     *
24110     * @ingroup Mapbuf
24111     */
24112    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24113
24114    /**
24115     * Unset the content of the mapbuf.
24116     *
24117     * @param obj The mapbuf object.
24118     * @return The content that was being used.
24119     *
24120     * Unparent and return the content object which was set for this widget.
24121     *
24122     * @see elm_mapbuf_content_set() for details.
24123     *
24124     * @ingroup Mapbuf
24125     */
24126    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24127
24128    /**
24129     * Enable or disable the map.
24130     *
24131     * @param obj The mapbuf object.
24132     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24133     *
24134     * This enables the map that is set or disables it. On enable, the object
24135     * geometry will be saved, and the new geometry will change (position and
24136     * size) to reflect the map geometry set.
24137     *
24138     * Also, when enabled, alpha and smooth states will be used, so if the
24139     * content isn't solid, alpha should be enabled, for example, otherwise
24140     * a black retangle will fill the content.
24141     *
24142     * When disabled, the stored map will be freed and geometry prior to
24143     * enabling the map will be restored.
24144     *
24145     * It's disabled by default.
24146     *
24147     * @see elm_mapbuf_alpha_set()
24148     * @see elm_mapbuf_smooth_set()
24149     *
24150     * @ingroup Mapbuf
24151     */
24152    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24153
24154    /**
24155     * Get a value whether map is enabled or not.
24156     *
24157     * @param obj The mapbuf object.
24158     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24159     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24160     *
24161     * @see elm_mapbuf_enabled_set() for details.
24162     *
24163     * @ingroup Mapbuf
24164     */
24165    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24166
24167    /**
24168     * Enable or disable smooth map rendering.
24169     *
24170     * @param obj The mapbuf object.
24171     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24172     * to disable it.
24173     *
24174     * This sets smoothing for map rendering. If the object is a type that has
24175     * its own smoothing settings, then both the smooth settings for this object
24176     * and the map must be turned off.
24177     *
24178     * By default smooth maps are enabled.
24179     *
24180     * @ingroup Mapbuf
24181     */
24182    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24183
24184    /**
24185     * Get a value whether smooth map rendering is enabled or not.
24186     *
24187     * @param obj The mapbuf object.
24188     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24189     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24190     *
24191     * @see elm_mapbuf_smooth_set() for details.
24192     *
24193     * @ingroup Mapbuf
24194     */
24195    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24196
24197    /**
24198     * Set or unset alpha flag for map rendering.
24199     *
24200     * @param obj The mapbuf object.
24201     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24202     * to disable it.
24203     *
24204     * This sets alpha flag for map rendering. If the object is a type that has
24205     * its own alpha settings, then this will take precedence. Only image objects
24206     * have this currently. It stops alpha blending of the map area, and is
24207     * useful if you know the object and/or all sub-objects is 100% solid.
24208     *
24209     * Alpha is enabled by default.
24210     *
24211     * @ingroup Mapbuf
24212     */
24213    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24214
24215    /**
24216     * Get a value whether alpha blending is enabled or not.
24217     *
24218     * @param obj The mapbuf object.
24219     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24220     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24221     *
24222     * @see elm_mapbuf_alpha_set() for details.
24223     *
24224     * @ingroup Mapbuf
24225     */
24226    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24227
24228    /**
24229     * @}
24230     */
24231
24232    /**
24233     * @defgroup Flipselector Flip Selector
24234     *
24235     * @image html img/widget/flipselector/preview-00.png
24236     * @image latex img/widget/flipselector/preview-00.eps
24237     *
24238     * A flip selector is a widget to show a set of @b text items, one
24239     * at a time, with the same sheet switching style as the @ref Clock
24240     * "clock" widget, when one changes the current displaying sheet
24241     * (thus, the "flip" in the name).
24242     *
24243     * User clicks to flip sheets which are @b held for some time will
24244     * make the flip selector to flip continuosly and automatically for
24245     * the user. The interval between flips will keep growing in time,
24246     * so that it helps the user to reach an item which is distant from
24247     * the current selection.
24248     *
24249     * Smart callbacks one can register to:
24250     * - @c "selected" - when the widget's selected text item is changed
24251     * - @c "overflowed" - when the widget's current selection is changed
24252     *   from the first item in its list to the last
24253     * - @c "underflowed" - when the widget's current selection is changed
24254     *   from the last item in its list to the first
24255     *
24256     * Available styles for it:
24257     * - @c "default"
24258     *
24259     * Here is an example on its usage:
24260     * @li @ref flipselector_example
24261     */
24262
24263    /**
24264     * @addtogroup Flipselector
24265     * @{
24266     */
24267
24268    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24269
24270    /**
24271     * Add a new flip selector widget to the given parent Elementary
24272     * (container) widget
24273     *
24274     * @param parent The parent object
24275     * @return a new flip selector widget handle or @c NULL, on errors
24276     *
24277     * This function inserts a new flip selector widget on the canvas.
24278     *
24279     * @ingroup Flipselector
24280     */
24281    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24282
24283    /**
24284     * Programmatically select the next item of a flip selector widget
24285     *
24286     * @param obj The flipselector object
24287     *
24288     * @note The selection will be animated. Also, if it reaches the
24289     * end of its list of member items, it will continue with the first
24290     * one onwards.
24291     *
24292     * @ingroup Flipselector
24293     */
24294    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24295
24296    /**
24297     * Programmatically select the previous item of a flip selector
24298     * widget
24299     *
24300     * @param obj The flipselector object
24301     *
24302     * @note The selection will be animated.  Also, if it reaches the
24303     * beginning of its list of member items, it will continue with the
24304     * last one backwards.
24305     *
24306     * @ingroup Flipselector
24307     */
24308    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24309
24310    /**
24311     * Append a (text) item to a flip selector widget
24312     *
24313     * @param obj The flipselector object
24314     * @param label The (text) label of the new item
24315     * @param func Convenience callback function to take place when
24316     * item is selected
24317     * @param data Data passed to @p func, above
24318     * @return A handle to the item added or @c NULL, on errors
24319     *
24320     * The widget's list of labels to show will be appended with the
24321     * given value. If the user wishes so, a callback function pointer
24322     * can be passed, which will get called when this same item is
24323     * selected.
24324     *
24325     * @note The current selection @b won't be modified by appending an
24326     * element to the list.
24327     *
24328     * @note The maximum length of the text label is going to be
24329     * determined <b>by the widget's theme</b>. Strings larger than
24330     * that value are going to be @b truncated.
24331     *
24332     * @ingroup Flipselector
24333     */
24334    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24335
24336    /**
24337     * Prepend a (text) item to a flip selector widget
24338     *
24339     * @param obj The flipselector object
24340     * @param label The (text) label of the new item
24341     * @param func Convenience callback function to take place when
24342     * item is selected
24343     * @param data Data passed to @p func, above
24344     * @return A handle to the item added or @c NULL, on errors
24345     *
24346     * The widget's list of labels to show will be prepended with the
24347     * given value. If the user wishes so, a callback function pointer
24348     * can be passed, which will get called when this same item is
24349     * selected.
24350     *
24351     * @note The current selection @b won't be modified by prepending
24352     * an element to the list.
24353     *
24354     * @note The maximum length of the text label is going to be
24355     * determined <b>by the widget's theme</b>. Strings larger than
24356     * that value are going to be @b truncated.
24357     *
24358     * @ingroup Flipselector
24359     */
24360    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24361
24362    /**
24363     * Get the internal list of items in a given flip selector widget.
24364     *
24365     * @param obj The flipselector object
24366     * @return The list of items (#Elm_Flipselector_Item as data) or
24367     * @c NULL on errors.
24368     *
24369     * This list is @b not to be modified in any way and must not be
24370     * freed. Use the list members with functions like
24371     * elm_flipselector_item_label_set(),
24372     * elm_flipselector_item_label_get(),
24373     * elm_flipselector_item_del(),
24374     * elm_flipselector_item_selected_get(),
24375     * elm_flipselector_item_selected_set().
24376     *
24377     * @warning This list is only valid until @p obj object's internal
24378     * items list is changed. It should be fetched again with another
24379     * call to this function when changes happen.
24380     *
24381     * @ingroup Flipselector
24382     */
24383    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24384
24385    /**
24386     * Get the first item in the given flip selector widget's list of
24387     * items.
24388     *
24389     * @param obj The flipselector object
24390     * @return The first item or @c NULL, if it has no items (and on
24391     * errors)
24392     *
24393     * @see elm_flipselector_item_append()
24394     * @see elm_flipselector_last_item_get()
24395     *
24396     * @ingroup Flipselector
24397     */
24398    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24399
24400    /**
24401     * Get the last item in the given flip selector widget's list of
24402     * items.
24403     *
24404     * @param obj The flipselector object
24405     * @return The last item or @c NULL, if it has no items (and on
24406     * errors)
24407     *
24408     * @see elm_flipselector_item_prepend()
24409     * @see elm_flipselector_first_item_get()
24410     *
24411     * @ingroup Flipselector
24412     */
24413    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24414
24415    /**
24416     * Get the currently selected item in a flip selector widget.
24417     *
24418     * @param obj The flipselector object
24419     * @return The selected item or @c NULL, if the widget has no items
24420     * (and on erros)
24421     *
24422     * @ingroup Flipselector
24423     */
24424    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24425
24426    /**
24427     * Set whether a given flip selector widget's item should be the
24428     * currently selected one.
24429     *
24430     * @param item The flip selector item
24431     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24432     *
24433     * This sets whether @p item is or not the selected (thus, under
24434     * display) one. If @p item is different than one under display,
24435     * the latter will be unselected. If the @p item is set to be
24436     * unselected, on the other hand, the @b first item in the widget's
24437     * internal members list will be the new selected one.
24438     *
24439     * @see elm_flipselector_item_selected_get()
24440     *
24441     * @ingroup Flipselector
24442     */
24443    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24444
24445    /**
24446     * Get whether a given flip selector widget's item is the currently
24447     * selected one.
24448     *
24449     * @param item The flip selector item
24450     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24451     * (or on errors).
24452     *
24453     * @see elm_flipselector_item_selected_set()
24454     *
24455     * @ingroup Flipselector
24456     */
24457    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24458
24459    /**
24460     * Delete a given item from a flip selector widget.
24461     *
24462     * @param item The item to delete
24463     *
24464     * @ingroup Flipselector
24465     */
24466    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24467
24468    /**
24469     * Get the label of a given flip selector widget's item.
24470     *
24471     * @param item The item to get label from
24472     * @return The text label of @p item or @c NULL, on errors
24473     *
24474     * @see elm_flipselector_item_label_set()
24475     *
24476     * @ingroup Flipselector
24477     */
24478    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24479
24480    /**
24481     * Set the label of a given flip selector widget's item.
24482     *
24483     * @param item The item to set label on
24484     * @param label The text label string, in UTF-8 encoding
24485     *
24486     * @see elm_flipselector_item_label_get()
24487     *
24488     * @ingroup Flipselector
24489     */
24490    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24491
24492    /**
24493     * Gets the item before @p item in a flip selector widget's
24494     * internal list of items.
24495     *
24496     * @param item The item to fetch previous from
24497     * @return The item before the @p item, in its parent's list. If
24498     *         there is no previous item for @p item or there's an
24499     *         error, @c NULL is returned.
24500     *
24501     * @see elm_flipselector_item_next_get()
24502     *
24503     * @ingroup Flipselector
24504     */
24505    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24506
24507    /**
24508     * Gets the item after @p item in a flip selector widget's
24509     * internal list of items.
24510     *
24511     * @param item The item to fetch next from
24512     * @return The item after the @p item, in its parent's list. If
24513     *         there is no next item for @p item or there's an
24514     *         error, @c NULL is returned.
24515     *
24516     * @see elm_flipselector_item_next_get()
24517     *
24518     * @ingroup Flipselector
24519     */
24520    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24521
24522    /**
24523     * Set the interval on time updates for an user mouse button hold
24524     * on a flip selector widget.
24525     *
24526     * @param obj The flip selector object
24527     * @param interval The (first) interval value in seconds
24528     *
24529     * This interval value is @b decreased while the user holds the
24530     * mouse pointer either flipping up or flipping doww a given flip
24531     * selector.
24532     *
24533     * This helps the user to get to a given item distant from the
24534     * current one easier/faster, as it will start to flip quicker and
24535     * quicker on mouse button holds.
24536     *
24537     * The calculation for the next flip interval value, starting from
24538     * the one set with this call, is the previous interval divided by
24539     * 1.05, so it decreases a little bit.
24540     *
24541     * The default starting interval value for automatic flips is
24542     * @b 0.85 seconds.
24543     *
24544     * @see elm_flipselector_interval_get()
24545     *
24546     * @ingroup Flipselector
24547     */
24548    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24549
24550    /**
24551     * Get the interval on time updates for an user mouse button hold
24552     * on a flip selector widget.
24553     *
24554     * @param obj The flip selector object
24555     * @return The (first) interval value, in seconds, set on it
24556     *
24557     * @see elm_flipselector_interval_set() for more details
24558     *
24559     * @ingroup Flipselector
24560     */
24561    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24562    /**
24563     * @}
24564     */
24565
24566    /**
24567     * @addtogroup Calendar
24568     * @{
24569     */
24570
24571    /**
24572     * @enum _Elm_Calendar_Mark_Repeat
24573     * @typedef Elm_Calendar_Mark_Repeat
24574     *
24575     * Event periodicity, used to define if a mark should be repeated
24576     * @b beyond event's day. It's set when a mark is added.
24577     *
24578     * So, for a mark added to 13th May with periodicity set to WEEKLY,
24579     * there will be marks every week after this date. Marks will be displayed
24580     * at 13th, 20th, 27th, 3rd June ...
24581     *
24582     * Values don't work as bitmask, only one can be choosen.
24583     *
24584     * @see elm_calendar_mark_add()
24585     *
24586     * @ingroup Calendar
24587     */
24588    typedef enum _Elm_Calendar_Mark_Repeat
24589      {
24590         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24591         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24592         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24593         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*/
24594         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. */
24595      } Elm_Calendar_Mark_Repeat;
24596
24597    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(). */
24598
24599    /**
24600     * Add a new calendar widget to the given parent Elementary
24601     * (container) object.
24602     *
24603     * @param parent The parent object.
24604     * @return a new calendar widget handle or @c NULL, on errors.
24605     *
24606     * This function inserts a new calendar widget on the canvas.
24607     *
24608     * @ref calendar_example_01
24609     *
24610     * @ingroup Calendar
24611     */
24612    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24613
24614    /**
24615     * Get weekdays names displayed by the calendar.
24616     *
24617     * @param obj The calendar object.
24618     * @return Array of seven strings to be used as weekday names.
24619     *
24620     * By default, weekdays abbreviations get from system are displayed:
24621     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24622     * The first string is related to Sunday, the second to Monday...
24623     *
24624     * @see elm_calendar_weekdays_name_set()
24625     *
24626     * @ref calendar_example_05
24627     *
24628     * @ingroup Calendar
24629     */
24630    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24631
24632    /**
24633     * Set weekdays names to be displayed by the calendar.
24634     *
24635     * @param obj The calendar object.
24636     * @param weekdays Array of seven strings to be used as weekday names.
24637     * @warning It must have 7 elements, or it will access invalid memory.
24638     * @warning The strings must be NULL terminated ('@\0').
24639     *
24640     * By default, weekdays abbreviations get from system are displayed:
24641     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24642     *
24643     * The first string should be related to Sunday, the second to Monday...
24644     *
24645     * The usage should be like this:
24646     * @code
24647     *   const char *weekdays[] =
24648     *   {
24649     *      "Sunday", "Monday", "Tuesday", "Wednesday",
24650     *      "Thursday", "Friday", "Saturday"
24651     *   };
24652     *   elm_calendar_weekdays_names_set(calendar, weekdays);
24653     * @endcode
24654     *
24655     * @see elm_calendar_weekdays_name_get()
24656     *
24657     * @ref calendar_example_02
24658     *
24659     * @ingroup Calendar
24660     */
24661    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24662
24663    /**
24664     * Set the minimum and maximum values for the year
24665     *
24666     * @param obj The calendar object
24667     * @param min The minimum year, greater than 1901;
24668     * @param max The maximum year;
24669     *
24670     * Maximum must be greater than minimum, except if you don't wan't to set
24671     * maximum year.
24672     * Default values are 1902 and -1.
24673     *
24674     * If the maximum year is a negative value, it will be limited depending
24675     * on the platform architecture (year 2037 for 32 bits);
24676     *
24677     * @see elm_calendar_min_max_year_get()
24678     *
24679     * @ref calendar_example_03
24680     *
24681     * @ingroup Calendar
24682     */
24683    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24684
24685    /**
24686     * Get the minimum and maximum values for the year
24687     *
24688     * @param obj The calendar object.
24689     * @param min The minimum year.
24690     * @param max The maximum year.
24691     *
24692     * Default values are 1902 and -1.
24693     *
24694     * @see elm_calendar_min_max_year_get() for more details.
24695     *
24696     * @ref calendar_example_05
24697     *
24698     * @ingroup Calendar
24699     */
24700    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24701
24702    /**
24703     * Enable or disable day selection
24704     *
24705     * @param obj The calendar object.
24706     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24707     * disable it.
24708     *
24709     * Enabled by default. If disabled, the user still can select months,
24710     * but not days. Selected days are highlighted on calendar.
24711     * It should be used if you won't need such selection for the widget usage.
24712     *
24713     * When a day is selected, or month is changed, smart callbacks for
24714     * signal "changed" will be called.
24715     *
24716     * @see elm_calendar_day_selection_enable_get()
24717     *
24718     * @ref calendar_example_04
24719     *
24720     * @ingroup Calendar
24721     */
24722    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24723
24724    /**
24725     * Get a value whether day selection is enabled or not.
24726     *
24727     * @see elm_calendar_day_selection_enable_set() for details.
24728     *
24729     * @param obj The calendar object.
24730     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24731     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24732     *
24733     * @ref calendar_example_05
24734     *
24735     * @ingroup Calendar
24736     */
24737    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738
24739
24740    /**
24741     * Set selected date to be highlighted on calendar.
24742     *
24743     * @param obj The calendar object.
24744     * @param selected_time A @b tm struct to represent the selected date.
24745     *
24746     * Set the selected date, changing the displayed month if needed.
24747     * Selected date changes when the user goes to next/previous month or
24748     * select a day pressing over it on calendar.
24749     *
24750     * @see elm_calendar_selected_time_get()
24751     *
24752     * @ref calendar_example_04
24753     *
24754     * @ingroup Calendar
24755     */
24756    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
24757
24758    /**
24759     * Get selected date.
24760     *
24761     * @param obj The calendar object
24762     * @param selected_time A @b tm struct to point to selected date
24763     * @return EINA_FALSE means an error ocurred and returned time shouldn't
24764     * be considered.
24765     *
24766     * Get date selected by the user or set by function
24767     * elm_calendar_selected_time_set().
24768     * Selected date changes when the user goes to next/previous month or
24769     * select a day pressing over it on calendar.
24770     *
24771     * @see elm_calendar_selected_time_get()
24772     *
24773     * @ref calendar_example_05
24774     *
24775     * @ingroup Calendar
24776     */
24777    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
24778
24779    /**
24780     * Set a function to format the string that will be used to display
24781     * month and year;
24782     *
24783     * @param obj The calendar object
24784     * @param format_function Function to set the month-year string given
24785     * the selected date
24786     *
24787     * By default it uses strftime with "%B %Y" format string.
24788     * It should allocate the memory that will be used by the string,
24789     * that will be freed by the widget after usage.
24790     * A pointer to the string and a pointer to the time struct will be provided.
24791     *
24792     * Example:
24793     * @code
24794     * static char *
24795     * _format_month_year(struct tm *selected_time)
24796     * {
24797     *    char buf[32];
24798     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
24799     *    return strdup(buf);
24800     * }
24801     *
24802     * elm_calendar_format_function_set(calendar, _format_month_year);
24803     * @endcode
24804     *
24805     * @ref calendar_example_02
24806     *
24807     * @ingroup Calendar
24808     */
24809    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
24810
24811    /**
24812     * Add a new mark to the calendar
24813     *
24814     * @param obj The calendar object
24815     * @param mark_type A string used to define the type of mark. It will be
24816     * emitted to the theme, that should display a related modification on these
24817     * days representation.
24818     * @param mark_time A time struct to represent the date of inclusion of the
24819     * mark. For marks that repeats it will just be displayed after the inclusion
24820     * date in the calendar.
24821     * @param repeat Repeat the event following this periodicity. Can be a unique
24822     * mark (that don't repeat), daily, weekly, monthly or annually.
24823     * @return The created mark or @p NULL upon failure.
24824     *
24825     * Add a mark that will be drawn in the calendar respecting the insertion
24826     * time and periodicity. It will emit the type as signal to the widget theme.
24827     * Default theme supports "holiday" and "checked", but it can be extended.
24828     *
24829     * It won't immediately update the calendar, drawing the marks.
24830     * For this, call elm_calendar_marks_draw(). However, when user selects
24831     * next or previous month calendar forces marks drawn.
24832     *
24833     * Marks created with this method can be deleted with
24834     * elm_calendar_mark_del().
24835     *
24836     * Example
24837     * @code
24838     * struct tm selected_time;
24839     * time_t current_time;
24840     *
24841     * current_time = time(NULL) + 5 * 84600;
24842     * localtime_r(&current_time, &selected_time);
24843     * elm_calendar_mark_add(cal, "holiday", selected_time,
24844     *     ELM_CALENDAR_ANNUALLY);
24845     *
24846     * current_time = time(NULL) + 1 * 84600;
24847     * localtime_r(&current_time, &selected_time);
24848     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
24849     *
24850     * elm_calendar_marks_draw(cal);
24851     * @endcode
24852     *
24853     * @see elm_calendar_marks_draw()
24854     * @see elm_calendar_mark_del()
24855     *
24856     * @ref calendar_example_06
24857     *
24858     * @ingroup Calendar
24859     */
24860    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);
24861
24862    /**
24863     * Delete mark from the calendar.
24864     *
24865     * @param mark The mark to be deleted.
24866     *
24867     * If deleting all calendar marks is required, elm_calendar_marks_clear()
24868     * should be used instead of getting marks list and deleting each one.
24869     *
24870     * @see elm_calendar_mark_add()
24871     *
24872     * @ref calendar_example_06
24873     *
24874     * @ingroup Calendar
24875     */
24876    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
24877
24878    /**
24879     * Remove all calendar's marks
24880     *
24881     * @param obj The calendar object.
24882     *
24883     * @see elm_calendar_mark_add()
24884     * @see elm_calendar_mark_del()
24885     *
24886     * @ingroup Calendar
24887     */
24888    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24889
24890
24891    /**
24892     * Get a list of all the calendar marks.
24893     *
24894     * @param obj The calendar object.
24895     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24896     *
24897     * @see elm_calendar_mark_add()
24898     * @see elm_calendar_mark_del()
24899     * @see elm_calendar_marks_clear()
24900     *
24901     * @ingroup Calendar
24902     */
24903    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24904
24905    /**
24906     * Draw calendar marks.
24907     *
24908     * @param obj The calendar object.
24909     *
24910     * Should be used after adding, removing or clearing marks.
24911     * It will go through the entire marks list updating the calendar.
24912     * If lots of marks will be added, add all the marks and then call
24913     * this function.
24914     *
24915     * When the month is changed, i.e. user selects next or previous month,
24916     * marks will be drawed.
24917     *
24918     * @see elm_calendar_mark_add()
24919     * @see elm_calendar_mark_del()
24920     * @see elm_calendar_marks_clear()
24921     *
24922     * @ref calendar_example_06
24923     *
24924     * @ingroup Calendar
24925     */
24926    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24927
24928    /**
24929     * Set a day text color to the same that represents Saturdays.
24930     *
24931     * @param obj The calendar object.
24932     * @param pos The text position. Position is the cell counter, from left
24933     * to right, up to down. It starts on 0 and ends on 41.
24934     *
24935     * @deprecated use elm_calendar_mark_add() instead like:
24936     *
24937     * @code
24938     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24939     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24940     * @endcode
24941     *
24942     * @see elm_calendar_mark_add()
24943     *
24944     * @ingroup Calendar
24945     */
24946    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24947
24948    /**
24949     * Set a day text color to the same that represents Sundays.
24950     *
24951     * @param obj The calendar object.
24952     * @param pos The text position. Position is the cell counter, from left
24953     * to right, up to down. It starts on 0 and ends on 41.
24954
24955     * @deprecated use elm_calendar_mark_add() instead like:
24956     *
24957     * @code
24958     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24959     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24960     * @endcode
24961     *
24962     * @see elm_calendar_mark_add()
24963     *
24964     * @ingroup Calendar
24965     */
24966    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24967
24968    /**
24969     * Set a day text color to the same that represents Weekdays.
24970     *
24971     * @param obj The calendar object
24972     * @param pos The text position. Position is the cell counter, from left
24973     * to right, up to down. It starts on 0 and ends on 41.
24974     *
24975     * @deprecated use elm_calendar_mark_add() instead like:
24976     *
24977     * @code
24978     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24979     *
24980     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24981     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24982     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24983     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24984     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24985     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24986     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24987     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24988     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24989     * @endcode
24990     *
24991     * @see elm_calendar_mark_add()
24992     *
24993     * @ingroup Calendar
24994     */
24995    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24996
24997    /**
24998     * Set the interval on time updates for an user mouse button hold
24999     * on calendar widgets' month selection.
25000     *
25001     * @param obj The calendar object
25002     * @param interval The (first) interval value in seconds
25003     *
25004     * This interval value is @b decreased while the user holds the
25005     * mouse pointer either selecting next or previous month.
25006     *
25007     * This helps the user to get to a given month distant from the
25008     * current one easier/faster, as it will start to change quicker and
25009     * quicker on mouse button holds.
25010     *
25011     * The calculation for the next change interval value, starting from
25012     * the one set with this call, is the previous interval divided by
25013     * 1.05, so it decreases a little bit.
25014     *
25015     * The default starting interval value for automatic changes is
25016     * @b 0.85 seconds.
25017     *
25018     * @see elm_calendar_interval_get()
25019     *
25020     * @ingroup Calendar
25021     */
25022    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25023
25024    /**
25025     * Get the interval on time updates for an user mouse button hold
25026     * on calendar widgets' month selection.
25027     *
25028     * @param obj The calendar object
25029     * @return The (first) interval value, in seconds, set on it
25030     *
25031     * @see elm_calendar_interval_set() for more details
25032     *
25033     * @ingroup Calendar
25034     */
25035    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25036
25037    /**
25038     * @}
25039     */
25040
25041    /**
25042     * @defgroup Diskselector Diskselector
25043     * @ingroup Elementary
25044     *
25045     * @image html img/widget/diskselector/preview-00.png
25046     * @image latex img/widget/diskselector/preview-00.eps
25047     *
25048     * A diskselector is a kind of list widget. It scrolls horizontally,
25049     * and can contain label and icon objects. Three items are displayed
25050     * with the selected one in the middle.
25051     *
25052     * It can act like a circular list with round mode and labels can be
25053     * reduced for a defined length for side items.
25054     *
25055     * Smart callbacks one can listen to:
25056     * - "selected" - when item is selected, i.e. scroller stops.
25057     *
25058     * Available styles for it:
25059     * - @c "default"
25060     *
25061     * List of examples:
25062     * @li @ref diskselector_example_01
25063     * @li @ref diskselector_example_02
25064     */
25065
25066    /**
25067     * @addtogroup Diskselector
25068     * @{
25069     */
25070
25071    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(). */
25072
25073    /**
25074     * Add a new diskselector widget to the given parent Elementary
25075     * (container) object.
25076     *
25077     * @param parent The parent object.
25078     * @return a new diskselector widget handle or @c NULL, on errors.
25079     *
25080     * This function inserts a new diskselector widget on the canvas.
25081     *
25082     * @ingroup Diskselector
25083     */
25084    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25085
25086    /**
25087     * Enable or disable round mode.
25088     *
25089     * @param obj The diskselector object.
25090     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25091     * disable it.
25092     *
25093     * Disabled by default. If round mode is enabled the items list will
25094     * work like a circle list, so when the user reaches the last item,
25095     * the first one will popup.
25096     *
25097     * @see elm_diskselector_round_get()
25098     *
25099     * @ingroup Diskselector
25100     */
25101    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25102
25103    /**
25104     * Get a value whether round mode is enabled or not.
25105     *
25106     * @see elm_diskselector_round_set() for details.
25107     *
25108     * @param obj The diskselector object.
25109     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25110     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25111     *
25112     * @ingroup Diskselector
25113     */
25114    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25115
25116    /**
25117     * Get the side labels max length.
25118     *
25119     * @deprecated use elm_diskselector_side_label_length_get() instead:
25120     *
25121     * @param obj The diskselector object.
25122     * @return The max length defined for side labels, or 0 if not a valid
25123     * diskselector.
25124     *
25125     * @ingroup Diskselector
25126     */
25127    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25128
25129    /**
25130     * Set the side labels max length.
25131     *
25132     * @deprecated use elm_diskselector_side_label_length_set() instead:
25133     *
25134     * @param obj The diskselector object.
25135     * @param len The max length defined for side labels.
25136     *
25137     * @ingroup Diskselector
25138     */
25139    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25140
25141    /**
25142     * Get the side labels max length.
25143     *
25144     * @see elm_diskselector_side_label_length_set() for details.
25145     *
25146     * @param obj The diskselector object.
25147     * @return The max length defined for side labels, or 0 if not a valid
25148     * diskselector.
25149     *
25150     * @ingroup Diskselector
25151     */
25152    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25153
25154    /**
25155     * Set the side labels max length.
25156     *
25157     * @param obj The diskselector object.
25158     * @param len The max length defined for side labels.
25159     *
25160     * Length is the number of characters of items' label that will be
25161     * visible when it's set on side positions. It will just crop
25162     * the string after defined size. E.g.:
25163     *
25164     * An item with label "January" would be displayed on side position as
25165     * "Jan" if max length is set to 3, or "Janu", if this property
25166     * is set to 4.
25167     *
25168     * When it's selected, the entire label will be displayed, except for
25169     * width restrictions. In this case label will be cropped and "..."
25170     * will be concatenated.
25171     *
25172     * Default side label max length is 3.
25173     *
25174     * This property will be applyed over all items, included before or
25175     * later this function call.
25176     *
25177     * @ingroup Diskselector
25178     */
25179    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25180
25181    /**
25182     * Set the number of items to be displayed.
25183     *
25184     * @param obj The diskselector object.
25185     * @param num The number of items the diskselector will display.
25186     *
25187     * Default value is 3, and also it's the minimun. If @p num is less
25188     * than 3, it will be set to 3.
25189     *
25190     * Also, it can be set on theme, using data item @c display_item_num
25191     * on group "elm/diskselector/item/X", where X is style set.
25192     * E.g.:
25193     *
25194     * group { name: "elm/diskselector/item/X";
25195     * data {
25196     *     item: "display_item_num" "5";
25197     *     }
25198     *
25199     * @ingroup Diskselector
25200     */
25201    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25202
25203    /**
25204     * Get the number of items in the diskselector object.
25205     *
25206     * @param obj The diskselector object.
25207     *
25208     * @ingroup Diskselector
25209     */
25210    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25211
25212    /**
25213     * Set bouncing behaviour when the scrolled content reaches an edge.
25214     *
25215     * Tell the internal scroller object whether it should bounce or not
25216     * when it reaches the respective edges for each axis.
25217     *
25218     * @param obj The diskselector object.
25219     * @param h_bounce Whether to bounce or not in the horizontal axis.
25220     * @param v_bounce Whether to bounce or not in the vertical axis.
25221     *
25222     * @see elm_scroller_bounce_set()
25223     *
25224     * @ingroup Diskselector
25225     */
25226    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25227
25228    /**
25229     * Get the bouncing behaviour of the internal scroller.
25230     *
25231     * Get whether the internal scroller should bounce when the edge of each
25232     * axis is reached scrolling.
25233     *
25234     * @param obj The diskselector object.
25235     * @param h_bounce Pointer where to store the bounce state of the horizontal
25236     * axis.
25237     * @param v_bounce Pointer where to store the bounce state of the vertical
25238     * axis.
25239     *
25240     * @see elm_scroller_bounce_get()
25241     * @see elm_diskselector_bounce_set()
25242     *
25243     * @ingroup Diskselector
25244     */
25245    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25246
25247    /**
25248     * Get the scrollbar policy.
25249     *
25250     * @see elm_diskselector_scroller_policy_get() for details.
25251     *
25252     * @param obj The diskselector object.
25253     * @param policy_h Pointer where to store horizontal scrollbar policy.
25254     * @param policy_v Pointer where to store vertical scrollbar policy.
25255     *
25256     * @ingroup Diskselector
25257     */
25258    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);
25259
25260    /**
25261     * Set the scrollbar policy.
25262     *
25263     * @param obj The diskselector object.
25264     * @param policy_h Horizontal scrollbar policy.
25265     * @param policy_v Vertical scrollbar policy.
25266     *
25267     * This sets the scrollbar visibility policy for the given scroller.
25268     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25269     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25270     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25271     * This applies respectively for the horizontal and vertical scrollbars.
25272     *
25273     * The both are disabled by default, i.e., are set to
25274     * #ELM_SCROLLER_POLICY_OFF.
25275     *
25276     * @ingroup Diskselector
25277     */
25278    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25279
25280    /**
25281     * Remove all diskselector's items.
25282     *
25283     * @param obj The diskselector object.
25284     *
25285     * @see elm_diskselector_item_del()
25286     * @see elm_diskselector_item_append()
25287     *
25288     * @ingroup Diskselector
25289     */
25290    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25291
25292    /**
25293     * Get a list of all the diskselector items.
25294     *
25295     * @param obj The diskselector object.
25296     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25297     * or @c NULL on failure.
25298     *
25299     * @see elm_diskselector_item_append()
25300     * @see elm_diskselector_item_del()
25301     * @see elm_diskselector_clear()
25302     *
25303     * @ingroup Diskselector
25304     */
25305    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25306
25307    /**
25308     * Appends a new item to the diskselector object.
25309     *
25310     * @param obj The diskselector object.
25311     * @param label The label of the diskselector item.
25312     * @param icon The icon object to use at left side of the item. An
25313     * icon can be any Evas object, but usually it is an icon created
25314     * with elm_icon_add().
25315     * @param func The function to call when the item is selected.
25316     * @param data The data to associate with the item for related callbacks.
25317     *
25318     * @return The created item or @c NULL upon failure.
25319     *
25320     * A new item will be created and appended to the diskselector, i.e., will
25321     * be set as last item. Also, if there is no selected item, it will
25322     * be selected. This will always happens for the first appended item.
25323     *
25324     * If no icon is set, label will be centered on item position, otherwise
25325     * the icon will be placed at left of the label, that will be shifted
25326     * to the right.
25327     *
25328     * Items created with this method can be deleted with
25329     * elm_diskselector_item_del().
25330     *
25331     * Associated @p data can be properly freed when item is deleted if a
25332     * callback function is set with elm_diskselector_item_del_cb_set().
25333     *
25334     * If a function is passed as argument, it will be called everytime this item
25335     * is selected, i.e., the user stops the diskselector with this
25336     * item on center position. If such function isn't needed, just passing
25337     * @c NULL as @p func is enough. The same should be done for @p data.
25338     *
25339     * Simple example (with no function callback or data associated):
25340     * @code
25341     * disk = elm_diskselector_add(win);
25342     * ic = elm_icon_add(win);
25343     * elm_icon_file_set(ic, "path/to/image", NULL);
25344     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25345     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25346     * @endcode
25347     *
25348     * @see elm_diskselector_item_del()
25349     * @see elm_diskselector_item_del_cb_set()
25350     * @see elm_diskselector_clear()
25351     * @see elm_icon_add()
25352     *
25353     * @ingroup Diskselector
25354     */
25355    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);
25356
25357
25358    /**
25359     * Delete them item from the diskselector.
25360     *
25361     * @param it The item of diskselector to be deleted.
25362     *
25363     * If deleting all diskselector items is required, elm_diskselector_clear()
25364     * should be used instead of getting items list and deleting each one.
25365     *
25366     * @see elm_diskselector_clear()
25367     * @see elm_diskselector_item_append()
25368     * @see elm_diskselector_item_del_cb_set()
25369     *
25370     * @ingroup Diskselector
25371     */
25372    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25373
25374    /**
25375     * Set the function called when a diskselector item is freed.
25376     *
25377     * @param it The item to set the callback on
25378     * @param func The function called
25379     *
25380     * If there is a @p func, then it will be called prior item's memory release.
25381     * That will be called with the following arguments:
25382     * @li item's data;
25383     * @li item's Evas object;
25384     * @li item itself;
25385     *
25386     * This way, a data associated to a diskselector item could be properly
25387     * freed.
25388     *
25389     * @ingroup Diskselector
25390     */
25391    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25392
25393    /**
25394     * Get the data associated to the item.
25395     *
25396     * @param it The diskselector item
25397     * @return The data associated to @p it
25398     *
25399     * The return value is a pointer to data associated to @p item when it was
25400     * created, with function elm_diskselector_item_append(). If no data
25401     * was passed as argument, it will return @c NULL.
25402     *
25403     * @see elm_diskselector_item_append()
25404     *
25405     * @ingroup Diskselector
25406     */
25407    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25408
25409    /**
25410     * Set the icon associated to the item.
25411     *
25412     * @param it The diskselector item
25413     * @param icon The icon object to associate with @p it
25414     *
25415     * The icon object to use at left side of the item. An
25416     * icon can be any Evas object, but usually it is an icon created
25417     * with elm_icon_add().
25418     *
25419     * Once the icon object is set, a previously set one will be deleted.
25420     * @warning Setting the same icon for two items will cause the icon to
25421     * dissapear from the first item.
25422     *
25423     * If an icon was passed as argument on item creation, with function
25424     * elm_diskselector_item_append(), it will be already
25425     * associated to the item.
25426     *
25427     * @see elm_diskselector_item_append()
25428     * @see elm_diskselector_item_icon_get()
25429     *
25430     * @ingroup Diskselector
25431     */
25432    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25433
25434    /**
25435     * Get the icon associated to the item.
25436     *
25437     * @param it The diskselector item
25438     * @return The icon associated to @p it
25439     *
25440     * The return value is a pointer to the icon associated to @p item when it was
25441     * created, with function elm_diskselector_item_append(), or later
25442     * with function elm_diskselector_item_icon_set. If no icon
25443     * was passed as argument, it will return @c NULL.
25444     *
25445     * @see elm_diskselector_item_append()
25446     * @see elm_diskselector_item_icon_set()
25447     *
25448     * @ingroup Diskselector
25449     */
25450    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25451
25452    /**
25453     * Set the label of item.
25454     *
25455     * @param it The item of diskselector.
25456     * @param label The label of item.
25457     *
25458     * The label to be displayed by the item.
25459     *
25460     * If no icon is set, label will be centered on item position, otherwise
25461     * the icon will be placed at left of the label, that will be shifted
25462     * to the right.
25463     *
25464     * An item with label "January" would be displayed on side position as
25465     * "Jan" if max length is set to 3 with function
25466     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25467     * is set to 4.
25468     *
25469     * When this @p item is selected, the entire label will be displayed,
25470     * except for width restrictions.
25471     * In this case label will be cropped and "..." will be concatenated,
25472     * but only for display purposes. It will keep the entire string, so
25473     * if diskselector is resized the remaining characters will be displayed.
25474     *
25475     * If a label was passed as argument on item creation, with function
25476     * elm_diskselector_item_append(), it will be already
25477     * displayed by the item.
25478     *
25479     * @see elm_diskselector_side_label_lenght_set()
25480     * @see elm_diskselector_item_label_get()
25481     * @see elm_diskselector_item_append()
25482     *
25483     * @ingroup Diskselector
25484     */
25485    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25486
25487    /**
25488     * Get the label of item.
25489     *
25490     * @param it The item of diskselector.
25491     * @return The label of item.
25492     *
25493     * The return value is a pointer to the label associated to @p item when it was
25494     * created, with function elm_diskselector_item_append(), or later
25495     * with function elm_diskselector_item_label_set. If no label
25496     * was passed as argument, it will return @c NULL.
25497     *
25498     * @see elm_diskselector_item_label_set() for more details.
25499     * @see elm_diskselector_item_append()
25500     *
25501     * @ingroup Diskselector
25502     */
25503    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25504
25505    /**
25506     * Get the selected item.
25507     *
25508     * @param obj The diskselector object.
25509     * @return The selected diskselector item.
25510     *
25511     * The selected item can be unselected with function
25512     * elm_diskselector_item_selected_set(), and the first item of
25513     * diskselector will be selected.
25514     *
25515     * The selected item always will be centered on diskselector, with
25516     * full label displayed, i.e., max lenght set to side labels won't
25517     * apply on the selected item. More details on
25518     * elm_diskselector_side_label_length_set().
25519     *
25520     * @ingroup Diskselector
25521     */
25522    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25523
25524    /**
25525     * Set the selected state of an item.
25526     *
25527     * @param it The diskselector item
25528     * @param selected The selected state
25529     *
25530     * This sets the selected state of the given item @p it.
25531     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25532     *
25533     * If a new item is selected the previosly selected will be unselected.
25534     * Previoulsy selected item can be get with function
25535     * elm_diskselector_selected_item_get().
25536     *
25537     * If the item @p it is unselected, the first item of diskselector will
25538     * be selected.
25539     *
25540     * Selected items will be visible on center position of diskselector.
25541     * So if it was on another position before selected, or was invisible,
25542     * diskselector will animate items until the selected item reaches center
25543     * position.
25544     *
25545     * @see elm_diskselector_item_selected_get()
25546     * @see elm_diskselector_selected_item_get()
25547     *
25548     * @ingroup Diskselector
25549     */
25550    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25551
25552    /*
25553     * Get whether the @p item is selected or not.
25554     *
25555     * @param it The diskselector item.
25556     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25557     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25558     *
25559     * @see elm_diskselector_selected_item_set() for details.
25560     * @see elm_diskselector_item_selected_get()
25561     *
25562     * @ingroup Diskselector
25563     */
25564    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25565
25566    /**
25567     * Get the first item of the diskselector.
25568     *
25569     * @param obj The diskselector object.
25570     * @return The first item, or @c NULL if none.
25571     *
25572     * The list of items follows append order. So it will return the first
25573     * item appended to the widget that wasn't deleted.
25574     *
25575     * @see elm_diskselector_item_append()
25576     * @see elm_diskselector_items_get()
25577     *
25578     * @ingroup Diskselector
25579     */
25580    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25581
25582    /**
25583     * Get the last item of the diskselector.
25584     *
25585     * @param obj The diskselector object.
25586     * @return The last item, or @c NULL if none.
25587     *
25588     * The list of items follows append order. So it will return last first
25589     * item appended to the widget that wasn't deleted.
25590     *
25591     * @see elm_diskselector_item_append()
25592     * @see elm_diskselector_items_get()
25593     *
25594     * @ingroup Diskselector
25595     */
25596    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25597
25598    /**
25599     * Get the item before @p item in diskselector.
25600     *
25601     * @param it The diskselector item.
25602     * @return The item before @p item, or @c NULL if none or on failure.
25603     *
25604     * The list of items follows append order. So it will return item appended
25605     * just before @p item and that wasn't deleted.
25606     *
25607     * If it is the first item, @c NULL will be returned.
25608     * First item can be get by elm_diskselector_first_item_get().
25609     *
25610     * @see elm_diskselector_item_append()
25611     * @see elm_diskselector_items_get()
25612     *
25613     * @ingroup Diskselector
25614     */
25615    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25616
25617    /**
25618     * Get the item after @p item in diskselector.
25619     *
25620     * @param it The diskselector item.
25621     * @return The item after @p item, or @c NULL if none or on failure.
25622     *
25623     * The list of items follows append order. So it will return item appended
25624     * just after @p item and that wasn't deleted.
25625     *
25626     * If it is the last item, @c NULL will be returned.
25627     * Last item can be get by elm_diskselector_last_item_get().
25628     *
25629     * @see elm_diskselector_item_append()
25630     * @see elm_diskselector_items_get()
25631     *
25632     * @ingroup Diskselector
25633     */
25634    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25635
25636    /**
25637     * Set the text to be shown in the diskselector item.
25638     *
25639     * @param item Target item
25640     * @param text The text to set in the content
25641     *
25642     * Setup the text as tooltip to object. The item can have only one tooltip,
25643     * so any previous tooltip data is removed.
25644     *
25645     * @see elm_object_tooltip_text_set() for more details.
25646     *
25647     * @ingroup Diskselector
25648     */
25649    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25650
25651    /**
25652     * Set the content to be shown in the tooltip item.
25653     *
25654     * Setup the tooltip to item. The item can have only one tooltip,
25655     * so any previous tooltip data is removed. @p func(with @p data) will
25656     * be called every time that need show the tooltip and it should
25657     * return a valid Evas_Object. This object is then managed fully by
25658     * tooltip system and is deleted when the tooltip is gone.
25659     *
25660     * @param item the diskselector item being attached a tooltip.
25661     * @param func the function used to create the tooltip contents.
25662     * @param data what to provide to @a func as callback data/context.
25663     * @param del_cb called when data is not needed anymore, either when
25664     *        another callback replaces @p func, the tooltip is unset with
25665     *        elm_diskselector_item_tooltip_unset() or the owner @a item
25666     *        dies. This callback receives as the first parameter the
25667     *        given @a data, and @c event_info is the item.
25668     *
25669     * @see elm_object_tooltip_content_cb_set() for more details.
25670     *
25671     * @ingroup Diskselector
25672     */
25673    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);
25674
25675    /**
25676     * Unset tooltip from item.
25677     *
25678     * @param item diskselector item to remove previously set tooltip.
25679     *
25680     * Remove tooltip from item. The callback provided as del_cb to
25681     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25682     * it is not used anymore.
25683     *
25684     * @see elm_object_tooltip_unset() for more details.
25685     * @see elm_diskselector_item_tooltip_content_cb_set()
25686     *
25687     * @ingroup Diskselector
25688     */
25689    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25690
25691
25692    /**
25693     * Sets a different style for this item tooltip.
25694     *
25695     * @note before you set a style you should define a tooltip with
25696     *       elm_diskselector_item_tooltip_content_cb_set() or
25697     *       elm_diskselector_item_tooltip_text_set()
25698     *
25699     * @param item diskselector item with tooltip already set.
25700     * @param style the theme style to use (default, transparent, ...)
25701     *
25702     * @see elm_object_tooltip_style_set() for more details.
25703     *
25704     * @ingroup Diskselector
25705     */
25706    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25707
25708    /**
25709     * Get the style for this item tooltip.
25710     *
25711     * @param item diskselector item with tooltip already set.
25712     * @return style the theme style in use, defaults to "default". If the
25713     *         object does not have a tooltip set, then NULL is returned.
25714     *
25715     * @see elm_object_tooltip_style_get() for more details.
25716     * @see elm_diskselector_item_tooltip_style_set()
25717     *
25718     * @ingroup Diskselector
25719     */
25720    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25721
25722    /**
25723     * Set the cursor to be shown when mouse is over the diskselector item
25724     *
25725     * @param item Target item
25726     * @param cursor the cursor name to be used.
25727     *
25728     * @see elm_object_cursor_set() for more details.
25729     *
25730     * @ingroup Diskselector
25731     */
25732    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
25733
25734    /**
25735     * Get the cursor to be shown when mouse is over the diskselector item
25736     *
25737     * @param item diskselector item with cursor already set.
25738     * @return the cursor name.
25739     *
25740     * @see elm_object_cursor_get() for more details.
25741     * @see elm_diskselector_cursor_set()
25742     *
25743     * @ingroup Diskselector
25744     */
25745    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25746
25747
25748    /**
25749     * Unset the cursor to be shown when mouse is over the diskselector item
25750     *
25751     * @param item Target item
25752     *
25753     * @see elm_object_cursor_unset() for more details.
25754     * @see elm_diskselector_cursor_set()
25755     *
25756     * @ingroup Diskselector
25757     */
25758    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25759
25760    /**
25761     * Sets a different style for this item cursor.
25762     *
25763     * @note before you set a style you should define a cursor with
25764     *       elm_diskselector_item_cursor_set()
25765     *
25766     * @param item diskselector item with cursor already set.
25767     * @param style the theme style to use (default, transparent, ...)
25768     *
25769     * @see elm_object_cursor_style_set() for more details.
25770     *
25771     * @ingroup Diskselector
25772     */
25773    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25774
25775
25776    /**
25777     * Get the style for this item cursor.
25778     *
25779     * @param item diskselector item with cursor already set.
25780     * @return style the theme style in use, defaults to "default". If the
25781     *         object does not have a cursor set, then @c NULL is returned.
25782     *
25783     * @see elm_object_cursor_style_get() for more details.
25784     * @see elm_diskselector_item_cursor_style_set()
25785     *
25786     * @ingroup Diskselector
25787     */
25788    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25789
25790
25791    /**
25792     * Set if the cursor set should be searched on the theme or should use
25793     * the provided by the engine, only.
25794     *
25795     * @note before you set if should look on theme you should define a cursor
25796     * with elm_diskselector_item_cursor_set().
25797     * By default it will only look for cursors provided by the engine.
25798     *
25799     * @param item widget item with cursor already set.
25800     * @param engine_only boolean to define if cursors set with
25801     * elm_diskselector_item_cursor_set() should be searched only
25802     * between cursors provided by the engine or searched on widget's
25803     * theme as well.
25804     *
25805     * @see elm_object_cursor_engine_only_set() for more details.
25806     *
25807     * @ingroup Diskselector
25808     */
25809    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
25810
25811    /**
25812     * Get the cursor engine only usage for this item cursor.
25813     *
25814     * @param item widget item with cursor already set.
25815     * @return engine_only boolean to define it cursors should be looked only
25816     * between the provided by the engine or searched on widget's theme as well.
25817     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
25818     *
25819     * @see elm_object_cursor_engine_only_get() for more details.
25820     * @see elm_diskselector_item_cursor_engine_only_set()
25821     *
25822     * @ingroup Diskselector
25823     */
25824    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25825
25826    /**
25827     * @}
25828     */
25829
25830    /**
25831     * @defgroup Colorselector Colorselector
25832     *
25833     * @{
25834     *
25835     * @image html img/widget/colorselector/preview-00.png
25836     * @image latex img/widget/colorselector/preview-00.eps
25837     *
25838     * @brief Widget for user to select a color.
25839     *
25840     * Signals that you can add callbacks for are:
25841     * "changed" - When the color value changes(event_info is NULL).
25842     *
25843     * See @ref tutorial_colorselector.
25844     */
25845    /**
25846     * @brief Add a new colorselector to the parent
25847     *
25848     * @param parent The parent object
25849     * @return The new object or NULL if it cannot be created
25850     *
25851     * @ingroup Colorselector
25852     */
25853    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25854    /**
25855     * Set a color for the colorselector
25856     *
25857     * @param obj   Colorselector object
25858     * @param r     r-value of color
25859     * @param g     g-value of color
25860     * @param b     b-value of color
25861     * @param a     a-value of color
25862     *
25863     * @ingroup Colorselector
25864     */
25865    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
25866    /**
25867     * Get a color from the colorselector
25868     *
25869     * @param obj   Colorselector object
25870     * @param r     integer pointer for r-value of color
25871     * @param g     integer pointer for g-value of color
25872     * @param b     integer pointer for b-value of color
25873     * @param a     integer pointer for a-value of color
25874     *
25875     * @ingroup Colorselector
25876     */
25877    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
25878    /**
25879     * @}
25880     */
25881
25882    /**
25883     * @defgroup Ctxpopup Ctxpopup
25884     *
25885     * @image html img/widget/ctxpopup/preview-00.png
25886     * @image latex img/widget/ctxpopup/preview-00.eps
25887     *
25888     * @brief Context popup widet.
25889     *
25890     * A ctxpopup is a widget that, when shown, pops up a list of items.
25891     * It automatically chooses an area inside its parent object's view
25892     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
25893     * optimally fit into it. In the default theme, it will also point an
25894     * arrow to it's top left position at the time one shows it. Ctxpopup
25895     * items have a label and/or an icon. It is intended for a small
25896     * number of items (hence the use of list, not genlist).
25897     *
25898     * @note Ctxpopup is a especialization of @ref Hover.
25899     *
25900     * Signals that you can add callbacks for are:
25901     * "dismissed" - the ctxpopup was dismissed
25902     *
25903     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
25904     * @{
25905     */
25906    typedef enum _Elm_Ctxpopup_Direction
25907      {
25908         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25909                                           area */
25910         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25911                                            the clicked area */
25912         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25913                                           the clicked area */
25914         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25915                                         area */
25916         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25917      } Elm_Ctxpopup_Direction;
25918
25919    /**
25920     * @brief Add a new Ctxpopup object to the parent.
25921     *
25922     * @param parent Parent object
25923     * @return New object or @c NULL, if it cannot be created
25924     */
25925    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25926    /**
25927     * @brief Set the Ctxpopup's parent
25928     *
25929     * @param obj The ctxpopup object
25930     * @param area The parent to use
25931     *
25932     * Set the parent object.
25933     *
25934     * @note elm_ctxpopup_add() will automatically call this function
25935     * with its @c parent argument.
25936     *
25937     * @see elm_ctxpopup_add()
25938     * @see elm_hover_parent_set()
25939     */
25940    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25941    /**
25942     * @brief Get the Ctxpopup's parent
25943     *
25944     * @param obj The ctxpopup object
25945     *
25946     * @see elm_ctxpopup_hover_parent_set() for more information
25947     */
25948    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25949    /**
25950     * @brief Clear all items in the given ctxpopup object.
25951     *
25952     * @param obj Ctxpopup object
25953     */
25954    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25955    /**
25956     * @brief Change the ctxpopup's orientation to horizontal or vertical.
25957     *
25958     * @param obj Ctxpopup object
25959     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25960     */
25961    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25962    /**
25963     * @brief Get the value of current ctxpopup object's orientation.
25964     *
25965     * @param obj Ctxpopup object
25966     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25967     *
25968     * @see elm_ctxpopup_horizontal_set()
25969     */
25970    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25971    /**
25972     * @brief Add a new item to a ctxpopup object.
25973     *
25974     * @param obj Ctxpopup object
25975     * @param icon Icon to be set on new item
25976     * @param label The Label of the new item
25977     * @param func Convenience function called when item selected
25978     * @param data Data passed to @p func
25979     * @return A handle to the item added or @c NULL, on errors
25980     *
25981     * @warning Ctxpopup can't hold both an item list and a content at the same
25982     * time. When an item is added, any previous content will be removed.
25983     *
25984     * @see elm_ctxpopup_content_set()
25985     */
25986    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);
25987    /**
25988     * @brief Delete the given item in a ctxpopup object.
25989     *
25990     * @param it Ctxpopup item to be deleted
25991     *
25992     * @see elm_ctxpopup_item_append()
25993     */
25994    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25995    /**
25996     * @brief Set the ctxpopup item's state as disabled or enabled.
25997     *
25998     * @param it Ctxpopup item to be enabled/disabled
25999     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26000     *
26001     * When disabled the item is greyed out to indicate it's state.
26002     */
26003    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26004    /**
26005     * @brief Get the ctxpopup item's disabled/enabled state.
26006     *
26007     * @param it Ctxpopup item to be enabled/disabled
26008     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26009     *
26010     * @see elm_ctxpopup_item_disabled_set()
26011     */
26012    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26013    /**
26014     * @brief Get the icon object for the given ctxpopup item.
26015     *
26016     * @param it Ctxpopup item
26017     * @return icon object or @c NULL, if the item does not have icon or an error
26018     * occurred
26019     *
26020     * @see elm_ctxpopup_item_append()
26021     * @see elm_ctxpopup_item_icon_set()
26022     */
26023    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26024    /**
26025     * @brief Sets the side icon associated with the ctxpopup item
26026     *
26027     * @param it Ctxpopup item
26028     * @param icon Icon object to be set
26029     *
26030     * Once the icon object is set, a previously set one will be deleted.
26031     * @warning Setting the same icon for two items will cause the icon to
26032     * dissapear from the first item.
26033     *
26034     * @see elm_ctxpopup_item_append()
26035     */
26036    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26037    /**
26038     * @brief Get the label for the given ctxpopup item.
26039     *
26040     * @param it Ctxpopup item
26041     * @return label string or @c NULL, if the item does not have label or an
26042     * error occured
26043     *
26044     * @see elm_ctxpopup_item_append()
26045     * @see elm_ctxpopup_item_label_set()
26046     */
26047    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26048    /**
26049     * @brief (Re)set the label on the given ctxpopup item.
26050     *
26051     * @param it Ctxpopup item
26052     * @param label String to set as label
26053     */
26054    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26055    /**
26056     * @brief Set an elm widget as the content of the ctxpopup.
26057     *
26058     * @param obj Ctxpopup object
26059     * @param content Content to be swallowed
26060     *
26061     * If the content object is already set, a previous one will bedeleted. If
26062     * you want to keep that old content object, use the
26063     * elm_ctxpopup_content_unset() function.
26064     *
26065     * @deprecated use elm_object_content_set()
26066     *
26067     * @warning Ctxpopup can't hold both a item list and a content at the same
26068     * time. When a content is set, any previous items will be removed.
26069     */
26070    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26071    /**
26072     * @brief Unset the ctxpopup content
26073     *
26074     * @param obj Ctxpopup object
26075     * @return The content that was being used
26076     *
26077     * Unparent and return the content object which was set for this widget.
26078     *
26079     * @deprecated use elm_object_content_unset()
26080     *
26081     * @see elm_ctxpopup_content_set()
26082     */
26083    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26084    /**
26085     * @brief Set the direction priority of a ctxpopup.
26086     *
26087     * @param obj Ctxpopup object
26088     * @param first 1st priority of direction
26089     * @param second 2nd priority of direction
26090     * @param third 3th priority of direction
26091     * @param fourth 4th priority of direction
26092     *
26093     * This functions gives a chance to user to set the priority of ctxpopup
26094     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26095     * requested direction.
26096     *
26097     * @see Elm_Ctxpopup_Direction
26098     */
26099    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);
26100    /**
26101     * @brief Get the direction priority of a ctxpopup.
26102     *
26103     * @param obj Ctxpopup object
26104     * @param first 1st priority of direction to be returned
26105     * @param second 2nd priority of direction to be returned
26106     * @param third 3th priority of direction to be returned
26107     * @param fourth 4th priority of direction to be returned
26108     *
26109     * @see elm_ctxpopup_direction_priority_set() for more information.
26110     */
26111    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);
26112
26113    /**
26114     * @brief Get the current direction of a ctxpopup.
26115     *
26116     * @param obj Ctxpopup object
26117     * @return current direction of a ctxpopup
26118     *
26119     * @warning Once the ctxpopup showed up, the direction would be determined
26120     */
26121    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26122
26123    /**
26124     * @}
26125     */
26126
26127    /* transit */
26128    /**
26129     *
26130     * @defgroup Transit Transit
26131     * @ingroup Elementary
26132     *
26133     * Transit is designed to apply various animated transition effects to @c
26134     * Evas_Object, such like translation, rotation, etc. For using these
26135     * effects, create an @ref Elm_Transit and add the desired transition effects.
26136     *
26137     * Once the effects are added into transit, they will be automatically
26138     * managed (their callback will be called until the duration is ended, and
26139     * they will be deleted on completion).
26140     *
26141     * Example:
26142     * @code
26143     * Elm_Transit *trans = elm_transit_add();
26144     * elm_transit_object_add(trans, obj);
26145     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26146     * elm_transit_duration_set(transit, 1);
26147     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26148     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26149     * elm_transit_repeat_times_set(transit, 3);
26150     * @endcode
26151     *
26152     * Some transition effects are used to change the properties of objects. They
26153     * are:
26154     * @li @ref elm_transit_effect_translation_add
26155     * @li @ref elm_transit_effect_color_add
26156     * @li @ref elm_transit_effect_rotation_add
26157     * @li @ref elm_transit_effect_wipe_add
26158     * @li @ref elm_transit_effect_zoom_add
26159     * @li @ref elm_transit_effect_resizing_add
26160     *
26161     * Other transition effects are used to make one object disappear and another
26162     * object appear on its old place. These effects are:
26163     *
26164     * @li @ref elm_transit_effect_flip_add
26165     * @li @ref elm_transit_effect_resizable_flip_add
26166     * @li @ref elm_transit_effect_fade_add
26167     * @li @ref elm_transit_effect_blend_add
26168     *
26169     * It's also possible to make a transition chain with @ref
26170     * elm_transit_chain_transit_add.
26171     *
26172     * @warning We strongly recommend to use elm_transit just when edje can not do
26173     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26174     * animations can be manipulated inside the theme.
26175     *
26176     * List of examples:
26177     * @li @ref transit_example_01_explained
26178     * @li @ref transit_example_02_explained
26179     * @li @ref transit_example_03_c
26180     * @li @ref transit_example_04_c
26181     *
26182     * @{
26183     */
26184
26185    /**
26186     * @enum Elm_Transit_Tween_Mode
26187     *
26188     * The type of acceleration used in the transition.
26189     */
26190    typedef enum
26191      {
26192         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26193         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26194                                              over time, then decrease again
26195                                              and stop slowly */
26196         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26197                                              speed over time */
26198         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26199                                             over time */
26200      } Elm_Transit_Tween_Mode;
26201
26202    /**
26203     * @enum Elm_Transit_Effect_Flip_Axis
26204     *
26205     * The axis where flip effect should be applied.
26206     */
26207    typedef enum
26208      {
26209         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26210         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26211      } Elm_Transit_Effect_Flip_Axis;
26212    /**
26213     * @enum Elm_Transit_Effect_Wipe_Dir
26214     *
26215     * The direction where the wipe effect should occur.
26216     */
26217    typedef enum
26218      {
26219         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26220         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26221         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26222         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26223      } Elm_Transit_Effect_Wipe_Dir;
26224    /** @enum Elm_Transit_Effect_Wipe_Type
26225     *
26226     * Whether the wipe effect should show or hide the object.
26227     */
26228    typedef enum
26229      {
26230         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26231                                              animation */
26232         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26233                                             animation */
26234      } Elm_Transit_Effect_Wipe_Type;
26235
26236    /**
26237     * @typedef Elm_Transit
26238     *
26239     * The Transit created with elm_transit_add(). This type has the information
26240     * about the objects which the transition will be applied, and the
26241     * transition effects that will be used. It also contains info about
26242     * duration, number of repetitions, auto-reverse, etc.
26243     */
26244    typedef struct _Elm_Transit Elm_Transit;
26245    typedef void Elm_Transit_Effect;
26246    /**
26247     * @typedef Elm_Transit_Effect_Transition_Cb
26248     *
26249     * Transition callback called for this effect on each transition iteration.
26250     */
26251    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26252    /**
26253     * Elm_Transit_Effect_End_Cb
26254     *
26255     * Transition callback called for this effect when the transition is over.
26256     */
26257    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26258
26259    /**
26260     * Elm_Transit_Del_Cb
26261     *
26262     * A callback called when the transit is deleted.
26263     */
26264    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26265
26266    /**
26267     * Add new transit.
26268     *
26269     * @note Is not necessary to delete the transit object, it will be deleted at
26270     * the end of its operation.
26271     * @note The transit will start playing when the program enter in the main loop, is not
26272     * necessary to give a start to the transit.
26273     *
26274     * @return The transit object.
26275     *
26276     * @ingroup Transit
26277     */
26278    EAPI Elm_Transit                *elm_transit_add(void);
26279
26280    /**
26281     * Stops the animation and delete the @p transit object.
26282     *
26283     * Call this function if you wants to stop the animation before the duration
26284     * time. Make sure the @p transit object is still alive with
26285     * elm_transit_del_cb_set() function.
26286     * All added effects will be deleted, calling its repective data_free_cb
26287     * functions. The function setted by elm_transit_del_cb_set() will be called.
26288     *
26289     * @see elm_transit_del_cb_set()
26290     *
26291     * @param transit The transit object to be deleted.
26292     *
26293     * @ingroup Transit
26294     * @warning Just call this function if you are sure the transit is alive.
26295     */
26296    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26297
26298    /**
26299     * Add a new effect to the transit.
26300     *
26301     * @note The cb function and the data are the key to the effect. If you try to
26302     * add an already added effect, nothing is done.
26303     * @note After the first addition of an effect in @p transit, if its
26304     * effect list become empty again, the @p transit will be killed by
26305     * elm_transit_del(transit) function.
26306     *
26307     * Exemple:
26308     * @code
26309     * Elm_Transit *transit = elm_transit_add();
26310     * elm_transit_effect_add(transit,
26311     *                        elm_transit_effect_blend_op,
26312     *                        elm_transit_effect_blend_context_new(),
26313     *                        elm_transit_effect_blend_context_free);
26314     * @endcode
26315     *
26316     * @param transit The transit object.
26317     * @param transition_cb The operation function. It is called when the
26318     * animation begins, it is the function that actually performs the animation.
26319     * It is called with the @p data, @p transit and the time progression of the
26320     * animation (a double value between 0.0 and 1.0).
26321     * @param effect The context data of the effect.
26322     * @param end_cb The function to free the context data, it will be called
26323     * at the end of the effect, it must finalize the animation and free the
26324     * @p data.
26325     *
26326     * @ingroup Transit
26327     * @warning The transit free the context data at the and of the transition with
26328     * the data_free_cb function, do not use the context data in another transit.
26329     */
26330    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);
26331
26332    /**
26333     * Delete an added effect.
26334     *
26335     * This function will remove the effect from the @p transit, calling the
26336     * data_free_cb to free the @p data.
26337     *
26338     * @see elm_transit_effect_add()
26339     *
26340     * @note If the effect is not found, nothing is done.
26341     * @note If the effect list become empty, this function will call
26342     * elm_transit_del(transit), that is, it will kill the @p transit.
26343     *
26344     * @param transit The transit object.
26345     * @param transition_cb The operation function.
26346     * @param effect The context data of the effect.
26347     *
26348     * @ingroup Transit
26349     */
26350    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);
26351
26352    /**
26353     * Add new object to apply the effects.
26354     *
26355     * @note After the first addition of an object in @p transit, if its
26356     * object list become empty again, the @p transit will be killed by
26357     * elm_transit_del(transit) function.
26358     * @note If the @p obj belongs to another transit, the @p obj will be
26359     * removed from it and it will only belong to the @p transit. If the old
26360     * transit stays without objects, it will die.
26361     * @note When you add an object into the @p transit, its state from
26362     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26363     * transit ends, if you change this state whith evas_object_pass_events_set()
26364     * after add the object, this state will change again when @p transit stops to
26365     * run.
26366     *
26367     * @param transit The transit object.
26368     * @param obj Object to be animated.
26369     *
26370     * @ingroup Transit
26371     * @warning It is not allowed to add a new object after transit begins to go.
26372     */
26373    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26374
26375    /**
26376     * Removes an added object from the transit.
26377     *
26378     * @note If the @p obj is not in the @p transit, nothing is done.
26379     * @note If the list become empty, this function will call
26380     * elm_transit_del(transit), that is, it will kill the @p transit.
26381     *
26382     * @param transit The transit object.
26383     * @param obj Object to be removed from @p transit.
26384     *
26385     * @ingroup Transit
26386     * @warning It is not allowed to remove objects after transit begins to go.
26387     */
26388    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26389
26390    /**
26391     * Get the objects of the transit.
26392     *
26393     * @param transit The transit object.
26394     * @return a Eina_List with the objects from the transit.
26395     *
26396     * @ingroup Transit
26397     */
26398    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26399
26400    /**
26401     * Enable/disable keeping up the objects states.
26402     * If it is not kept, the objects states will be reset when transition ends.
26403     *
26404     * @note @p transit can not be NULL.
26405     * @note One state includes geometry, color, map data.
26406     *
26407     * @param transit The transit object.
26408     * @param state_keep Keeping or Non Keeping.
26409     *
26410     * @ingroup Transit
26411     */
26412    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26413
26414    /**
26415     * Get a value whether the objects states will be reset or not.
26416     *
26417     * @note @p transit can not be NULL
26418     *
26419     * @see elm_transit_objects_final_state_keep_set()
26420     *
26421     * @param transit The transit object.
26422     * @return EINA_TRUE means the states of the objects will be reset.
26423     * If @p transit is NULL, EINA_FALSE is returned
26424     *
26425     * @ingroup Transit
26426     */
26427    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26428
26429    /**
26430     * Set the event enabled when transit is operating.
26431     *
26432     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26433     * events from mouse and keyboard during the animation.
26434     * @note When you add an object with elm_transit_object_add(), its state from
26435     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26436     * transit ends, if you change this state with evas_object_pass_events_set()
26437     * after adding the object, this state will change again when @p transit stops
26438     * to run.
26439     *
26440     * @param transit The transit object.
26441     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26442     * ignored otherwise.
26443     *
26444     * @ingroup Transit
26445     */
26446    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26447
26448    /**
26449     * Get the value of event enabled status.
26450     *
26451     * @see elm_transit_event_enabled_set()
26452     *
26453     * @param transit The Transit object
26454     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26455     * EINA_FALSE is returned
26456     *
26457     * @ingroup Transit
26458     */
26459    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26460
26461    /**
26462     * Set the user-callback function when the transit is deleted.
26463     *
26464     * @note Using this function twice will overwrite the first function setted.
26465     * @note the @p transit object will be deleted after call @p cb function.
26466     *
26467     * @param transit The transit object.
26468     * @param cb Callback function pointer. This function will be called before
26469     * the deletion of the transit.
26470     * @param data Callback funtion user data. It is the @p op parameter.
26471     *
26472     * @ingroup Transit
26473     */
26474    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26475
26476    /**
26477     * Set reverse effect automatically.
26478     *
26479     * If auto reverse is setted, after running the effects with the progress
26480     * parameter from 0 to 1, it will call the effecs again with the progress
26481     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26482     * where the duration was setted with the function elm_transit_add and
26483     * the repeat with the function elm_transit_repeat_times_set().
26484     *
26485     * @param transit The transit object.
26486     * @param reverse EINA_TRUE means the auto_reverse is on.
26487     *
26488     * @ingroup Transit
26489     */
26490    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26491
26492    /**
26493     * Get if the auto reverse is on.
26494     *
26495     * @see elm_transit_auto_reverse_set()
26496     *
26497     * @param transit The transit object.
26498     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26499     * EINA_FALSE is returned
26500     *
26501     * @ingroup Transit
26502     */
26503    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26504
26505    /**
26506     * Set the transit repeat count. Effect will be repeated by repeat count.
26507     *
26508     * This function sets the number of repetition the transit will run after
26509     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26510     * If the @p repeat is a negative number, it will repeat infinite times.
26511     *
26512     * @note If this function is called during the transit execution, the transit
26513     * will run @p repeat times, ignoring the times it already performed.
26514     *
26515     * @param transit The transit object
26516     * @param repeat Repeat count
26517     *
26518     * @ingroup Transit
26519     */
26520    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26521
26522    /**
26523     * Get the transit repeat count.
26524     *
26525     * @see elm_transit_repeat_times_set()
26526     *
26527     * @param transit The Transit object.
26528     * @return The repeat count. If @p transit is NULL
26529     * 0 is returned
26530     *
26531     * @ingroup Transit
26532     */
26533    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26534
26535    /**
26536     * Set the transit animation acceleration type.
26537     *
26538     * This function sets the tween mode of the transit that can be:
26539     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26540     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26541     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26542     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26543     *
26544     * @param transit The transit object.
26545     * @param tween_mode The tween type.
26546     *
26547     * @ingroup Transit
26548     */
26549    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26550
26551    /**
26552     * Get the transit animation acceleration type.
26553     *
26554     * @note @p transit can not be NULL
26555     *
26556     * @param transit The transit object.
26557     * @return The tween type. If @p transit is NULL
26558     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26559     *
26560     * @ingroup Transit
26561     */
26562    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26563
26564    /**
26565     * Set the transit animation time
26566     *
26567     * @note @p transit can not be NULL
26568     *
26569     * @param transit The transit object.
26570     * @param duration The animation time.
26571     *
26572     * @ingroup Transit
26573     */
26574    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26575
26576    /**
26577     * Get the transit animation time
26578     *
26579     * @note @p transit can not be NULL
26580     *
26581     * @param transit The transit object.
26582     *
26583     * @return The transit animation time.
26584     *
26585     * @ingroup Transit
26586     */
26587    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26588
26589    /**
26590     * Starts the transition.
26591     * Once this API is called, the transit begins to measure the time.
26592     *
26593     * @note @p transit can not be NULL
26594     *
26595     * @param transit The transit object.
26596     *
26597     * @ingroup Transit
26598     */
26599    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26600
26601    /**
26602     * Pause/Resume the transition.
26603     *
26604     * If you call elm_transit_go again, the transit will be started from the
26605     * beginning, and will be unpaused.
26606     *
26607     * @note @p transit can not be NULL
26608     *
26609     * @param transit The transit object.
26610     * @param paused Whether the transition should be paused or not.
26611     *
26612     * @ingroup Transit
26613     */
26614    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26615
26616    /**
26617     * Get the value of paused status.
26618     *
26619     * @see elm_transit_paused_set()
26620     *
26621     * @note @p transit can not be NULL
26622     *
26623     * @param transit The transit object.
26624     * @return EINA_TRUE means transition is paused. If @p transit is NULL
26625     * EINA_FALSE is returned
26626     *
26627     * @ingroup Transit
26628     */
26629    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26630
26631    /**
26632     * Get the time progression of the animation (a double value between 0.0 and 1.0).
26633     *
26634     * The value returned is a fraction (current time / total time). It
26635     * represents the progression position relative to the total.
26636     *
26637     * @note @p transit can not be NULL
26638     *
26639     * @param transit The transit object.
26640     *
26641     * @return The time progression value. If @p transit is NULL
26642     * 0 is returned
26643     *
26644     * @ingroup Transit
26645     */
26646    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26647
26648    /**
26649     * Makes the chain relationship between two transits.
26650     *
26651     * @note @p transit can not be NULL. Transit would have multiple chain transits.
26652     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26653     *
26654     * @param transit The transit object.
26655     * @param chain_transit The chain transit object. This transit will be operated
26656     *        after transit is done.
26657     *
26658     * This function adds @p chain_transit transition to a chain after the @p
26659     * transit, and will be started as soon as @p transit ends. See @ref
26660     * transit_example_02_explained for a full example.
26661     *
26662     * @ingroup Transit
26663     */
26664    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26665
26666    /**
26667     * Cut off the chain relationship between two transits.
26668     *
26669     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26670     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26671     *
26672     * @param transit The transit object.
26673     * @param chain_transit The chain transit object.
26674     *
26675     * This function remove the @p chain_transit transition from the @p transit.
26676     *
26677     * @ingroup Transit
26678     */
26679    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26680
26681    /**
26682     * Get the current chain transit list.
26683     *
26684     * @note @p transit can not be NULL.
26685     *
26686     * @param transit The transit object.
26687     * @return chain transit list.
26688     *
26689     * @ingroup Transit
26690     */
26691    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
26692
26693    /**
26694     * Add the Resizing Effect to Elm_Transit.
26695     *
26696     * @note This API is one of the facades. It creates resizing effect context
26697     * and add it's required APIs to elm_transit_effect_add.
26698     *
26699     * @see elm_transit_effect_add()
26700     *
26701     * @param transit Transit object.
26702     * @param from_w Object width size when effect begins.
26703     * @param from_h Object height size when effect begins.
26704     * @param to_w Object width size when effect ends.
26705     * @param to_h Object height size when effect ends.
26706     * @return Resizing effect context data.
26707     *
26708     * @ingroup Transit
26709     */
26710    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);
26711
26712    /**
26713     * Add the Translation Effect to Elm_Transit.
26714     *
26715     * @note This API is one of the facades. It creates translation effect context
26716     * and add it's required APIs to elm_transit_effect_add.
26717     *
26718     * @see elm_transit_effect_add()
26719     *
26720     * @param transit Transit object.
26721     * @param from_dx X Position variation when effect begins.
26722     * @param from_dy Y Position variation when effect begins.
26723     * @param to_dx X Position variation when effect ends.
26724     * @param to_dy Y Position variation when effect ends.
26725     * @return Translation effect context data.
26726     *
26727     * @ingroup Transit
26728     * @warning It is highly recommended just create a transit with this effect when
26729     * the window that the objects of the transit belongs has already been created.
26730     * This is because this effect needs the geometry information about the objects,
26731     * and if the window was not created yet, it can get a wrong information.
26732     */
26733    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);
26734
26735    /**
26736     * Add the Zoom Effect to Elm_Transit.
26737     *
26738     * @note This API is one of the facades. It creates zoom effect context
26739     * and add it's required APIs to elm_transit_effect_add.
26740     *
26741     * @see elm_transit_effect_add()
26742     *
26743     * @param transit Transit object.
26744     * @param from_rate Scale rate when effect begins (1 is current rate).
26745     * @param to_rate Scale rate when effect ends.
26746     * @return Zoom effect context data.
26747     *
26748     * @ingroup Transit
26749     * @warning It is highly recommended just create a transit with this effect when
26750     * the window that the objects of the transit belongs has already been created.
26751     * This is because this effect needs the geometry information about the objects,
26752     * and if the window was not created yet, it can get a wrong information.
26753     */
26754    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
26755
26756    /**
26757     * Add the Flip Effect to Elm_Transit.
26758     *
26759     * @note This API is one of the facades. It creates flip effect context
26760     * and add it's required APIs to elm_transit_effect_add.
26761     * @note This effect is applied to each pair of objects in the order they are listed
26762     * in the transit list of objects. The first object in the pair will be the
26763     * "front" object and the second will be the "back" object.
26764     *
26765     * @see elm_transit_effect_add()
26766     *
26767     * @param transit Transit object.
26768     * @param axis Flipping Axis(X or Y).
26769     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26770     * @return Flip effect context data.
26771     *
26772     * @ingroup Transit
26773     * @warning It is highly recommended just create a transit with this effect when
26774     * the window that the objects of the transit belongs has already been created.
26775     * This is because this effect needs the geometry information about the objects,
26776     * and if the window was not created yet, it can get a wrong information.
26777     */
26778    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26779
26780    /**
26781     * Add the Resizable Flip Effect to Elm_Transit.
26782     *
26783     * @note This API is one of the facades. It creates resizable flip effect context
26784     * and add it's required APIs to elm_transit_effect_add.
26785     * @note This effect is applied to each pair of objects in the order they are listed
26786     * in the transit list of objects. The first object in the pair will be the
26787     * "front" object and the second will be the "back" object.
26788     *
26789     * @see elm_transit_effect_add()
26790     *
26791     * @param transit Transit object.
26792     * @param axis Flipping Axis(X or Y).
26793     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26794     * @return Resizable flip effect context data.
26795     *
26796     * @ingroup Transit
26797     * @warning It is highly recommended just create a transit with this effect when
26798     * the window that the objects of the transit belongs has already been created.
26799     * This is because this effect needs the geometry information about the objects,
26800     * and if the window was not created yet, it can get a wrong information.
26801     */
26802    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26803
26804    /**
26805     * Add the Wipe Effect to Elm_Transit.
26806     *
26807     * @note This API is one of the facades. It creates wipe effect context
26808     * and add it's required APIs to elm_transit_effect_add.
26809     *
26810     * @see elm_transit_effect_add()
26811     *
26812     * @param transit Transit object.
26813     * @param type Wipe type. Hide or show.
26814     * @param dir Wipe Direction.
26815     * @return Wipe effect context data.
26816     *
26817     * @ingroup Transit
26818     * @warning It is highly recommended just create a transit with this effect when
26819     * the window that the objects of the transit belongs has already been created.
26820     * This is because this effect needs the geometry information about the objects,
26821     * and if the window was not created yet, it can get a wrong information.
26822     */
26823    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
26824
26825    /**
26826     * Add the Color Effect to Elm_Transit.
26827     *
26828     * @note This API is one of the facades. It creates color effect context
26829     * and add it's required APIs to elm_transit_effect_add.
26830     *
26831     * @see elm_transit_effect_add()
26832     *
26833     * @param transit        Transit object.
26834     * @param  from_r        RGB R when effect begins.
26835     * @param  from_g        RGB G when effect begins.
26836     * @param  from_b        RGB B when effect begins.
26837     * @param  from_a        RGB A when effect begins.
26838     * @param  to_r          RGB R when effect ends.
26839     * @param  to_g          RGB G when effect ends.
26840     * @param  to_b          RGB B when effect ends.
26841     * @param  to_a          RGB A when effect ends.
26842     * @return               Color effect context data.
26843     *
26844     * @ingroup Transit
26845     */
26846    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);
26847
26848    /**
26849     * Add the Fade Effect to Elm_Transit.
26850     *
26851     * @note This API is one of the facades. It creates fade effect context
26852     * and add it's required APIs to elm_transit_effect_add.
26853     * @note This effect is applied to each pair of objects in the order they are listed
26854     * in the transit list of objects. The first object in the pair will be the
26855     * "before" object and the second will be the "after" object.
26856     *
26857     * @see elm_transit_effect_add()
26858     *
26859     * @param transit Transit object.
26860     * @return Fade effect context data.
26861     *
26862     * @ingroup Transit
26863     * @warning It is highly recommended just create a transit with this effect when
26864     * the window that the objects of the transit belongs has already been created.
26865     * This is because this effect needs the color information about the objects,
26866     * and if the window was not created yet, it can get a wrong information.
26867     */
26868    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
26869
26870    /**
26871     * Add the Blend Effect to Elm_Transit.
26872     *
26873     * @note This API is one of the facades. It creates blend effect context
26874     * and add it's required APIs to elm_transit_effect_add.
26875     * @note This effect is applied to each pair of objects in the order they are listed
26876     * in the transit list of objects. The first object in the pair will be the
26877     * "before" object and the second will be the "after" object.
26878     *
26879     * @see elm_transit_effect_add()
26880     *
26881     * @param transit Transit object.
26882     * @return Blend effect context data.
26883     *
26884     * @ingroup Transit
26885     * @warning It is highly recommended just create a transit with this effect when
26886     * the window that the objects of the transit belongs has already been created.
26887     * This is because this effect needs the color information about the objects,
26888     * and if the window was not created yet, it can get a wrong information.
26889     */
26890    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
26891
26892    /**
26893     * Add the Rotation Effect to Elm_Transit.
26894     *
26895     * @note This API is one of the facades. It creates rotation effect context
26896     * and add it's required APIs to elm_transit_effect_add.
26897     *
26898     * @see elm_transit_effect_add()
26899     *
26900     * @param transit Transit object.
26901     * @param from_degree Degree when effect begins.
26902     * @param to_degree Degree when effect is ends.
26903     * @return Rotation effect context data.
26904     *
26905     * @ingroup Transit
26906     * @warning It is highly recommended just create a transit with this effect when
26907     * the window that the objects of the transit belongs has already been created.
26908     * This is because this effect needs the geometry information about the objects,
26909     * and if the window was not created yet, it can get a wrong information.
26910     */
26911    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26912
26913    /**
26914     * Add the ImageAnimation Effect to Elm_Transit.
26915     *
26916     * @note This API is one of the facades. It creates image animation effect context
26917     * and add it's required APIs to elm_transit_effect_add.
26918     * The @p images parameter is a list images paths. This list and
26919     * its contents will be deleted at the end of the effect by
26920     * elm_transit_effect_image_animation_context_free() function.
26921     *
26922     * Example:
26923     * @code
26924     * char buf[PATH_MAX];
26925     * Eina_List *images = NULL;
26926     * Elm_Transit *transi = elm_transit_add();
26927     *
26928     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26929     * images = eina_list_append(images, eina_stringshare_add(buf));
26930     *
26931     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26932     * images = eina_list_append(images, eina_stringshare_add(buf));
26933     * elm_transit_effect_image_animation_add(transi, images);
26934     *
26935     * @endcode
26936     *
26937     * @see elm_transit_effect_add()
26938     *
26939     * @param transit Transit object.
26940     * @param images Eina_List of images file paths. This list and
26941     * its contents will be deleted at the end of the effect by
26942     * elm_transit_effect_image_animation_context_free() function.
26943     * @return Image Animation effect context data.
26944     *
26945     * @ingroup Transit
26946     */
26947    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26948    /**
26949     * @}
26950     */
26951
26952   typedef struct _Elm_Store                      Elm_Store;
26953   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
26954   typedef struct _Elm_Store_Item                 Elm_Store_Item;
26955   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
26956   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
26957   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26958   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
26959   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
26960   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
26961   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
26962   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
26963
26964   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26965   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26966   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26967   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26968
26969   typedef enum
26970     {
26971        ELM_STORE_ITEM_MAPPING_NONE = 0,
26972        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26973        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26974        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26975        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26976        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26977        // can add more here as needed by common apps
26978        ELM_STORE_ITEM_MAPPING_LAST
26979     } Elm_Store_Item_Mapping_Type;
26980
26981   struct _Elm_Store_Item_Mapping_Icon
26982     {
26983        // FIXME: allow edje file icons
26984        int                   w, h;
26985        Elm_Icon_Lookup_Order lookup_order;
26986        Eina_Bool             standard_name : 1;
26987        Eina_Bool             no_scale : 1;
26988        Eina_Bool             smooth : 1;
26989        Eina_Bool             scale_up : 1;
26990        Eina_Bool             scale_down : 1;
26991     };
26992
26993   struct _Elm_Store_Item_Mapping_Empty
26994     {
26995        Eina_Bool             dummy;
26996     };
26997
26998   struct _Elm_Store_Item_Mapping_Photo
26999     {
27000        int                   size;
27001     };
27002
27003   struct _Elm_Store_Item_Mapping_Custom
27004     {
27005        Elm_Store_Item_Mapping_Cb func;
27006     };
27007
27008   struct _Elm_Store_Item_Mapping
27009     {
27010        Elm_Store_Item_Mapping_Type     type;
27011        const char                     *part;
27012        int                             offset;
27013        union
27014          {
27015             Elm_Store_Item_Mapping_Empty  empty;
27016             Elm_Store_Item_Mapping_Icon   icon;
27017             Elm_Store_Item_Mapping_Photo  photo;
27018             Elm_Store_Item_Mapping_Custom custom;
27019             // add more types here
27020          } details;
27021     };
27022
27023   struct _Elm_Store_Item_Info
27024     {
27025       Elm_Genlist_Item_Class       *item_class;
27026       const Elm_Store_Item_Mapping *mapping;
27027       void                         *data;
27028       char                         *sort_id;
27029     };
27030
27031   struct _Elm_Store_Item_Info_Filesystem
27032     {
27033       Elm_Store_Item_Info  base;
27034       char                *path;
27035     };
27036
27037 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27038 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27039
27040   EAPI void                    elm_store_free(Elm_Store *st);
27041
27042   EAPI Elm_Store              *elm_store_filesystem_new(void);
27043   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27044   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27045   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27046
27047   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27048
27049   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27050   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27051   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27052   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27053   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27054   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27055
27056   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27057   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27058   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27059   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27060   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27061   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27062   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27063
27064    /**
27065     * @defgroup SegmentControl SegmentControl
27066     * @ingroup Elementary
27067     *
27068     * @image html img/widget/segment_control/preview-00.png
27069     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27070     *
27071     * @image html img/segment_control.png
27072     * @image latex img/segment_control.eps width=\textwidth
27073     *
27074     * Segment control widget is a horizontal control made of multiple segment
27075     * items, each segment item functioning similar to discrete two state button.
27076     * A segment control groups the items together and provides compact
27077     * single button with multiple equal size segments.
27078     *
27079     * Segment item size is determined by base widget
27080     * size and the number of items added.
27081     * Only one segment item can be at selected state. A segment item can display
27082     * combination of Text and any Evas_Object like Images or other widget.
27083     *
27084     * Smart callbacks one can listen to:
27085     * - "changed" - When the user clicks on a segment item which is not
27086     *   previously selected and get selected. The event_info parameter is the
27087     *   segment item index.
27088     *
27089     * Available styles for it:
27090     * - @c "default"
27091     *
27092     * Here is an example on its usage:
27093     * @li @ref segment_control_example
27094     */
27095
27096    /**
27097     * @addtogroup SegmentControl
27098     * @{
27099     */
27100
27101    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27102
27103    /**
27104     * Add a new segment control widget to the given parent Elementary
27105     * (container) object.
27106     *
27107     * @param parent The parent object.
27108     * @return a new segment control widget handle or @c NULL, on errors.
27109     *
27110     * This function inserts a new segment control widget on the canvas.
27111     *
27112     * @ingroup SegmentControl
27113     */
27114    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27115
27116    /**
27117     * Append a new item to the segment control object.
27118     *
27119     * @param obj The segment control object.
27120     * @param icon The icon object to use for the left side of the item. An
27121     * icon can be any Evas object, but usually it is an icon created
27122     * with elm_icon_add().
27123     * @param label The label of the item.
27124     *        Note that, NULL is different from empty string "".
27125     * @return The created item or @c NULL upon failure.
27126     *
27127     * A new item will be created and appended to the segment control, i.e., will
27128     * be set as @b last item.
27129     *
27130     * If it should be inserted at another position,
27131     * elm_segment_control_item_insert_at() should be used instead.
27132     *
27133     * Items created with this function can be deleted with function
27134     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27135     *
27136     * @note @p label set to @c NULL is different from empty string "".
27137     * If an item
27138     * only has icon, it will be displayed bigger and centered. If it has
27139     * icon and label, even that an empty string, icon will be smaller and
27140     * positioned at left.
27141     *
27142     * Simple example:
27143     * @code
27144     * sc = elm_segment_control_add(win);
27145     * ic = elm_icon_add(win);
27146     * elm_icon_file_set(ic, "path/to/image", NULL);
27147     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27148     * elm_segment_control_item_add(sc, ic, "label");
27149     * evas_object_show(sc);
27150     * @endcode
27151     *
27152     * @see elm_segment_control_item_insert_at()
27153     * @see elm_segment_control_item_del()
27154     *
27155     * @ingroup SegmentControl
27156     */
27157    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27158
27159    /**
27160     * Insert a new item to the segment control object at specified position.
27161     *
27162     * @param obj The segment control object.
27163     * @param icon The icon object to use for the left side of the item. An
27164     * icon can be any Evas object, but usually it is an icon created
27165     * with elm_icon_add().
27166     * @param label The label of the item.
27167     * @param index Item position. Value should be between 0 and items count.
27168     * @return The created item or @c NULL upon failure.
27169
27170     * Index values must be between @c 0, when item will be prepended to
27171     * segment control, and items count, that can be get with
27172     * elm_segment_control_item_count_get(), case when item will be appended
27173     * to segment control, just like elm_segment_control_item_add().
27174     *
27175     * Items created with this function can be deleted with function
27176     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27177     *
27178     * @note @p label set to @c NULL is different from empty string "".
27179     * If an item
27180     * only has icon, it will be displayed bigger and centered. If it has
27181     * icon and label, even that an empty string, icon will be smaller and
27182     * positioned at left.
27183     *
27184     * @see elm_segment_control_item_add()
27185     * @see elm_segment_control_item_count_get()
27186     * @see elm_segment_control_item_del()
27187     *
27188     * @ingroup SegmentControl
27189     */
27190    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);
27191
27192    /**
27193     * Remove a segment control item from its parent, deleting it.
27194     *
27195     * @param it The item to be removed.
27196     *
27197     * Items can be added with elm_segment_control_item_add() or
27198     * elm_segment_control_item_insert_at().
27199     *
27200     * @ingroup SegmentControl
27201     */
27202    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27203
27204    /**
27205     * Remove a segment control item at given index from its parent,
27206     * deleting it.
27207     *
27208     * @param obj The segment control object.
27209     * @param index The position of the segment control item to be deleted.
27210     *
27211     * Items can be added with elm_segment_control_item_add() or
27212     * elm_segment_control_item_insert_at().
27213     *
27214     * @ingroup SegmentControl
27215     */
27216    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27217
27218    /**
27219     * Get the Segment items count from segment control.
27220     *
27221     * @param obj The segment control object.
27222     * @return Segment items count.
27223     *
27224     * It will just return the number of items added to segment control @p obj.
27225     *
27226     * @ingroup SegmentControl
27227     */
27228    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27229
27230    /**
27231     * Get the item placed at specified index.
27232     *
27233     * @param obj The segment control object.
27234     * @param index The index of the segment item.
27235     * @return The segment control item or @c NULL on failure.
27236     *
27237     * Index is the position of an item in segment control widget. Its
27238     * range is from @c 0 to <tt> count - 1 </tt>.
27239     * Count is the number of items, that can be get with
27240     * elm_segment_control_item_count_get().
27241     *
27242     * @ingroup SegmentControl
27243     */
27244    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27245
27246    /**
27247     * Get the label of item.
27248     *
27249     * @param obj The segment control object.
27250     * @param index The index of the segment item.
27251     * @return The label of the item at @p index.
27252     *
27253     * The return value is a pointer to the label associated to the item when
27254     * it was created, with function elm_segment_control_item_add(), or later
27255     * with function elm_segment_control_item_label_set. If no label
27256     * was passed as argument, it will return @c NULL.
27257     *
27258     * @see elm_segment_control_item_label_set() for more details.
27259     * @see elm_segment_control_item_add()
27260     *
27261     * @ingroup SegmentControl
27262     */
27263    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27264
27265    /**
27266     * Set the label of item.
27267     *
27268     * @param it The item of segment control.
27269     * @param text The label of item.
27270     *
27271     * The label to be displayed by the item.
27272     * Label will be at right of the icon (if set).
27273     *
27274     * If a label was passed as argument on item creation, with function
27275     * elm_control_segment_item_add(), it will be already
27276     * displayed by the item.
27277     *
27278     * @see elm_segment_control_item_label_get()
27279     * @see elm_segment_control_item_add()
27280     *
27281     * @ingroup SegmentControl
27282     */
27283    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27284
27285    /**
27286     * Get the icon associated to the item.
27287     *
27288     * @param obj The segment control object.
27289     * @param index The index of the segment item.
27290     * @return The left side icon associated to the item at @p index.
27291     *
27292     * The return value is a pointer to the icon associated to the item when
27293     * it was created, with function elm_segment_control_item_add(), or later
27294     * with function elm_segment_control_item_icon_set(). If no icon
27295     * was passed as argument, it will return @c NULL.
27296     *
27297     * @see elm_segment_control_item_add()
27298     * @see elm_segment_control_item_icon_set()
27299     *
27300     * @ingroup SegmentControl
27301     */
27302    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27303
27304    /**
27305     * Set the icon associated to the item.
27306     *
27307     * @param it The segment control item.
27308     * @param icon The icon object to associate with @p it.
27309     *
27310     * The icon object to use at left side of the item. An
27311     * icon can be any Evas object, but usually it is an icon created
27312     * with elm_icon_add().
27313     *
27314     * Once the icon object is set, a previously set one will be deleted.
27315     * @warning Setting the same icon for two items will cause the icon to
27316     * dissapear from the first item.
27317     *
27318     * If an icon was passed as argument on item creation, with function
27319     * elm_segment_control_item_add(), it will be already
27320     * associated to the item.
27321     *
27322     * @see elm_segment_control_item_add()
27323     * @see elm_segment_control_item_icon_get()
27324     *
27325     * @ingroup SegmentControl
27326     */
27327    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27328
27329    /**
27330     * Get the index of an item.
27331     *
27332     * @param it The segment control item.
27333     * @return The position of item in segment control widget.
27334     *
27335     * Index is the position of an item in segment control widget. Its
27336     * range is from @c 0 to <tt> count - 1 </tt>.
27337     * Count is the number of items, that can be get with
27338     * elm_segment_control_item_count_get().
27339     *
27340     * @ingroup SegmentControl
27341     */
27342    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27343
27344    /**
27345     * Get the base object of the item.
27346     *
27347     * @param it The segment control item.
27348     * @return The base object associated with @p it.
27349     *
27350     * Base object is the @c Evas_Object that represents that item.
27351     *
27352     * @ingroup SegmentControl
27353     */
27354    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27355
27356    /**
27357     * Get the selected item.
27358     *
27359     * @param obj The segment control object.
27360     * @return The selected item or @c NULL if none of segment items is
27361     * selected.
27362     *
27363     * The selected item can be unselected with function
27364     * elm_segment_control_item_selected_set().
27365     *
27366     * The selected item always will be highlighted on segment control.
27367     *
27368     * @ingroup SegmentControl
27369     */
27370    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27371
27372    /**
27373     * Set the selected state of an item.
27374     *
27375     * @param it The segment control item
27376     * @param select The selected state
27377     *
27378     * This sets the selected state of the given item @p it.
27379     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27380     *
27381     * If a new item is selected the previosly selected will be unselected.
27382     * Previoulsy selected item can be get with function
27383     * elm_segment_control_item_selected_get().
27384     *
27385     * The selected item always will be highlighted on segment control.
27386     *
27387     * @see elm_segment_control_item_selected_get()
27388     *
27389     * @ingroup SegmentControl
27390     */
27391    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27392
27393    /**
27394     * @}
27395     */
27396
27397    /**
27398     * @defgroup Grid Grid
27399     *
27400     * The grid is a grid layout widget that lays out a series of children as a
27401     * fixed "grid" of widgets using a given percentage of the grid width and
27402     * height each using the child object.
27403     *
27404     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27405     * widgets size itself. The default is 100 x 100, so that means the
27406     * position and sizes of children will effectively be percentages (0 to 100)
27407     * of the width or height of the grid widget
27408     *
27409     * @{
27410     */
27411
27412    /**
27413     * Add a new grid to the parent
27414     *
27415     * @param parent The parent object
27416     * @return The new object or NULL if it cannot be created
27417     *
27418     * @ingroup Grid
27419     */
27420    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27421
27422    /**
27423     * Set the virtual size of the grid
27424     *
27425     * @param obj The grid object
27426     * @param w The virtual width of the grid
27427     * @param h The virtual height of the grid
27428     *
27429     * @ingroup Grid
27430     */
27431    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27432
27433    /**
27434     * Get the virtual size of the grid
27435     *
27436     * @param obj The grid object
27437     * @param w Pointer to integer to store the virtual width of the grid
27438     * @param h Pointer to integer to store the virtual height of the grid
27439     *
27440     * @ingroup Grid
27441     */
27442    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27443
27444    /**
27445     * Pack child at given position and size
27446     *
27447     * @param obj The grid object
27448     * @param subobj The child to pack
27449     * @param x The virtual x coord at which to pack it
27450     * @param y The virtual y coord at which to pack it
27451     * @param w The virtual width at which to pack it
27452     * @param h The virtual height at which to pack it
27453     *
27454     * @ingroup Grid
27455     */
27456    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27457
27458    /**
27459     * Unpack a child from a grid object
27460     *
27461     * @param obj The grid object
27462     * @param subobj The child to unpack
27463     *
27464     * @ingroup Grid
27465     */
27466    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27467
27468    /**
27469     * Faster way to remove all child objects from a grid object.
27470     *
27471     * @param obj The grid object
27472     * @param clear If true, it will delete just removed children
27473     *
27474     * @ingroup Grid
27475     */
27476    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27477
27478    /**
27479     * Set packing of an existing child at to position and size
27480     *
27481     * @param subobj The child to set packing of
27482     * @param x The virtual x coord at which to pack it
27483     * @param y The virtual y coord at which to pack it
27484     * @param w The virtual width at which to pack it
27485     * @param h The virtual height at which to pack it
27486     *
27487     * @ingroup Grid
27488     */
27489    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27490
27491    /**
27492     * get packing of a child
27493     *
27494     * @param subobj The child to query
27495     * @param x Pointer to integer to store the virtual x coord
27496     * @param y Pointer to integer to store the virtual y coord
27497     * @param w Pointer to integer to store the virtual width
27498     * @param h Pointer to integer to store the virtual height
27499     *
27500     * @ingroup Grid
27501     */
27502    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27503
27504    /**
27505     * @}
27506     */
27507
27508    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27509    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27510    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27511    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27512    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
27513    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
27514
27515    /**
27516     * @defgroup Video Video
27517     *
27518     * This object display an player that let you control an Elm_Video
27519     * object. It take care of updating it's content according to what is
27520     * going on inside the Emotion object. It does activate the remember
27521     * function on the linked Elm_Video object.
27522     *
27523     * Signals that you can add callback for are :
27524     *
27525     * "forward,clicked" - the user clicked the forward button.
27526     * "info,clicked" - the user clicked the info button.
27527     * "next,clicked" - the user clicked the next button.
27528     * "pause,clicked" - the user clicked the pause button.
27529     * "play,clicked" - the user clicked the play button.
27530     * "prev,clicked" - the user clicked the prev button.
27531     * "rewind,clicked" - the user clicked the rewind button.
27532     * "stop,clicked" - the user clicked the stop button.
27533     */
27534    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27535    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27536    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27537    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27538    EAPI void elm_video_play(Evas_Object *video);
27539    EAPI void elm_video_pause(Evas_Object *video);
27540    EAPI void elm_video_stop(Evas_Object *video);
27541    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27542    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27543    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27544    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27545    EAPI double elm_video_audio_level_get(Evas_Object *video);
27546    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27547    EAPI double elm_video_play_position_get(Evas_Object *video);
27548    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27549    EAPI double elm_video_play_length_get(Evas_Object *video);
27550    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27551    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27552    EAPI const char *elm_video_title_get(Evas_Object *video);
27553
27554    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27555    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27556
27557    /**
27558     * @defgroup Naviframe Naviframe
27559     *
27560     * @brief Naviframe is a kind of view manager for the applications.
27561     *
27562     * Naviframe provides functions to switch different pages with stack
27563     * mechanism. It means if one page(item) needs to be changed to the new one,
27564     * then naviframe would push the new page to it's internal stack. Of course,
27565     * it can be back to the previous page by popping the top page. Naviframe
27566     * provides some transition effect while the pages are switching (same as
27567     * pager).
27568     *
27569     * Since each item could keep the different styles, users could keep the
27570     * same look & feel for the pages or different styles for the items in it's
27571     * application.
27572     *
27573     * Signals that you can add callback for are:
27574     *
27575     * @li "transition,finished" - When the transition is finished in changing
27576     *     the item
27577     * @li "title,clicked" - User clicked title area
27578     *
27579     * Default contents parts for the naviframe items that you can use for are:
27580     *
27581     * @li "elm.swallow.content" - The main content of the page
27582     * @li "elm.swallow.prev_btn" - The button to go to the previous page
27583     * @li "elm.swallow.next_btn" - The button to go to the next page
27584     *
27585     * Default text parts of naviframe items that you can be used are:
27586     *
27587     * @li "elm.text.title" - The title label in the title area
27588     *
27589     * @ref tutorial_naviframe gives a good overview of the usage of the API.
27590     * @{
27591     */
27592    /**
27593     * @brief Add a new Naviframe object to the parent.
27594     *
27595     * @param parent Parent object
27596     * @return New object or @c NULL, if it cannot be created
27597     */
27598    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27599    /**
27600     * @brief Push a new item to the top of the naviframe stack (and show it).
27601     *
27602     * @param obj The naviframe object
27603     * @param title_label The label in the title area. The name of the title
27604     *        label part is "elm.text.title"
27605     * @param prev_btn The button to go to the previous item. If it is NULL,
27606     *        then naviframe will create a back button automatically. The name of
27607     *        the prev_btn part is "elm.swallow.prev_btn"
27608     * @param next_btn The button to go to the next item. Or It could be just an
27609     *        extra function button. The name of the next_btn part is
27610     *        "elm.swallow.next_btn"
27611     * @param content The main content object. The name of content part is
27612     *        "elm.swallow.content"
27613     * @param item_style The current item style name. @c NULL would be default.
27614     * @return The created item or @c NULL upon failure.
27615     *
27616     * The item pushed becomes one page of the naviframe, this item will be
27617     * deleted when it is popped.
27618     *
27619     * @see also elm_naviframe_item_style_set()
27620     *
27621     * The following styles are available for this item:
27622     * @li @c "default"
27623     */
27624    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);
27625    /**
27626     * @brief Pop an item that is on top of the stack
27627     *
27628     * @param obj The naviframe object
27629     * @return @c NULL or the content object(if the
27630     *         elm_naviframe_content_preserve_on_pop_get is true).
27631     *
27632     * This pops an item that is on the top(visible) of the naviframe, makes it
27633     * disappear, then deletes the item. The item that was underneath it on the
27634     * stack will become visible.
27635     *
27636     * @see also elm_naviframe_content_preserve_on_pop_get()
27637     */
27638    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
27639    /**
27640     * @brief Pop the items between the top and the above one on the given item.
27641     *
27642     * @param it The naviframe item
27643     */
27644    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27645    /**
27646     * @brief preserve the content objects when items are popped.
27647     *
27648     * @param obj The naviframe object
27649     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
27650     *
27651     * @see also elm_naviframe_content_preserve_on_pop_get()
27652     */
27653    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
27654    /**
27655     * @brief Get a value whether preserve mode is enabled or not.
27656     *
27657     * @param obj The naviframe object
27658     * @return If @c EINA_TRUE, preserve mode is enabled
27659     *
27660     * @see also elm_naviframe_content_preserve_on_pop_set()
27661     */
27662    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27663    /**
27664     * @brief Get a top item on the naviframe stack
27665     *
27666     * @param obj The naviframe object
27667     * @return The top item on the naviframe stack or @c NULL, if the stack is
27668     *         empty
27669     */
27670    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27671    /**
27672     * @brief Get a bottom item on the naviframe stack
27673     *
27674     * @param obj The naviframe object
27675     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
27676     *         empty
27677     */
27678    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27679    /**
27680     * @brief Set an item style
27681     *
27682     * @param obj The naviframe item
27683     * @param item_style The current item style name. @c NULL would be default
27684     *
27685     * The following styles are available for this item:
27686     * @li @c "default"
27687     *
27688     * @see also elm_naviframe_item_style_get()
27689     */
27690    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
27691    /**
27692     * @brief Get an item style
27693     *
27694     * @param obj The naviframe item
27695     * @return The current item style name
27696     *
27697     * @see also elm_naviframe_item_style_set()
27698     */
27699    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27700    /**
27701     * @brief Show/Hide the title area
27702     *
27703     * @param it The naviframe item
27704     * @param visible If @c EINA_TRUE, title area will be visible, hidden
27705     *        otherwise
27706     *
27707     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
27708     *
27709     * @see also elm_naviframe_item_title_visible_get()
27710     */
27711    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
27712    /**
27713     * @brief Get a value whether title area is visible or not.
27714     *
27715     * @param it The naviframe item
27716     * @return If @c EINA_TRUE, title area is visible
27717     *
27718     * @see also elm_naviframe_item_title_visible_set()
27719     */
27720    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27721
27722    /**
27723     * @}
27724     */
27725
27726 #ifdef __cplusplus
27727 }
27728 #endif
27729
27730 #endif